Moodle PHPDoc Checker fixes.

lucaboesch · Jul 29, 2024 · befd40c · befd40c
1 parent ca14adc
commit befd40c
Show file tree

Hide file tree

Showing 22 changed files with 341 additions and 222 deletions.
diff --git a/.github/workflows/moodle-plugin-ci.yml b/.github/workflows/moodle-plugin-ci.yml
@@ -135,11 +135,11 @@ jobs:
 
       - name: Moodle Code Checker
         if: ${{ always() }}
-        run: moodle-plugin-ci phpcs --max-warnings 0 || true
+        run: moodle-plugin-ci phpcs --max-warnings 0
 
       - name: Moodle PHPDoc Checker
         if: ${{ always() }}
-        run: moodle-plugin-ci phpdoc || true
+        run: moodle-plugin-ci phpdoc
 
       - name: Validating
         if: ${{ always() }}

diff --git a/backup/moodle2/restore_plagiarism_turnitin_plugin.class.php b/backup/moodle2/restore_plagiarism_turnitin_plugin.class.php
@@ -37,6 +37,10 @@ protected function define_course_plugin_structure() {
      * Restore the Turnitin course
      * This will only be done this if the course is from the same site it was backed up from
      * and if the Turnitin course id does not currently exist in the database.
+     *
+     * @param array $data The data to be restored
+     * @return void
+     * @throws dml_exception
      */
     public function process_turnitin_course($data) {
         global $DB;
@@ -72,6 +76,10 @@ protected function define_module_plugin_structure() {
      * Restore the Turnitin assignment id for this module
      * This will only be done this if the module is from the same site it was backed up from
      * and if the Turnitin assignment id does not currently exist in the database.
+     *
+     * @param array $data The data to be restored
+     * @return void
+     * @throws dml_exception
      */
     public function process_turnitin_config($data) {
         global $DB;
@@ -98,6 +106,10 @@ public function process_turnitin_config($data) {
      * Restore the links to Turnitin files.
      * This will only be done this if the module is from the same site it was backed up from
      * and if the Turnitin submission does not currently exist in the database.
+     *
+     * @param array $data The data to be restored
+     * @return void
+     * @throws dml_exception
      */
     public function process_turnitin_files($data) {
         global $DB;

diff --git a/classes/digitalreceipt/pp_receipt_message.php b/classes/digitalreceipt/pp_receipt_message.php
@@ -26,7 +26,9 @@ class pp_receipt_message {
     /**
      * Send digital receipt to submitter
      *
+     * @param int $userid
      * @param string $message
+     * @param int $courseid
      * @return void
      */
     public function send_message($userid, $message, $courseid) {

diff --git a/classes/forms/turnitin_setupform.class.php b/classes/forms/turnitin_setupform.class.php
@@ -259,6 +259,8 @@ public function display() {
 
     /**
      * Save the plugin config data
+     *
+     * @param stdClass $data
      */
     public function save($data) {
         global $CFG;

diff --git a/classes/modules/turnitin_assign.class.php b/classes/modules/turnitin_assign.class.php
@@ -51,7 +51,7 @@ public function __construct() {
     /**
      * Check whether the user is a tutor
      *
-     * @param $context
+     * @param context $context The context
      * @return bool
      * @throws coding_exception
      */
@@ -68,22 +68,10 @@ public function get_tutor_capability() {
         return 'mod/'.$this->modname.':grade';
     }
 
-    /**
-     * Whether the user is enrolled on the course and has the capability to submit assignments
-     *
-     * @param $context
-     * @param $userid
-     * @return bool
-     * @throws coding_exception
-     */
-    public function user_enrolled_on_course($context, $userid) {
-        return has_capability('mod/'.$this->modname.':submit', $context, $userid);
-    }
-
     /**
      * Get the author of the submission
      *
-     * @param $itemid
+     * @param int $itemid The item id
      * @return int
      * @throws dml_exception
      */
@@ -97,11 +85,23 @@ public function get_author($itemid) {
         }
     }
 
+    /**
+     * Whether the user is enrolled on the course and has the capability to submit assignments
+     *
+     * @param context $context The context
+     * @param int $userid The user id
+     * @return bool
+     * @throws coding_exception
+     */
+    public function user_enrolled_on_course($context, $userid) {
+        return has_capability('mod/'.$this->modname.':submit', $context, $userid);
+    }
+
     /**
      * Set the content of the submission
      *
-     * @param $linkarray
-     * @param $cm
+     * @param array $linkarray The link array
+     * @param object $cm The course module.
      * @return string
      */
     public function set_content($linkarray, $cm) {
@@ -114,7 +114,11 @@ public function set_content($linkarray, $cm) {
     /**
      * Check if resubmissions in a Turnitin sense are allowed to an assignment.
      *
-     * @param $assignid
+     * @param int $assignid The assignment id
+     * @param int $reportgenspeed The report generation speed
+     * @param string $submissiontype The submission type
+     * @param int $attemptreopenmethod The attempt reopen method
+     * @param string $attemptreopened The attempt reopened status
      */
     public function is_resubmission_allowed($assignid, $reportgenspeed, $submissiontype, $attemptreopenmethod,
                                             $attemptreopened = null) {
@@ -150,8 +154,8 @@ public function is_resubmission_allowed($assignid, $reportgenspeed, $submissiont
     /**
      * Get the onlinetext submission
      *
-     * @param $userid
-     * @param $cm
+     * @param int $userid The user id
+     * @param object $cm The course module.
      * @return stdClass
      * @throws dml_exception
      */
@@ -181,7 +185,7 @@ public function get_onlinetext($userid, $cm) {
     /**
      * Create a file event
      *
-     * @param $params
+     * @param array $params The params
      * @return \core\event\base
      * @throws coding_exception
      */
@@ -192,7 +196,7 @@ public function create_file_event($params) {
     /**
      * Create a text event
      *
-     * @param $params
+     * @param array $params The params
      * @return \core\event\base
      * @throws coding_exception
      */
@@ -203,9 +207,9 @@ public function create_text_event($params) {
     /**
      * Get the current grade query
      *
-     * @param $userid
-     * @param $moduleid
-     * @param $itemid
+     * @param int $userid The user id
+     * @param int $moduleid The module id
+     * @param int $itemid The item id
      * @return false|mixed
      * @throws dml_exception
      */
@@ -222,7 +226,7 @@ public function get_current_gradequery($userid, $moduleid, $itemid = 0) {
     /**
      * Initialise the post date for the module
      *
-     * @param $moduledata
+     * @param stdClass $moduledata The module data
      * @return int
      */
     public function initialise_post_date($moduledata) {

diff --git a/classes/modules/turnitin_coursework.class.php b/classes/modules/turnitin_coursework.class.php
@@ -51,7 +51,7 @@ public function __construct() {
     /**
      * Check whether the user is a tutor
      *
-     * @param $context
+     * @param context $context The context
      * @return bool
      */
     public function is_tutor($context) {
@@ -72,8 +72,8 @@ public function get_tutor_capability() {
     /**
      * Whether the user is enrolled on the course and has the capability to submit coursework
      *
-     * @param $context
-     * @param $userid
+     * @param context $context The context
+     * @param int $userid The user id
      * @return bool
      * @throws coding_exception
      */
@@ -84,7 +84,7 @@ public function user_enrolled_on_course($context, $userid) {
     /**
      * Get the author of the submission
      *
-     * @param $itemid
+     * @param int $itemid The item id
      * @return int
      * @throws dml_exception
      */
@@ -103,7 +103,7 @@ public function get_author($itemid) {
     /**
      * Create a file event
      *
-     * @param $params
+     * @param array $params The params
      * @return mixed
      */
     public function create_file_event($params) {
@@ -113,9 +113,9 @@ public function create_file_event($params) {
     /**
      * Get the current grade query
      *
-     * @param $userid
-     * @param $moduleid
-     * @param $itemid
+     * @param int $userid The user id
+     * @param int $moduleid The module id
+     * @param int $itemid The item id
      * @return false|mixed
      * @throws dml_exception
      */
@@ -140,7 +140,7 @@ public function get_current_gradequery($userid, $moduleid, $itemid = 0) {
     /**
      * Initialise the post date for the module
      *
-     * @param $moduledata
+     * @param stdClass $moduledata The module data
      * @return int
      */
     public function initialise_post_date($moduledata) {

diff --git a/classes/modules/turnitin_forum.class.php b/classes/modules/turnitin_forum.class.php
@@ -51,7 +51,7 @@ public function __construct() {
     /**
      * Check whether the user is a tutor
      *
-     * @param $context
+     * @param context $context The context
      * @return bool
      * @throws coding_exception
      */
@@ -71,8 +71,8 @@ public function get_tutor_capability() {
     /**
      * Whether the user is enrolled on the course and has the capability to reply to posts
      *
-     * @param $context
-     * @param $userid
+     * @param context $context The context
+     * @param int $userid The user id
      * @return bool
      * @throws coding_exception
      */
@@ -83,7 +83,7 @@ public function user_enrolled_on_course($context, $userid) {
     /**
      * Get the author of the forum post
      *
-     * @param $itemid
+     * @param int $itemid The item id
      * @return void
      */
     public function get_author($itemid = 0) {
@@ -93,7 +93,7 @@ public function get_author($itemid = 0) {
     /**
      * Set the content of the forum post
      *
-     * @param $linkarray
+     * @param array $linkarray The link array
      * @return mixed
      * @throws dml_exception
      */
@@ -111,7 +111,7 @@ public function set_content($linkarray) {
     /**
      * Create a file event
      *
-     * @param $params
+     * @param array $params The params
      * @return \core\event\base
      * @throws coding_exception
      */
@@ -122,9 +122,9 @@ public function create_file_event($params) {
     /**
      * Get the current grade query
      *
-     * @param $userid
-     * @param $moduleid
-     * @param $itemid
+     * @param int $userid The user id
+     * @param int $moduleid The module id
+     * @param int $itemid The item id
      * @return false|mixed|stdClass
      * @throws dml_exception
      */
@@ -138,7 +138,7 @@ public function get_current_gradequery($userid, $moduleid, $itemid = 0) {
     /**
      * Initialise the post date for the module
      *
-     * @param $moduledata
+     * @param stdClass $moduledata The module data
      * @return int
      */
     public function initialise_post_date($moduledata) {
@@ -150,7 +150,7 @@ public function initialise_post_date($moduledata) {
     /**
      * Get the forum discussion id
      *
-     * @param $forumdata
+     * @param string $forumdata The forum data
      * @return string
      */
     public function get_discussionid($forumdata) {