Fix document for override function #869616

Author: danghieu1407

classes/event/attempt_created.php

@@ -33,39 +33,25 @@
  */
 class attempt_created extends base_event {
 
-    /**
-     * Init method.
-     */
+    #[\Override]
     protected function init() {
         $this->data['crud'] = 'w';
         $this->data['edulevel'] = self::LEVEL_TEACHING;
     }
 
-    /**
-     * Returns the name of the event.
-     *
-     * @return string The name.
-     */
+    #[\Override]
     public static function get_name(): string {
         return get_string('event_attempt_created', 'quiz_answersheets');
     }
 
-    /**
-     * Returns the description of the event.
-     *
-     * @return string The description.
-     */
+    #[\Override]
     public function get_description() {
         return 'The user with id ' . $this->userid . ' has created the attempt with id ' . $this->other['attemptid'] .
                 ' for the user with id ' . $this->relateduserid . ' for the quiz with course module id ' .
                 $this->contextinstanceid . '.';
     }
 
-    /**
-     * Returns the URL where the event can be viewed.
-     *
-     * @return \moodle_url The URL.
-     */
+    #[\Override]
     public function get_url(): \moodle_url {
         return new \moodle_url('/mod/quiz/report/answersheets/attemptsheet.php', ['attempt' => $this->other['attemptid']]);
     }

classes/event/attempt_printed.php

@@ -33,31 +33,19 @@
  */
 class attempt_printed extends base_event {
 
-    /**
-     * Returns the name of the event.
-     *
-     * @return string The name.
-     */
+    #[\Override]
     public static function get_name(): string {
         return get_string('event_attempt_printed', 'quiz_answersheets');
     }
 
-    /**
-     * Returns the description of the event.
-     *
-     * @return string The description.
-     */
+    #[\Override]
     public function get_description(): string {
         return 'The user with id ' . $this->userid . ' has printed the attempt sheet with id ' . $this->other['attemptid'] .
                 ' belonging to the user with id ' . $this->relateduserid . ' for the quiz with course module id ' .
                 $this->contextinstanceid . '.';
     }
 
-    /**
-     * Returns the URL where the event can be viewed.
-     *
-     * @return \moodle_url The URL.
-     */
+    #[\Override]
     public function get_url(): \moodle_url {
         return new \moodle_url('/mod/quiz/report/answersheets/attemptsheet.php', ['attempt' => $this->other['attemptid']]);
     }

classes/event/attempt_viewed.php

@@ -33,31 +33,19 @@
  */
 class attempt_viewed extends base_event {
 
-    /**
-     * Returns the name of the event.
-     *
-     * @return string The name.
-     */
+    #[\Override]
     public static function get_name(): string {
         return get_string('event_attempt_viewed', 'quiz_answersheets');
     }
 
-    /**
-     * Returns the description of the event.
-     *
-     * @return string The description.
-     */
+    #[\Override]
     public function get_description(): string {
         return 'The user with id ' . $this->userid . ' has viewed the attempt sheet with id ' . $this->other['attemptid'] .
                 ' belonging to the user with id ' . $this->relateduserid . ' for the quiz with course module id ' .
                 $this->contextinstanceid . '.';
     }
 
-    /**
-     * Returns the URL where the event can be viewed.
-     *
-     * @return \moodle_url The URL.
-     */
+    #[\Override]
     public function get_url(): \moodle_url {
         return new \moodle_url('/mod/quiz/report/answersheets/attemptsheet.php', ['attempt' => $this->other['attemptid']]);
     }

classes/event/base_event.php

@@ -33,17 +33,13 @@
  */
 class base_event extends \core\event\base {
 
-    /**
-     * Init method.
-     */
+    #[\Override]
     protected function init() {
         $this->data['crud'] = 'r';
         $this->data['edulevel'] = self::LEVEL_TEACHING;
     }
 
-    /**
-     * Returns the context instance id.
-     */
+    #[\Override]
     protected function validate_data() {
         parent::validate_data();
         if (!isset($this->relateduserid)) {
@@ -59,11 +55,7 @@ protected function validate_data() {
         }
     }
 
-    /**
-     * Returns the context instance id.
-     *
-     * @return int The context instance id.
-     */
+    #[\Override]
     public static function get_objectid_mapping(): int {
         return \core\event\base::NOT_MAPPED;
     }

classes/event/responses_submitted.php

@@ -33,31 +33,19 @@
  */
 class responses_submitted extends base_event {
 
-    /**
-     * Returns the name of the event.
-     *
-     * @return string The name.
-     */
+    #[\Override]
     public static function get_name(): string {
         return get_string('event_responses_submitted', 'quiz_answersheets');
     }
 
-    /**
-     * Returns the description of the event.
-     *
-     * @return string The description.
-     */
+    #[\Override]
     public function get_description(): string {
         return 'The user with id ' . $this->userid . ' has submitted the responses for the attempt sheet with id ' .
                 $this->other['attemptid'] . ' on behalf of user with id ' . $this->relateduserid .
                 ' for the quiz with course module id ' . $this->contextinstanceid . '.';
     }
 
-    /**
-     * Returns the URL where the event can be viewed.
-     *
-     * @return \moodle_url The URL.
-     */
+    #[\Override]
     public function get_url(): \moodle_url {
         return new \moodle_url('/mod/quiz/report/answersheets/attemptsheet.php',
                 ['attempt' => $this->other['attemptid']]);

classes/event/right_answer_printed.php

@@ -33,31 +33,19 @@
  */
 class right_answer_printed extends base_event {
 
-    /**
-     * Returns the name of the event.
-     *
-     * @return string The name.
-     */
+    #[\Override]
     public static function get_name(): string {
         return get_string('event_right_answer_printed', 'quiz_answersheets');
     }
 
-    /**
-     * Returns the description of the event.
-     *
-     * @return string The description.
-     */
+    #[\Override]
     public function get_description(): string {
         return 'The user with id ' . $this->userid . ' has printed the right answer sheet with id ' . $this->other['attemptid'] .
                 ' belonging to the user with id ' . $this->relateduserid . ' for the quiz with course module id ' .
                 $this->contextinstanceid . '.';
     }
 
-    /**
-     * Returns the URL where the event can be viewed.
-     *
-     * @return \moodle_url The URL.
-     */
+    #[\Override]
     public function get_url(): \moodle_url {
         return new \moodle_url('/mod/quiz/report/answersheets/attemptsheet.php',
                 ['attempt' => $this->other['attemptid'], 'rightanswer' => 1]);

classes/event/right_answer_viewed.php

@@ -33,31 +33,19 @@
  */
 class right_answer_viewed extends base_event {
 
-    /**
-     * Returns the name of the event.
-     *
-     * @return string The name.
-     */
+    #[\Override]
     public static function get_name(): string {
         return get_string('event_right_answer_viewed', 'quiz_answersheets');
     }
 
-    /**
-     * Returns the description of the event.
-     *
-     * @return string The description.
-     */
+    #[\Override]
     public function get_description(): string {
         return 'The user with id ' . $this->userid . ' has viewed the right answer sheet with id ' . $this->other['attemptid'] .
                 ' belonging to the user with id ' . $this->relateduserid . ' for the quiz with course module id ' .
                 $this->contextinstanceid . '.';
     }
 
-    /**
-     * Returns the URL where the event can be viewed.
-     *
-     * @return \moodle_url The URL.
-     */
+    #[\Override]
     public function get_url(): \moodle_url {
         return new \moodle_url('/mod/quiz/report/answersheets/attemptsheet.php',
                 ['attempt' => $this->other['attemptid'], 'rightanswer' => 1]);

classes/output/gapselect/renderer.php

@@ -40,14 +40,7 @@
  */
 class qtype_gapselect_override_renderer extends \qtype_gapselect_renderer {
 
-    /**
-     * Render the embedded element
-     *
-     * @param question_attempt $qa
-     * @param $place
-     * @param question_display_options $options
-     * @return string
-     */
+    #[\Override]
     protected function embedded_element(question_attempt $qa, $place, question_display_options $options) {
         if (utils::should_hide_inline_choice($this->page)) {
             return parent::embedded_element($qa, $place, $options);

classes/output/match/renderer.php

@@ -42,13 +42,7 @@
  */
 class qtype_match_override_renderer extends \qtype_match_renderer {
 
-    /**
-     * The code was copied from question/type/match/renderer.php, with modifications.
-     *
-     * @param question_attempt $qa
-     * @param question_display_options $options
-     * @return string
-     */
+    #[\Override]
     public function formulation_and_controls(question_attempt $qa, question_display_options $options) {
         if (utils::should_hide_inline_choice($this->page)) {
             return parent::formulation_and_controls($qa, $options);

classes/output/multichoice/renderer.php

@@ -41,13 +41,7 @@
  */
 class qtype_multichoice_override_renderer extends \qtype_multichoice_single_renderer {
 
-    /**
-     * The code was copied from question/type/multichoice/renderer.php, with modifications.
-     *
-     * @param question_attempt $qa
-     * @param question_display_options $options
-     * @return string
-     */
+    #[\Override]
     public function formulation_and_controls(question_attempt $qa, question_display_options $options) {
         $question = $qa->get_question();
         $response = $question->get_response($qa);