Fix remaining PHPCS errors

Author: dlmsr

classes/issuer_management.php

@@ -33,7 +33,6 @@
  * @copyright  2018 Jan Dageförde (Learnweb, University of Münster)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-
 class issuer_management {
     /**
      * Create an ownCloud/Nextcloud ready OAuth 2 service. Generates all required endpoints and field mappings.

classes/local/clients/system_client.php

@@ -24,7 +24,11 @@
 
 namespace mod_collaborativefolders\local\clients;
 
+/**
+ * Extend oauth\client to store token in application cache, not in the SESSION
+ */
 class system_client extends \core\oauth2\client {
+    #[\Override]
     protected function store_token($token) {
         // Call parent function, as $this->accesstoken is private, so can't set directly.
         parent::store_token($token);
@@ -38,6 +42,7 @@ protected function store_token($token) {
         }
     }
 
+    #[\Override]
     protected function get_stored_token() {
         $name = $this->get_tokenname();
         $cache = \cache::make('mod_collaborativefolders', 'token');
@@ -48,6 +53,7 @@ protected function get_stored_token() {
         return null;
     }
 
+    #[\Override]
     public function upgrade_refresh_token(\core\oauth2\system_account $systemaccount): bool {
         $this->store_token(null); // Make sure the existing token is cleared, before calling refresh.
         return parent::upgrade_refresh_token($systemaccount);

classes/local/clients/system_folder_access.php

@@ -175,12 +175,12 @@ private function verify_system_access() {
      *
      * @param string $path path to the folder (relative to sharing private storage).
      * @param string $username Receiving ownCloud username.
-     * @param string $chosenname (optional) the name of the shared folder within the user's ownCloud
+     * @param string|null $chosenname (optional) the name of the shared folder within the user's ownCloud
      * @return \SimpleXMLElement Excerpt from the XML response on success.
      * @throws share_exists_exception If the folder had already been shared prior.
      * @throws share_failed_exception If calling the OCS API resulted in an unknown state.
      */
-    public function generate_share(string $path, string $username, string $chosenname = null) {
+    public function generate_share(string $path, string $username, string|null $chosenname = null) {
         $this->verify_system_access();
 
         if (!$this->make_folder($path)) {

classes/local/clients/user_folder_access.php

@@ -46,6 +46,9 @@ class user_folder_access {
      */
     const SCOPES = 'files';
 
+    /**
+     * User information cache key.
+     */
     const USERINFO_CACHE_KEY = 1;
 
     /**
@@ -276,6 +279,9 @@ public function get_userinfo() {
         return $user;
     }
 
+    /**
+     * Return username.
+     */
     public function get_username() {
         $userinfo = $this->get_userinfo();
         return $userinfo['username'];

classes/name_form.php

@@ -29,6 +29,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class name_form extends \moodleform {
+    #[\Override]
     public function definition() {
         $mform = $this->_form;
 
@@ -42,6 +43,7 @@ public function definition() {
         $mform->addElement('submit', 'enter', get_string('getaccess', 'mod_collaborativefolders'));
     }
 
+    #[\Override]
     public function validation($data, $files) {
         $errors = parent::validation($data, $files);
 
@@ -52,6 +54,7 @@ public function validation($data, $files) {
         return $errors;
     }
 
+    #[\Override]
     protected function get_form_identifier() {
         $formid = $this->_customdata['id'] . '_' . get_class($this);
         return $formid;

classes/output/renderer.php

@@ -14,8 +14,6 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-namespace mod_collaborativefolders\output;
-
 /**
  * Renderer for the Web interface of collaborativefolders module.
  *
@@ -24,6 +22,8 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+namespace mod_collaborativefolders\output;
+
 use core\output\notification;
 use core\output\plugin_renderer_base;
 use mod_collaborativefolders\name_form;
@@ -62,6 +62,9 @@ public function render_widget_login(\moodle_url $loginurl) {
         return html_writer::link($loginurl, get_string('btnlogin', 'mod_collaborativefolders'), ['class' => 'btn btn-primary']);
     }
 
+    /**
+     * Render teachersnotallowed notification.
+     */
     public function render_widget_teachermaynotaccess() {
         $notification = new notification(
             get_string('teachersnotallowed', 'mod_collaborativefolders'),
@@ -71,6 +74,9 @@ public function render_widget_teachermaynotaccess() {
         return $this->render($notification);
     }
 
+    /**
+     * Render notingroup notification.
+     */
     public function render_widget_nogroups(): string {
         $notification = new notification(
             get_string('notingroup', 'mod_collaborativefolders'),
@@ -80,6 +86,9 @@ public function render_widget_nogroups(): string {
         return $this->render($notification);
     }
 
+    /**
+     * Render problem_nosystemconnection notification.
+     */
     public function render_widget_nosystemconnection() {
         $servicename = get_config('collaborativefolders', 'servicename');
         $notification = new notification(
@@ -90,6 +99,9 @@ public function render_widget_nosystemconnection() {
         return $this->render($notification);
     }
 
+    /**
+     * Render problem_misconfiguration notification.
+     */
     public function render_widget_misconfiguration() {
         $notification = new notification(
             get_string('problem_misconfiguration', 'mod_collaborativefolders'),
@@ -99,6 +111,9 @@ public function render_widget_misconfiguration() {
         return $this->render($notification);
     }
 
+    /**
+     * Render problem_sharessuppressed notification.
+     */
     public function render_widget_noconnection_suppressed_share(int $sharessuppressed) {
         $info = (object)[
             'sharessuppressed' => $sharessuppressed,
@@ -114,6 +129,7 @@ public function render_widget_noconnection_suppressed_share(int $sharessuppresse
     }
 
     /**
+     * Render the name form.
      * @param name_form $form
      */
     public function output_name_form($group, name_form $form) {

classes/privacy/provider.php

@@ -28,9 +28,13 @@
 use core_privacy\local\request\helper;
 use core_privacy\local\request\writer;
 
+/**
+ * Privacy provider for mod_collaborativefolders
+ */
 class provider implements
     \core_privacy\local\metadata\provider,
     \core_privacy\local\request\plugin\provider {
+    #[\Override]
     public static function get_metadata(collection $collection): collection {
         $collection->add_database_table(
             'collaborativefolders_link',
@@ -46,6 +50,7 @@ public static function get_metadata(collection $collection): collection {
         return $collection;
     }
 
+    #[\Override]
     public static function get_contexts_for_userid(int $userid): \core_privacy\local\request\contextlist {
         $contextlist = new \core_privacy\local\request\contextlist();
 
@@ -62,6 +67,7 @@ public static function get_contexts_for_userid(int $userid): \core_privacy\local
         return $contextlist;
     }
 
+    #[\Override]
     public static function export_user_data(\core_privacy\local\request\approved_contextlist $contextlist) {
         global $DB;
         if (!$contextlist->count()) {
@@ -108,6 +114,12 @@ public static function export_user_data(\core_privacy\local\request\approved_con
         }
     }
 
+    /**
+     * Export user data for mod_collaborativefolders
+     * @param array $links links
+     * @param int $cmid course module ID
+     * @param \stdClass $user user record.
+     */
     private static function export_collaborativefolders_data_for_user(array $links, int $cmid, \stdClass $user) {
         // Fetch the generic module data for the choice.
         $context = \context_module::instance($cmid);
@@ -121,6 +133,7 @@ private static function export_collaborativefolders_data_for_user(array $links,
         helper::export_context_files($context, $user);
     }
 
+    #[\Override]
     public static function delete_data_for_all_users_in_context(\context $context) {
         global $DB;
         if (!$context) {
@@ -139,6 +152,7 @@ public static function delete_data_for_all_users_in_context(\context $context) {
         );
     }
 
+    #[\Override]
     public static function delete_data_for_user(\core_privacy\local\request\approved_contextlist $contextlist) {
         global $DB;
         if (!$contextlist->count()) {

classes/view_controller.php

@@ -184,7 +184,6 @@ private static function get_instance_status($collaborativefolder, \cm_info $cm,
      * @param bool $systemclientcanshare true if there is a connected system account that could create a share
      * @param user_folder_access $userclient connected client for the current user.
      * @return string Rendered view
-     * @internal param user_folder_access $userclient
      */
     private static function share_and_view_folders(
         \cm_info $cm,
@@ -250,7 +249,13 @@ private static function share_and_view_folders(
         return $out;
     }
 
-    private static function obtain_folders(statusinfo $statusinfo, \cm_info $cm, $isteacher) {
+    /**
+     * Obtain the folders.
+     * @param statusinfo $statusinfo status information.
+     * @param cm_info $cm course module information
+     * @param bool $isteacher whether a teacher
+     */
+    private static function obtain_folders(statusinfo $statusinfo, \cm_info $cm, bool $isteacher) {
         // Get applicable groups from $statusinfo.
         if ($isteacher && !$statusinfo->teachermayaccess) {
             // Refuse access for teacher because user config says so.
@@ -279,6 +284,7 @@ private static function obtain_folders(statusinfo $statusinfo, \cm_info $cm, $is
     }
 
     /**
+     * Handle folder form submission.
      * @param array $userfolders array of folders applicable for the user
      * @param \cm_info $cm current coursemodule
      * @param user_folder_access $userclient connected client of the user

db/upgrade.php

@@ -22,6 +22,12 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+/**
+ * Execute mod_collaborativefolders upgrade from the given old version.
+ *
+ * @param int $oldversion
+ * @return bool
+ */
 function xmldb_collaborativefolders_upgrade($oldversion = 0) {
     global $DB;
     $dbman = $DB->get_manager();

lib.php

@@ -65,10 +65,10 @@ function collaborativefolders_supports($feature) {
  * of the new instance.
  *
  * @param stdClass $collaborativefolders Submitted data from the form in mod_form.php
- * @param mod_collaborativefolders_mod_form $mform The form instance itself (if needed)
+ * @param mod_collaborativefolders_mod_form|null $mform The form instance itself (if needed)
  * @return int The id of the newly inserted collaborativefolders record
  */
-function collaborativefolders_add_instance(stdClass $collaborativefolders, mod_collaborativefolders_mod_form $mform = null) {
+function collaborativefolders_add_instance(stdClass $collaborativefolders, mod_collaborativefolders_mod_form|null $mform = null) {
     global $DB;
 
     $collaborativefolders->timecreated = time();
@@ -86,10 +86,10 @@ function collaborativefolders_add_instance(stdClass $collaborativefolders, mod_c
  * will update an existing instance with new data.
  *
  * @param stdClass $collaborativefolders An object from the form in mod_form.php
- * @param mod_collaborativefolders_mod_form $mform The form instance itself (if needed)
+ * @param mod_collaborativefolders_mod_form|null $mform The form instance itself (if needed)
  * @return boolean Success/Fail
  */
-function collaborativefolders_update_instance(stdClass $collaborativefolders, mod_collaborativefolders_mod_form $mform = null) {
+function collaborativefolders_update_instance(stdClass $collaborativefolders, mod_collaborativefolders_mod_form|null $mform = null) {
     global $DB;
 
     $collaborativefolders->timemodified = time();