public/main/exercise/Annotation.php
The method createForm uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
if (1 == $this->isContent) {
$form->setDefaults(['weighting' => '10']);
}
}- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}Source https://phpmd.org/rules/cleancode.html#elseexpression
Avoid unused parameters such as '$form'. Open
Open
public function createAnswersForm($form)- Read upRead up
- Exclude checks
UnusedFormalParameter
Since: 0.2
Avoid passing parameters to methods or constructors and then not using those parameters.
Example
class Foo
{
private function bar($howdy)
{
// $howdy is not used
}
}Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter
Method name "Annotation::return_header" is not in camel caps format Open
Open
public function return_header(Exercise $exercise, $counter = null, $score = [])- Exclude checks
Missing function doc comment Open
Open
public function processCreation($form, $exercise)- Exclude checks
Missing function doc comment Open
Open
public function createForm(&$form, $exercise)- Exclude checks
Missing function doc comment Open
Open
public function display()- Exclude checks
Missing function doc comment Open
Open
public function processAnswersCreation($form, $exercise)- Exclude checks
Missing function doc comment Open
Open
public function return_header(Exercise $exercise, $counter = null, $score = [])- Exclude checks
The method return_header is not named in camelCase. Open
Open
public function return_header(Exercise $exercise, $counter = null, $score = [])
{
$score['revised'] = $this->isQuestionWaitingReview($score);
return parent::return_header($exercise, $counter, $score); // TODO: Change the autogenerated stub- Read upRead up
- Exclude checks
CamelCaseMethodName
Since: 0.2
It is considered best practice to use the camelCase notation to name methods.
Example
class ClassName {
public function get_name() {
}
}