Make Moodle codechecker happy.

Author: lucaboesch

classes/admin/question_behaviour_setting.php

@@ -29,6 +29,12 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class question_behaviour_setting extends \admin_setting_configselect {
+
+    /**
+     * Load the choices.
+     *
+     * @return true
+     */
     public function load_choices() {
         if (is_array($this->choices)) {
             return true;

classes/attempt.php

@@ -205,7 +205,7 @@ public function setup_usage_info(\question_usage_by_activity $quba, int $slot) {
      * @param \question_usage_by_activity|null $quba usage to use. If null will continue using the same usage.
      */
     public function start_new_attempt_at_question(
-            \question_usage_by_activity $quba = null) {
+            ?\question_usage_by_activity $quba = null) {
         global $DB;
 
         if ($quba) {
@@ -386,7 +386,7 @@ public function get_problem_description(): string {
      * @param array $simulatedpostdata for testing, simulated post data (e.g. from
      *      $quba->get_simulated_post_data_for_questions_in_usage()).
      */
-    public function process_submitted_actions(array $simulatedpostdata = null) {
+    public function process_submitted_actions(?array $simulatedpostdata = null) {
         global $DB;
 
         $this->quba->process_all_actions(null, $simulatedpostdata);

classes/custom_string_manager.php

@@ -42,6 +42,16 @@ public static function force_page_language($lang) {
         get_string_manager(true)->forcedlanguage = $lang;
     }
 
+    /**
+     * Get String returns a requested string
+     *
+     * @param string $identifier The identifier of the string to search for
+     * @param string $component The module the string is associated with
+     * @param string|object|array $a An object, string or number that can be used
+     *      within translation strings
+     * @param string $lang moodle translation language, null means use current
+     * @return string The String !
+     */
     public function get_string($identifier, $component = '', $a = null, $lang = null) {
         return parent::get_string($identifier, $component, $a, $lang ?? $this->forcedlanguage);
     }

classes/event/category_token_created.php

@@ -29,17 +29,30 @@
  */
 class category_token_created extends \core\event\base {
 
+    /**
+     * Init method.
+     */
     protected function init() {
         $this->data['objecttable'] = 'question_categories';
         $this->data['crud'] = 'c';
         $this->data['edulevel'] = self::LEVEL_TEACHING;
     }
 
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
     public function get_description() {
         return "The user with id '$this->userid' created a token for embedded a question " .
                 "picked at random from category '$this->objectid' in course '$this->courseid'.";
     }
 
+    /**
+     * Get objectid mapping.
+     *
+     * @return array
+     */
     public static function get_objectid_mapping() {
         return ['db' => 'question_categories', 'restore' => 'question_categories'];
     }

classes/event/question_attempted.php

@@ -29,17 +29,30 @@
  */
 class question_attempted extends \core\event\base {
 
+    /**
+     * Init method.
+     */
     protected function init() {
         $this->data['objecttable'] = 'question';
         $this->data['crud'] = 'u';
         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
     }
 
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
     public function get_description() {
         return "The user with id '$this->userid' has submitted data to the embedded question " .
                 "'$this->objectid' in course '$this->courseid'.";
     }
 
+    /**
+     * Get objectid mapping.
+     *
+     * @return array
+     */
     public static function get_objectid_mapping() {
         return ['db' => 'question', 'restore' => 'question'];
     }

classes/event/question_started.php

@@ -29,17 +29,30 @@
  */
 class question_started extends \core\event\base {
 
+    /**
+     * Init method.
+     */
     protected function init() {
         $this->data['objecttable'] = 'question';
         $this->data['crud'] = 'c';
         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
     }
 
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
     public function get_description() {
         return "The user with id '$this->userid' has started an attempt at embedded question " .
                 "'$this->objectid' in course '$this->courseid'.";
     }
 
+    /**
+     * Get objectid mapping.
+     *
+     * @return array
+     */
     public static function get_objectid_mapping() {
         return ['db' => 'question', 'restore' => 'question'];
     }

classes/event/question_viewed.php

@@ -29,17 +29,30 @@
  */
 class question_viewed extends \core\event\base {
 
+    /**
+     * Init method.
+     */
     protected function init() {
         $this->data['objecttable'] = 'question';
         $this->data['crud'] = 'r';
         $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
     }
 
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
     public function get_description() {
         return "The user with id '$this->userid' has viewed the embedded question " .
                 "'$this->objectid' in course '$this->courseid'.";
     }
 
+    /**
+     * Get objectid mapping.
+     *
+     * @return array
+     */
     public static function get_objectid_mapping() {
         return ['db' => 'question', 'restore' => 'question'];
     }

classes/event/token_created.php

@@ -29,17 +29,30 @@
  */
 class token_created extends \core\event\base {
 
+    /**
+     * Init method.
+     */
     protected function init() {
         $this->data['objecttable'] = 'question';
         $this->data['crud'] = 'c';
         $this->data['edulevel'] = self::LEVEL_TEACHING;
     }
 
+    /**
+     * Returns non-localised description of what happened.
+     *
+     * @return string
+     */
     public function get_description() {
         return "The user with id '$this->userid' created a token for embedded question " .
                 "'$this->objectid' in course '$this->courseid'.";
     }
 
+    /**
+     * Get objectid mapping.
+     *
+     * @return array
+     */
     public static function get_objectid_mapping() {
         return ['db' => 'question', 'restore' => 'question'];
     }

classes/form/embed_options_form.php

@@ -38,6 +38,10 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class embed_options_form extends \moodleform {
+
+    /**
+     * {inheritDocs}
+     */
     public function definition() {
         global $PAGE;
 
@@ -158,6 +162,9 @@ protected function get_marks_options(int $default): array {
         return ['' => get_string('defaultx', 'filter_embedquestion', $options[$default])] + $options;
     }
 
+    /**
+     * {inheritDocs}
+     */
     public function definition_after_data() {
         parent::definition_after_data();
         $mform = $this->_form;
@@ -199,6 +206,9 @@ protected function get_user_retriction(): ?int {
         }
     }
 
+    /**
+     * {inheritDocs}
+     */
     public function validation($data, $files) {
         $errors = parent::validation($data, $files);
         $context = $this->_customdata['context'];
@@ -235,6 +245,9 @@ public function validation($data, $files) {
         return $errors;
     }
 
+    /**
+     * {inheritDocs}
+     */
     public function get_data() {
         $data = parent::get_data();
 

classes/output/embed_iframe.php

@@ -44,6 +44,12 @@ public function __construct(\moodle_url $showquestionurl, string $iframedescript
         $this->iframedescription = $iframedescription;
     }
 
+    /**
+     * Export this data so it can be used as the context for a mustache template.
+     *
+     * @param renderer_base $output
+     * @return stdClass
+     */
     public function export_for_template(renderer_base $output) {
         $data = [
             'showquestionurl' => $this->showquestionurl,

classes/output/error_message.php

@@ -38,6 +38,12 @@ public function __construct(string $message) {
         $this->message = $message;
     }
 
+    /**
+     * Export this data so it can be used as the context for a mustache template.
+     *
+     * @param renderer_base $output
+     * @return stdClass
+     */
     public function export_for_template(renderer_base $output) {
         return ['message' => $this->message];
     }

classes/output/renderer.php

@@ -26,8 +26,8 @@
  * @copyright 2018 The Open University
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  *
- * @method string header() inherited from core_renderer.
- * @method string footer() inherited from core_renderer.
+ * Method string header() inherited from core_renderer.
+ * Method string footer() inherited from core_renderer.
  */
 class renderer extends \plugin_renderer_base {
     /**

classes/privacy/provider.php

@@ -31,7 +31,7 @@ class provider implements \core_privacy\local\metadata\null_provider {
      *
      * @return  string
      */
-    public static function get_reason() : string {
+    public static function get_reason(): string {
         return 'privacy:metadata';
     }
 }

classes/task/cleanup_task.php

@@ -37,10 +37,19 @@ class cleanup_task extends scheduled_task {
      */
     const MAX_AGE = 24 * 60 * 60;
 
+    /**
+     * Get a descriptive name for this task (shown to admins).
+     *
+     * @return string
+     */
     public function get_name() {
         return get_string('taskcleanup', 'filter_embedquestion');
     }
 
+    /**
+     * Do the job.
+     * Throw exceptions on errors (the job will be retried).
+     */
     public function execute() {
         $lastmodifiedcutoff = time() - self::MAX_AGE;
 

classes/text_filter.php

@@ -56,6 +56,9 @@ class text_filter extends \core_filters\text_filter {
      */
     protected $page;
 
+    /**
+     * {inheritDocs}
+     */
     public function setup($page, $context) {
         $this->page = $page;
     }
@@ -71,6 +74,9 @@ public static function get_filter_regexp(): string {
                 preg_quote(self::STRING_SUFFIX, '~') . '~';
     }
 
+    /**
+     * {inheritDocs}
+     */
     public function filter($text, array $options = []) {
         return preg_replace_callback(self::get_filter_regexp(),
                 [$this, 'embed_question_callback'], $text);
@@ -131,7 +137,7 @@ public function embed_question(string $embedcode): string {
      *
      * @return string HTML for the error.
      */
-    protected function display_error(string $string, array $a = null): string {
+    protected function display_error(string $string, ?array $a = null): string {
         return $this->renderer->render(new error_message(
                 get_string($string, 'filter_embedquestion', $a)));
     }

classes/utils.php

@@ -232,7 +232,7 @@ public static function is_latest_version(\question_definition $question): bool {
      * @param int|null $userid (optional) if set, only count questions created by this user.
      * @return array category idnumber => Category name (question count).
      */
-    public static function get_categories_with_sharable_question_choices(\context $context, int $userid = null): array {
+    public static function get_categories_with_sharable_question_choices(\context $context, ?int $userid = null): array {
         global $DB;
 
         if (self::has_question_versionning()) {
@@ -312,7 +312,7 @@ public static function get_categories_with_sharable_question_choices(\context $c
      * @param int|null $userid (optional) if set, only count questions created by this user.
      * @return \stdClass[] question id => object with fields question id, name and idnumber.
      */
-    public static function get_sharable_question_ids(int $categoryid, int $userid = null): array {
+    public static function get_sharable_question_ids(int $categoryid, ?int $userid = null): array {
         global $DB;
 
         if (self::has_question_versionning()) {
@@ -380,7 +380,7 @@ public static function get_sharable_question_ids(int $categoryid, int $userid =
      * @param int|null $userid (optional) if set, only count questions created by this user.
      * @return array question idnumber => question name.
      */
-    public static function get_sharable_question_choices(int $categoryid, int $userid = null): array {
+    public static function get_sharable_question_choices(int $categoryid, ?int $userid = null): array {
         $questions = self::get_sharable_question_ids($categoryid, $userid);
 
         $choices = ['' => get_string('choosedots')];

lang/en/filter_embedquestion.php

@@ -39,8 +39,8 @@
 $string['errormaxmarknumber'] = 'The maximum mark must be a number.';
 $string['errornopermissions'] = 'You do not have permission to embed this question.';
 $string['errorunknownquestion'] = 'Unknown, or unsharable question.';
-$string['errorvariantoutofrange'] = 'Variant number must be a positive integer at most {$a}.';
 $string['errorvariantformat'] = 'Variant number must be a positive integer.';
+$string['errorvariantoutofrange'] = 'Variant number must be a positive integer at most {$a}.';
 $string['filtername'] = 'Embed questions';
 $string['generalfeedback_desc'] = 'Whether the general feedback should be shown by default in embedded questions.';
 $string['howquestionbehaves'] = 'How the question behaves';

tests/attempt_test.php

@@ -14,7 +14,6 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-
 namespace filter_embedquestion;
 
 /**
@@ -26,7 +25,7 @@
  * @covers    \filter_embedquestion\attempt
  * @covers    \filter_embedquestion\attempt_storage
  */
-class attempt_test extends \advanced_testcase {
+final class attempt_test extends \advanced_testcase {
 
     public function test_start_new_attempt_at_question_will_select_an_unused_question(): void {
         global $DB, $USER;