PhpDoc Checker fixes for 500 (#641)

* Adopting Moodle Plugin CI for Moodle 5.0

* Resolved implicitly marking parameter as nullable deprecation

* Resolved Data Provider method is not static

* Resolved Moodle PHPDoc Checker issues

---------

Co-authored-by: Mike Churchward <[email protected]>

Author: lucaboesch

.github/workflows/ci.yml

@@ -30,15 +30,15 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          - php: '8.4'
+            moodle-branch: 'MOODLE_500_STABLE'
+            database: 'pgsql'
           - php: '8.3'
-            moodle-branch: 'MOODLE_405_STABLE'
+            moodle-branch: 'MOODLE_500_STABLE'
             database: 'mariadb'
           - php: '8.2'
-            moodle-branch: 'MOODLE_405_STABLE'
+            moodle-branch: 'MOODLE_500_STABLE'
             database: 'pgsql'
-          - php: '8.1'
-            moodle-branch: 'MOODLE_404_STABLE'
-            database: 'mariadb'
 
     steps:
       - name: Checkout
@@ -88,7 +88,7 @@ jobs:
 
       - name: Moodle PHPDoc Checker
         if: ${{ always() }}
-        run: moodle-plugin-ci phpdoc || true
+        run: moodle-plugin-ci phpdoc
 
       - name: Validating
         if: ${{ always() }}

classes/output/renderer.php

@@ -571,9 +571,9 @@ public function download_dataformat_selector($label, $base, $name = 'dataformat'
     }
 
     /**
-     * @param $urlroot
-     * @param $options
-     * @param $userview
+     * @param moodle_url $urlroot
+     * @param array $options
+     * @param string $userview
      * @return string
      * @throws \coding_exception
      * @throws \moodle_exception

classes/question/question.php

@@ -652,10 +652,10 @@ public function update($questionrecord = null, $updatechoices = true) {
     /**
      * Add the question to the database from supplied arguments.
      * @param \stdClass $questionrecord The required data for adding the question.
-     * @param array $choicerecords An array of choice records with 'content' and 'value' properties.
-     * @param boolean $calcposition Whether or not to calculate the next available position in the survey.
+     * @param array|null $choicerecords An array of choice records with 'content' and 'value' properties.
+     * @param bool|null $calcposition Whether or not to calculate the next available position in the survey.
      */
-    public function add($questionrecord, array $choicerecords = null, $calcposition = true) {
+    public function add($questionrecord, ?array $choicerecords = null, ?bool $calcposition = true) {
         global $DB;
 
         // Create new question.

classes/question/rate.php

@@ -1026,9 +1026,9 @@ public function insert_nameddegrees(array $nameddegrees) {
      * Helper function used to move existing named degree choices for the specified question from the "quest_choice" table to the
      * "question" table.
      * @param int $qid
-     * @param null|\stdClass $questionrec
+     * @param \stdClass|null $questionrec
      */
-    public static function move_nameddegree_choices(int $qid = 0, \stdClass $questionrec = null) {
+    public static function move_nameddegree_choices(int $qid = 0, ?\stdClass $questionrec = null) {
         global $DB;
 
         if ($qid !== 0) {
@@ -1079,7 +1079,7 @@ public static function move_nameddegree_choices(int $qid = 0, \stdClass $questio
      * questionnaire before '2018110103'.
      * @param int|null $surveyid
      */
-    public static function move_all_nameddegree_choices(int $surveyid = null) {
+    public static function move_all_nameddegree_choices(?int $surveyid = null) {
         global $DB;
 
         // This operation might take a while. Cancel PHP timeouts for this.

classes/responsetype/responsetype.php

@@ -45,9 +45,9 @@ abstract class responsetype {
      * responsetype constructor.
      * @param \mod_questionnaire\question\question $question
      * @param int|null $responseid
-     * @param array $choices
+     * @param array|null $choices
      */
-    public function __construct(\mod_questionnaire\question\question $question, int $responseid = null, array $choices = []) {
+    public function __construct(\mod_questionnaire\question\question $question, ?int $responseid = null, ?array $choices = []) {
         $this->question = $question;
         $this->responseid = $responseid;
         $this->choices = $choices;

questionnaire.class.php

@@ -4216,9 +4216,9 @@ public static function get_user_identity_fields($context, $userid) {
     }
 
     /**
-     * Output the questionnair information.
+     * Output the questionnaire information.
      *
-     * @param array $messages any access messages that should be described.
+     * @return string
      */
     public function view_information() {
         $messages = [];

tests/behat/behat_mod_questionnaire.php

@@ -418,7 +418,7 @@ private function add_response_data($qid, $sid) {
      *                         to replace with mapped values.
      * @return null
      */
-    private function add_data(array $data, $datatable, $mapvar = '', array $replvars = null) {
+    private function add_data(array $data, $datatable, $mapvar = '', ?array $replvars = null) {
         global $DB;
 
         if ($replvars === null) {

tests/custom_completion_test.php

@@ -51,7 +51,7 @@ class custom_completion_test extends \advanced_testcase {
      *
      * @return array[]
      */
-    public function get_state_provider(): array {
+    public static function get_state_provider(): array {
         return [
             'Undefined rule' => [
                 'somenonexistentrule', COMPLETION_DISABLED, false, null, coding_exception::class
@@ -75,7 +75,7 @@ public function get_state_provider(): array {
      * @dataProvider get_state_provider
      * @param string $rule The custom completion rule.
      * @param int $available Whether this rule is available.
-     * @param bool $submitted
+     * @param bool|null $submitted
      * @param int|null $status Expected status.
      * @param string|null $exception Expected exception.
      * @throws coding_exception
@@ -178,7 +178,7 @@ public function test_is_defined() {
      *
      * @return array[]
      */
-    public function get_available_custom_rules_provider(): array {
+    public static function get_available_custom_rules_provider(): array {
         return [
             'Completion submit available' => [
                 COMPLETION_ENABLED, ['completionsubmit']

tests/generator/lib.php

@@ -76,10 +76,10 @@ public function questionnaires() {
     /**
      * Create a questionnaire activity.
      * @param array $record Will be changed in this function.
-     * @param array $options
+     * @param array|null $options
      * @return questionnaire
      */
-    public function create_instance($record = null, array $options = null) {
+    public function create_instance($record = null, ?array $options = null) {
         $record = (object)(array)$record;
 
         $defaultquestionnairesettings = array(