public/main/exercise/oral_expression.class.php
Missing class import via use statement (line '73', column '32'). Open
Open
$recordAudioView = new Template(
- Read upRead up
- Exclude checks
MissingImport
Since: 2.7.0
Importing all external classes in a file through use statements makes them clearly visible.
Example
function make() {
return new \stdClass();
}
Source http://phpmd.org/rules/cleancode.html#MissingImport
The method createAnswersForm 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
The property $available_extensions is not named in camelCase. Open
Open
class OralExpression extends Question
{
public $typePicture = 'audio_question.png';
public $explanationLangVar = 'Oral expression';
public $available_extensions = ['wav', 'ogg'];
- Read upRead up
- Exclude checks
CamelCasePropertyName
Since: 0.2
It is considered best practice to use the camelCase notation to name attributes.
Example
class ClassName {
protected $property_name;
}
Source
Missing function doc comment Open
Open
public function __construct()
- Exclude checks
Missing function doc comment Open
Open
public function createAnswersForm($form)
- Exclude checks
Member variable "available_extensions" is not in valid camel caps format Open
Open
public $available_extensions = ['wav', 'ogg'];
- Exclude checks
Missing function doc comment Open
Open
public function processAnswersCreation($form, $exercise)
- Exclude checks
Missing function doc comment Open
Open
public static function saveAssetInQuestionAttempt($attemptId)
- Exclude checks
Missing function doc comment Open
Open
public function return_header(Exercise $exercise, $counter = null, $score = [])
- Exclude checks
Method name "OralExpression::return_header" is not in camel caps format 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);
$header = parent::return_header($exercise, $counter, $score);
$header .= '<table class="'.$this->questionTableClass.'">
- 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() {
}
}