Refactor for MOODLE41 & PHP 7.4

Lesterhuis-Training-en-Consultancy · Dec 18, 2023 · 64257c7 · 64257c7
1 parent d5533c2
commit 64257c7
Show file tree

Hide file tree

Showing 27 changed files with 100 additions and 73 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,7 +12,6 @@ jobs:
       disable_grunt: true
       disable_phpunit: true
       disable_phpcpd: true # Old code we don't going to rewrite everything for now.
-      disable_phpdoc: true # Old code we don't going to rewrite everything for now.
       disable_release : true
       release_branches: main
       min_php : 7.4
diff --git a/components/competencytemplates/plugin.class.php b/components/competencytemplates/plugin.class.php
@@ -57,7 +57,13 @@ public function summary(object $data): string {
         return get_string('filtercompetencytemplates_summary', 'block_configurable_reports');
     }
 
-    public function execute($finalelements, $data) {
+    /**
+     * Execute
+     *
+     * @param string $finalelements
+     * @return array|string|string[]
+     */
+    public function execute($finalelements) {
 
         $filtercompetencytemplates = optional_param('filter_competencytemplates', 0, PARAM_INT);
         if (!$filtercompetencytemplates) {

diff --git a/components/conditions/cuserfield/plugin.class.php b/components/conditions/cuserfield/plugin.class.php
@@ -66,12 +66,11 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $data
-     * @param $user
-     * @param $courseid
+     * @param object $data
+     * @param object $user
      * @return array|int[]|string[]
      */
-    public function execute($data, $user, $courseid) {
+    public function execute($data, $user) {
         global $DB;
         // Data -> Plugin configuration data.
         // TODO - Use $DB->sql_like().

diff --git a/components/conditions/parentcategory/plugin.class.php b/components/conditions/parentcategory/plugin.class.php
@@ -65,7 +65,7 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $data
+     * @param object $data
      * @return array
      */
     public function execute($data) {

diff --git a/components/conditions/usersincohorts/plugin.class.php b/components/conditions/usersincohorts/plugin.class.php
@@ -57,7 +57,7 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $data
+     * @param object $data
      * @return array|int[]|string[]
      */
     public function execute($data) {

diff --git a/components/conditions/usersincurrentcourse/plugin.class.php b/components/conditions/usersincurrentcourse/plugin.class.php
@@ -57,9 +57,9 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $data
-     * @param $user
-     * @param $courseid
+     * @param object $data
+     * @param object $user
+     * @param int $courseid
      * @return array|int[]|string[]
      */
     public function execute($data, $user, $courseid) {

diff --git a/components/customsql/form.php b/components/customsql/form.php
@@ -112,8 +112,8 @@ public function validation($data, $files): array {
     /**
      * validation_high_security
      *
-     * @param $data
-     * @param $files
+     * @param array $data
+     * @param array $files
      * @return array
      */
     public function validation_high_security($data, $files): array {
@@ -166,8 +166,8 @@ public function validation_high_security($data, $files): array {
     /**
      * validation_low_security
      *
-     * @param $data
-     * @param $files
+     * @param array $data
+     * @param array $files
      * @return array
      */
     public function validation_low_security($data, $files) {

diff --git a/components/filters/categories/plugin.class.php b/components/filters/categories/plugin.class.php
@@ -55,7 +55,13 @@ public function summary(object $data): string {
         return get_string('filtercategories_summary', 'block_configurable_reports');
     }
 
-    public function execute($finalelements, $data) {
+    /**
+     * Execute
+     *
+     * @param string $finalelements
+     * @return array|string|string[]
+     */
+    public function execute($finalelements) {
 
         $filtercategories = optional_param('filter_categories', 0, PARAM_INT);
         if (!$filtercategories) {

diff --git a/components/filters/coursecategories/plugin.class.php b/components/filters/coursecategories/plugin.class.php
@@ -59,10 +59,9 @@ public function summary(object $data): string {
      * Execute
      *
      * @param string $finalelements
-     * @param $data
      * @return mixed
      */
-    public function execute($finalelements, $data) {
+    public function execute($finalelements) {
         global $remotedb, $CFG;
         require_once($CFG->dirroot . "/course/lib.php");
 

diff --git a/components/filters/fcoursefield/plugin.class.php b/components/filters/fcoursefield/plugin.class.php
@@ -59,7 +59,7 @@ public function summary(object $data): string {
      * Execute
      *
      * @param string $finalelements
-     * @param $data
+     * @param object $data
      * @return int[]|mixed|string[]
      */
     public function execute($finalelements, $data) {

diff --git a/components/filters/fuserfield/plugin.class.php b/components/filters/fuserfield/plugin.class.php
@@ -59,7 +59,7 @@ public function summary(object $data): string {
      * Execute
      *
      * @param string $finalelements
-     * @param $data
+     * @param object $data
      * @return array|int[]|mixed|string|string[]
      */
     public function execute($finalelements, $data) {
@@ -74,7 +74,7 @@ public function execute($finalelements, $data) {
      * execute_sql
      *
      * @param string $finalelements
-     * @param $data
+     * @param object $data
      * @return array|mixed|string|string[]
      */
     private function execute_sql($finalelements, $data) {
@@ -97,7 +97,7 @@ private function execute_sql($finalelements, $data) {
      * execute_users
      *
      * @param string $finalelements
-     * @param $data
+     * @param object $data
      * @return array|int[]|mixed|string[]
      */
     private function execute_users($finalelements, $data) {
@@ -217,12 +217,12 @@ public function print_filter(MoodleQuickForm $mform, $formdata = false): void {
     /**
      * sql_replace
      *
-     * @param $filtersearchtext
-     * @param $filterstrmatch
+     * @param string $filtersearchtext
+     * @param string $filterstrmatch
      * @param string $finalelements
      * @return array|mixed|string|string[]
      */
-    private function sql_replace($filtersearchtext, $filterstrmatch, $finalelements) {
+    private function sql_replace(string $filtersearchtext, $filterstrmatch, $finalelements) {
         $operators = ['=', '<', '>', '<=', '>=', '~', 'in'];
 
         // TODO this function is 2 times in the code, should be refactored.
@@ -235,6 +235,7 @@ private function sql_replace($filtersearchtext, $filterstrmatch, $finalelements)
                 throw new moodle_exception('nosuchoperator');
             }
             if ($operator === '~') {
+                // TODO can be improved by more native PDO approach.
                 $replace = " AND " . $field . " LIKE '%" . $filtersearchtext . "%'";
             } else if ($operator === 'in') {
                 $processeditems = [];

diff --git a/components/filters/role/plugin.class.php b/components/filters/role/plugin.class.php
@@ -55,7 +55,13 @@ public function summary(object $data): string {
         return get_string('filterrole_summary', 'block_configurable_reports');
     }
 
-    public function execute($finalelements, $data) {
+    /**
+     * Execute
+     *
+     * @param string $finalelements
+     * @return array|string|string[]
+     */
+    public function execute($finalelements) {
 
         $filterrole = optional_param('filter_role', 0, PARAM_INT);
         if (!$filterrole) {

diff --git a/components/filters/searchtext/form.php b/components/filters/searchtext/form.php
@@ -18,6 +18,7 @@
  * Form for searchtext filter
  *
  * @copyright  2020 David Saylor
+ * @package    block_configurable_reports
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @author     David Saylor <[email protected]>
  */

diff --git a/components/filters/searchtext/plugin.class.php b/components/filters/searchtext/plugin.class.php
@@ -17,9 +17,10 @@
 /**
  * Configurable Reports a Moodle block for creating customizable reports
  *
- * @package   block_configurable_reports
- * @author    Juan leyva <http://www.twitter.com/jleyvadelgado>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2020 Juan Leyva <[email protected]>
+ * @package    block_configurable_reports
+ * @author     Juan leyva <http://www.twitter.com/jleyvadelgado>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 defined('MOODLE_INTERNAL') || die;
 require_once($CFG->dirroot . '/blocks/configurable_reports/plugin.class.php');
@@ -116,8 +117,8 @@ public function print_filter(MoodleQuickForm $mform, $formdata = false): void {
     /**
      * sql_replace
      *
-     * @param $filtersearchtext
-     * @param $filterstrmatch
+     * @param string $filtersearchtext
+     * @param string $filterstrmatch
      * @param string $finalelements
      * @return array|mixed|string|string[]
      */

diff --git a/components/filters/startendtime/plugin.class.php b/components/filters/startendtime/plugin.class.php
@@ -55,7 +55,13 @@ public function summary(object $data): string {
         return get_string('filterstartendtime_summary', 'block_configurable_reports');
     }
 
-    public function execute($finalelements, $data) {
+    /**
+     * Execute
+     *
+     * @param string $finalelements
+     * @return array|string|string[]
+     */
+    public function execute($finalelements) {
         global $CFG;
 
         if ($this->report->type !== 'sql') {

diff --git a/components/filters/users/plugin.class.php b/components/filters/users/plugin.class.php
@@ -55,7 +55,13 @@ public function summary(object $data): string {
         return get_string('filterusers_summary', 'block_configurable_reports');
     }
 
-    public function execute($finalelements, $data) {
+    /**
+     * Execute
+     *
+     * @param string $finalelements
+     * @return string|array
+     */
+    public function execute($finalelements) {
 
         $filterusers = optional_param('filter_users', 0, PARAM_INT);
         if (!$filterusers) {
@@ -64,12 +70,12 @@ public function execute($finalelements, $data) {
 
         if ($this->report->type !== 'sql') {
             return [$filterusers];
-        } else {
-            if (preg_match("/%%FILTER_SYSTEMUSER:([^%]+)%%/i", $finalelements, $output)) {
-                $replace = ' AND ' . $output[1] . ' = ' . $filterusers;
+        }
 
-                return str_replace('%%FILTER_SYSTEMUSER:' . $output[1] . '%%', $replace, $finalelements);
-            }
+        if (preg_match("/%%FILTER_SYSTEMUSER:([^%]+)%%/i", $finalelements, $output)) {
+            $replace = ' AND ' . $output[1] . ' = ' . $filterusers;
+
+            return str_replace('%%FILTER_SYSTEMUSER:' . $output[1] . '%%', $replace, $finalelements);
         }
 
         return $finalelements;

diff --git a/components/permissions/anyone/plugin.class.php b/components/permissions/anyone/plugin.class.php
@@ -64,12 +64,9 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $userid
-     * @param $context
-     * @param $data
-     * @return true
+     * @return bool
      */
-    public function execute($userid, $context, $data) {
+    public function execute() {
         return true;
     }
 

diff --git a/components/permissions/reportscapabilities/plugin.class.php b/components/permissions/reportscapabilities/plugin.class.php
@@ -58,7 +58,7 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $userid
+     * @param int $userid
      * @return bool
      */
     public function execute($userid): bool {

diff --git a/components/permissions/roleincourse/plugin.class.php b/components/permissions/roleincourse/plugin.class.php
@@ -63,9 +63,9 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $userid
-     * @param $context
-     * @param $data
+     * @param int $userid
+     * @param context $context
+     * @param object $data
      * @return bool
      */
     public function execute($userid, $context, $data): bool {

diff --git a/components/permissions/usersincoursereport/plugin.class.php b/components/permissions/usersincoursereport/plugin.class.php
@@ -59,11 +59,10 @@ public function summary(object $data): string {
      * execute
      *
      * @param int $userid
-     * @param $context
-     * @param $data
+     * @param context $context
      * @return bool
      */
-    public function execute(int $userid, $context, $data) {
+    public function execute(int $userid, $context) {
 
         // Everyone should be enrolled at the system level.
         if ($context === context_system::instance()) {

diff --git a/components/plot/bar/form.php b/components/plot/bar/form.php
@@ -102,7 +102,9 @@ public function definition(): void {
     }
 
     /**
-     * @param $mform
+     * add_formatting_elements
+     *
+     * @param moodleform $mform
      * @return void
      */
     public function add_formatting_elements($mform): void {

diff --git a/components/plot/bar/plugin.class.php b/components/plot/bar/plugin.class.php
@@ -58,9 +58,9 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $id
-     * @param $data
-     * @param $finalreport
+     * @param int $id
+     * @param object $data
+     * @param array $finalreport
      * @return string
      */
     public function execute($id, $data, $finalreport) {

diff --git a/components/plot/line/plugin.class.php b/components/plot/line/plugin.class.php
@@ -58,9 +58,9 @@ public function summary(object $data): string {
     /**
      * Execute
      *
-     * @param $id
-     * @param $data
-     * @param $finalreport
+     * @param int $id
+     * @param object $data
+     * @param array $finalreport
      * @return string
      */
     public function execute($id, $data, $finalreport) {