Merge pull request #521 from jrchamp/fix/use-moodle-extra

PHPCS - use moodle-extra standard
ncstate-delta · Sep 28, 2023 · 6c7eb69 · 6c7eb69
2 parents ea77159 + 9494214
commit 6c7eb69
Show file tree

Hide file tree

Showing 38 changed files with 1,021 additions and 551 deletions.
diff --git a/.phpcs.xml b/.phpcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="MoodleCore">
+  <rule ref="./phpcs.xml"/>
+  <rule ref="moodle-extra">
+  </rule>
+</ruleset>
diff --git a/backup/moodle2/backup_zoom_activity_task.class.php b/backup/moodle2/backup_zoom_activity_task.class.php
@@ -27,6 +27,8 @@
 
 require_once($CFG->dirroot . '/mod/zoom/backup/moodle2/backup_zoom_stepslib.php');
 
+use mod_zoom\backup_activity_structure_step;
+
 /**
  * Provides the steps to perform one complete backup of the zoom instance
  */
@@ -41,7 +43,7 @@ protected function define_my_settings() {
      * Defines a backup step to store the instance data in the zoom.xml file
      */
     protected function define_my_steps() {
-        $this->add_step(new backup_zoom_activity_structure_step('zoom_structure', 'zoom.xml'));
+        $this->add_step(new backup_activity_structure_step('zoom_structure', 'zoom.xml'));
     }
 
     /**

diff --git a/backup/moodle2/backup_zoom_stepslib.php b/backup/moodle2/backup_zoom_stepslib.php
@@ -15,18 +15,23 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Defines backup_zoom_activity_structure_step class.
+ * Defines backup_activity_structure_step class.
  *
  * @package   mod_zoom
  * @category  backup
  * @copyright 2015 UC Regents
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+namespace mod_zoom;
+
+use backup;
+use backup_nested_element;
+
 /**
  * Define the complete zoom structure for backup, with file and id annotations.
  */
-class backup_zoom_activity_structure_step extends backup_activity_structure_step {
+class backup_activity_structure_step extends \backup_activity_structure_step {
     /**
      * Defines the backup structure of the module.
      *

diff --git a/backup/moodle2/restore_zoom_activity_task.class.php b/backup/moodle2/restore_zoom_activity_task.class.php
@@ -27,6 +27,8 @@
 
 require_once($CFG->dirroot . '/mod/zoom/backup/moodle2/restore_zoom_stepslib.php');
 
+use mod_zoom\restore_activity_structure_step;
+
 /**
  * Restore task for the zoom activity module
  *
@@ -45,7 +47,7 @@ protected function define_my_settings() {
      */
     protected function define_my_steps() {
         // We have just one structure step here.
-        $this->add_step(new restore_zoom_activity_structure_step('zoom_structure', 'zoom.xml'));
+        $this->add_step(new restore_activity_structure_step('zoom_structure', 'zoom.xml'));
     }
 
     /**

diff --git a/backup/moodle2/restore_zoom_stepslib.php b/backup/moodle2/restore_zoom_stepslib.php
@@ -23,14 +23,18 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+namespace mod_zoom;
+
 defined('MOODLE_INTERNAL') || die();
 
 require_once($CFG->dirroot . '/mod/zoom/locallib.php');
 
+use restore_path_element;
+
 /**
  * Structure step to restore one zoom activity
  */
-class restore_zoom_activity_structure_step extends restore_activity_structure_step {
+class restore_activity_structure_step extends \restore_activity_structure_step {
     /**
      * Defines structure of path elements to be processed during the restore
      *

diff --git a/classes/api_limit_exception.php b/classes/api_limit_exception.php
@@ -0,0 +1,57 @@
+<?php
+// This file is part of the Zoom plugin for Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Exception class for Zoom API errors.
+ *
+ * @package   mod_zoom
+ * @copyright 2023 Jonathan Champ <jrchamp@ncsu.edu>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_zoom;
+
+/**
+ * Exceeded daily API limit.
+ */
+class api_limit_exception extends webservice_exception {
+    /**
+     * Unix timestamp of next time to API can be called.
+     * @var int
+     */
+    public $retryafter = null;
+
+    /**
+     * Constructor
+     * @param string $response  Web service response
+     * @param int $errorcode    Web service response error code
+     * @param int $retryafter   Unix timestamp of next time to API can be called.
+     */
+    public function __construct($response, $errorcode, $retryafter) {
+        $this->retryafter = $retryafter;
+
+        $a = new \stdClass();
+        $a->response = $response;
+        parent::__construct(
+            $response,
+            $errorcode,
+            'zoomerr_apilimit',
+            'mod_zoom',
+            '',
+            userdate($retryafter, get_string('strftimedaydatetime', 'core_langconfig'))
+        );
+    }
+}
diff --git a/classes/bad_request_exception.php b/classes/bad_request_exception.php
@@ -0,0 +1,39 @@
+<?php
+// This file is part of the Zoom plugin for Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Exception class for Zoom API errors.
+ *
+ * @package   mod_zoom
+ * @copyright 2023 Jonathan Champ <jrchamp@ncsu.edu>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_zoom;
+
+/**
+ * Bad request received by Zoom.
+ */
+class bad_request_exception extends webservice_exception {
+    /**
+     * Constructor
+     * @param string $response      Web service response message
+     * @param int $errorcode     Web service response error code
+     */
+    public function __construct($response, $errorcode) {
+        parent::__construct($response, $errorcode, 'errorwebservice_badrequest', 'mod_zoom', '', $response);
+    }
+}
diff --git a/classes/external.php b/classes/external.php
@@ -25,14 +25,22 @@
  * @since      Moodle 3.1
  */
 
+namespace mod_zoom;
+
 defined('MOODLE_INTERNAL') || die;
 
 require_once("$CFG->libdir/externallib.php");
 
+use external_api;
+use external_function_parameters;
+use external_single_structure;
+use external_value;
+use external_warnings;
+
 /**
  * Zoom external functions
  */
-class mod_zoom_external extends external_api {
+class external extends external_api {
     /**
      * Returns description of method parameters
      *
@@ -79,7 +87,7 @@ public static function get_state($zoomid) {
         require_capability('mod/zoom:view', $context);
 
         // Call the zoom/locallib API.
-        list($inprogress, $available, $finished) = zoom_get_state($zoom);
+        [$inprogress, $available, $finished] = zoom_get_state($zoom);
 
         $result = [];
         $result['available'] = $available;
@@ -215,5 +223,4 @@ public static function grade_item_update_returns() {
             ]
         );
     }
-
 }
diff --git a/classes/invitation.php b/classes/invitation.php
@@ -134,15 +134,24 @@ private function remove_element(string $invitation, string $element): string {
 
         // If invitation is null, an error occurred in preg_replace.
         if ($invitation === null) {
-            throw new \moodle_exception('invitationmodificationfailed', 'mod_zoom', $PAGE->url,
-                    ['element' => $element, 'pattern' => $configregex[$element]]);
+            throw new \moodle_exception(
+                'invitationmodificationfailed',
+                'mod_zoom',
+                $PAGE->url,
+                ['element' => $element, 'pattern' => $configregex[$element]]
+            );
         }
 
         // Add debugging message to assist site administrator in testing regex patterns if no match is found.
         if (empty($count)) {
-            debugging(get_string('invitationmatchnotfound', 'mod_zoom',
-                    ['element' => $element, 'pattern' => $configregex[$element]]),
-                    DEBUG_DEVELOPER);
+            debugging(
+                get_string(
+                    'invitationmatchnotfound',
+                    'mod_zoom',
+                    ['element' => $element, 'pattern' => $configregex[$element]]
+                ),
+                DEBUG_DEVELOPER
+            );
         }
 
         return $invitation;
@@ -169,9 +178,14 @@ private function add_paragraph_break_above_element(string $invitation, string $e
         $result = preg_match($configregex[$element], $invitation, $matches, PREG_OFFSET_CAPTURE);
         // If error occurred in preg_match, show debugging message to help site administrator.
         if ($result === false) {
-            debugging(get_string('invitationmodificationfailed', 'mod_zoom',
-                    ['element' => $element, 'pattern' => $configregex[$element]]),
-                    DEBUG_DEVELOPER);
+            debugging(
+                get_string(
+                    'invitationmodificationfailed',
+                    'mod_zoom',
+                    ['element' => $element, 'pattern' => $configregex[$element]]
+                ),
+                DEBUG_DEVELOPER
+            );
         }
 
         // No match found, so return invitation string unaltered.

diff --git a/classes/not_found_exception.php b/classes/not_found_exception.php
@@ -0,0 +1,39 @@
+<?php
+// This file is part of the Zoom plugin for Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Exception class for Zoom API errors.
+ *
+ * @package   mod_zoom
+ * @copyright 2023 Jonathan Champ <jrchamp@ncsu.edu>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace mod_zoom;
+
+/**
+ * Entry not found on Zoom.
+ */
+class not_found_exception extends webservice_exception {
+    /**
+     * Constructor
+     * @param string $response      Web service response message
+     * @param int $errorcode     Web service response error code
+     */
+    public function __construct($response, $errorcode) {
+        parent::__construct($response, $errorcode, 'errorwebservice_notfound', 'mod_zoom');
+    }
+}
diff --git a/classes/output/mobile.php b/classes/output/mobile.php
@@ -93,5 +93,4 @@ public static function mobile_course_view($args) {
             'files' => '',
         ];
     }
-
 }
diff --git a/classes/privacy/provider.php b/classes/privacy/provider.php
@@ -29,12 +29,8 @@
  * Ad hoc task that performs the actions for approved data privacy requests.
  */
 class provider implements
-    // This plugin has data.
-    \core_privacy\local\metadata\provider,
-
     \core_privacy\local\request\core_userlist_provider,
-
-    // This plugin currently implements the original plugin_provider interface.
+    \core_privacy\local\metadata\provider,
     \core_privacy\local\request\plugin\provider {
     /**
      * Returns meta data about this system.
@@ -53,17 +49,23 @@ public static function get_metadata(\core_privacy\local\metadata\collection $col
             'duration' => 'privacy:metadata:zoom_meeting_participants:duration',
         ], 'privacy:metadata:zoom_meeting_participants');
 
-        $coll->add_database_table('zoom_meeting_details',
-                                        ['topic' => 'privacy:metadata:zoom_meeting_details:topic'],
-                                        'privacy:metadata:zoom_meeting_details');
+        $coll->add_database_table(
+            'zoom_meeting_details',
+            ['topic' => 'privacy:metadata:zoom_meeting_details:topic'],
+            'privacy:metadata:zoom_meeting_details'
+        );
 
-        $coll->add_database_table('zoom_meeting_recordings_view',
+        $coll->add_database_table(
+            'zoom_meeting_recordings_view',
             ['userid' => 'privacy:metadata:zoom_meeting_view:userid'],
-            'privacy:metadata:zoom_meeting_view');
+            'privacy:metadata:zoom_meeting_view'
+        );
 
-        $coll->add_database_table('zoom_breakout_participants',
+        $coll->add_database_table(
+            'zoom_breakout_participants',
             ['userid' => 'privacy:metadata:zoom_breakout_participants:userid'],
-            'privacy:metadata:zoom_breakout_participants');
+            'privacy:metadata:zoom_breakout_participants'
+        );
 
         return $coll;
     }
@@ -166,7 +168,7 @@ public static function export_user_data(\core_privacy\local\request\approved_con
 
         $user = $contextlist->get_user();
 
-        list($contextsql, $contextparams) = $DB->get_in_or_equal($contextlist->get_contextids(), SQL_PARAMS_NAMED);
+        [$contextsql, $contextparams] = $DB->get_in_or_equal($contextlist->get_contextids(), SQL_PARAMS_NAMED);
 
         $sql = "SELECT zmp.id,
                        zmd.topic,
@@ -345,7 +347,7 @@ public static function delete_data_for_users(\core_privacy\local\request\approve
 
         // Prepare SQL to gather all completed IDs.
         $userids = $userlist->get_userids();
-        list($insql, $inparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
+        [$insql, $inparams] = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
         $params = array_merge($inparams, ['contextid' => $context->id, 'modlevel' => CONTEXT_MODULE]);
 
         $sql = "SELECT zmd.id