Auto-format sources with PHPCBF

Author: dlmsr

authorise.php

@@ -53,21 +53,33 @@
 if ($action === 'logout') {
     // Remove access token.
     $userclient->log_out();
-    redirect($nextpage, get_string('logoutsuccess', 'mod_collaborativefolders', $servicename), null,
-        \core\output\notification::NOTIFY_SUCCESS);
+    redirect(
+        $nextpage,
+        get_string('logoutsuccess', 'mod_collaborativefolders', $servicename),
+        null,
+        \core\output\notification::NOTIFY_SUCCESS
+    );
     exit;
 }
 
 if ($action === 'login') {
     // Callback from remote system. Use received authorisation code to convert it into an access token.
     if ($userclient->check_login()) {
         // Token received! Continuing...
-        redirect($nextpage,  get_string('loginsuccess', 'mod_collaborativefolders', $servicename), null,
-            \core\output\notification::NOTIFY_SUCCESS);
+        redirect(
+            $nextpage,
+            get_string('loginsuccess', 'mod_collaborativefolders', $servicename),
+            null,
+            \core\output\notification::NOTIFY_SUCCESS
+        );
     } else {
         // Authorisation failed for some reason.
-        redirect($nextpage,  get_string('loginfailure', 'mod_collaborativefolders', $servicename), null,
-            \core\output\notification::NOTIFY_ERROR);
+        redirect(
+            $nextpage,
+            get_string('loginfailure', 'mod_collaborativefolders', $servicename),
+            null,
+            \core\output\notification::NOTIFY_ERROR
+        );
     }
     exit;
 }

classes/configuration_exception.php

@@ -32,7 +32,6 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class configuration_exception extends \moodle_exception {
-
     /**
      * Constructor
      * This exception is used when the configuration of the plugin can not be processed or database entries are

classes/event/course_module_viewed.php

@@ -35,7 +35,6 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class course_module_viewed extends \core\event\course_module_viewed {
-
     /**
      * Initialize the event
      */

classes/event/link_generated.php

@@ -32,8 +32,7 @@
  * @copyright  2017 Project seminar (Learnweb, University of Münster)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class link_generated extends  \core\event\base {
-
+class link_generated extends \core\event\base {
     /**
      * Init method.
      *
@@ -70,6 +69,6 @@ public static function get_name() {
      * @return \moodle_url
      */
     public function get_url() {
-        return new \moodle_url('/mod/collaborativefolders/view.php', array('id' => $this->contextinstanceid));
+        return new \moodle_url('/mod/collaborativefolders/view.php', ['id' => $this->contextinstanceid]);
     }
 }

classes/issuer_management.php

@@ -86,7 +86,7 @@ public static function create_issuer(string $issuername, string $baseurl): issue
             $record = (object) [
                 'issuerid' => $issuer->get('id'),
                 'externalfield' => $external,
-                'internalfield' => $internal
+                'internalfield' => $internal,
             ];
             $userfieldmapping = new \core\oauth2\user_field_mapping(0, $record);
             $userfieldmapping->create();

classes/local/clients/system_client.php

@@ -48,7 +48,7 @@ protected function get_stored_token() {
         return null;
     }
 
-    public function upgrade_refresh_token(\core\oauth2\system_account $systemaccount) : bool {
+    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

@@ -88,7 +88,7 @@ class system_folder_access {
      * Construct the wrapper and initialise the clients.
      * @throws \mod_collaborativefolders\configuration_exception if essential data is missing.
      */
-    public function __construct () {
+    public function __construct() {
         // Get issuer and system account client. Fail early, if needed.
         $selectedissuer = get_config("collaborativefolders", "issuerid");
         if (empty($selectedissuer)) {
@@ -216,7 +216,6 @@ public function generate_share(string $path, string $username, string $chosennam
         }
 
         throw new share_failed_exception(get_string('ocserror', 'mod_collaborativefolders'));
-
     }
 
     /**
@@ -263,7 +262,7 @@ public function get_existing_share_path(string $path, string $username) {
      * @return int status code received from the client.
      * @throws \moodle_exception on connection error.
      */
-    public function make_folder($path, $recursive = true) : int {
+    public function make_folder($path, $recursive = true): int {
         $this->initiate_webdavclient($this->systemclient);
         if (!$this->webdav->open()) {
             throw new \moodle_exception(get_string('socketerror', 'mod_collaborativefolders'));
@@ -273,7 +272,7 @@ public function make_folder($path, $recursive = true) : int {
             $parts = array_filter(explode('/', $path));
             $currpath = rtrim($this->davbasepath, '/');
             foreach ($parts as $part) {
-                $currpath .= '/'.$part;
+                $currpath .= '/' . $part;
                 if (!$this->webdav->is_dir($currpath)) {
                     // Folder doesn't already exist.
                     if (!$this->rename_by_id($currpath)) {
@@ -283,7 +282,7 @@ public function make_folder($path, $recursive = true) : int {
                 }
             }
         } else {
-            $result = $this->webdav->mkcol($this->davbasepath.$path);
+            $result = $this->webdav->mkcol($this->davbasepath . $path);
         }
         $this->webdav->close();
         return $result;
@@ -300,9 +299,9 @@ public function rename_by_id($path) {
         if (!preg_match($idregex, $path, $matches)) {
             return false;
         }
-        list(, $id) = $matches;
-        $idmatch = '| \(id '.$id.'\)$|';
-        $legacyidmatch = '|_id_'.$id.'$|'; // For folders created with earlier versions of mod_collaborativefolders.
+        [, $id] = $matches;
+        $idmatch = '| \(id ' . $id . '\)$|';
+        $legacyidmatch = '|_id_' . $id . '$|'; // For folders created with earlier versions of mod_collaborativefolders.
         $dir = dirname($path);
         $files = $this->webdav->ls($dir);
         if (!$files) {
@@ -317,8 +316,10 @@ public function rename_by_id($path) {
                 continue;
             }
 
-            if (substr($filepath, -strlen($idmatch)) === $idmatch ||
-                substr($filepath, -strlen($legacyidmatch)) === $legacyidmatch) {
+            if (
+                substr($filepath, -strlen($idmatch)) === $idmatch ||
+                substr($filepath, -strlen($legacyidmatch)) === $legacyidmatch
+            ) {
                 // We've found a folder with the same id, but a different name - rename the folder.
                 if (!$this->webdav->move($filepath, $path, false)) {
                     return false;

classes/local/clients/user_folder_access.php

@@ -39,6 +39,7 @@
  */
 class user_folder_access {
     use webdav_client_trait;
+
     /**
      * Additional scopes needed by the user account. Currently, ownCloud does not actually support/use scopes, so
      * this is intended as a hint at required functionality and will help declare future scopes.
@@ -76,7 +77,7 @@ class user_folder_access {
      * @param \moodle_url $oauthloginreturnurl URL that will be redirected to after the login callback has succeeded.
      * @throws configuration_exception If essential data is missing.
      */
-    public function __construct (\moodle_url $oauthloginreturnurl) {
+    public function __construct(\moodle_url $oauthloginreturnurl) {
         // Get issuer and system account client. Fail early, if needed.
         $selectedissuer = get_config("collaborativefolders", "issuerid");
         if (empty($selectedissuer)) {
@@ -97,7 +98,6 @@ public function __construct (\moodle_url $oauthloginreturnurl) {
         if (!$this->userclient) {
             throw new configuration_exception(get_string('incompletedata', 'mod_collaborativefolders'));
         }
-
     }
 
     /**
@@ -130,16 +130,14 @@ public function rename($pathtofolder, $newname) {
 
         $renamed = null;
 
-        $ret = array();
+        $ret = [];
 
         if ($this->webdav->open()) {
-
             // After the socket's opening, the WebDAV MOVE method has to be performed in
             // order to rename the folder.
             // TODO check number of slashes in `dst_path`.
-            $renamed = $this->webdav->move($this->davbasepath . $pathtofolder,  $this->davbasepath . '/' . $newname, false);
+            $renamed = $this->webdav->move($this->davbasepath . $pathtofolder, $this->davbasepath . '/' . $newname, false);
         } else {
-
             // If the socket could not be opened, a socket error needs to be returned.
             $ret['status'] = false;
             $ret['content'] = get_string('socketerror', 'mod_collaborativefolders');
@@ -151,7 +149,6 @@ public function rename($pathtofolder, $newname) {
             $ret['status'] = true;
             return $ret;
         } else {
-
             // If the WebDAV operation failed, a error message, containing the specific response code,
             // is returned.
             $ret['status'] = false;
@@ -183,7 +180,7 @@ public function get_login_url() {
      *
      * @return bool false, if no Access Token is set or can be requested.
      */
-    public function check_login() : bool {
+    public function check_login(): bool {
         if (!$this->userclient->is_logged_in()) {
             self::clear_userinfo_cache();
             return false;
@@ -205,11 +202,11 @@ public function store_link($cmid, $groupid, $userid, $value) {
         // TODO use persistent API instead.
         global $DB;
 
-        $params = array(
+        $params = [
                 'cmid' => $cmid,
                 'groupid' => $groupid,
                 'userid' => $userid,
-        );
+        ];
 
         $record = $DB->get_record('collaborativefolders_link', $params);
 
@@ -240,11 +237,11 @@ public function get_link($cmid, $groupid, $userid) {
         // TODO use persistent API instead.
         global $DB;
 
-        $params = array(
+        $params = [
             'cmid' => $cmid,
             'groupid' => $groupid,
             'userid' => $userid,
-        );
+        ];
 
         return $DB->get_record('collaborativefolders_link', $params);
     }
@@ -253,7 +250,7 @@ public function get_link($cmid, $groupid, $userid) {
      * Get the session cache that stores the user info, to save on repeated webservice calls.
      * @return \cache
      */
-    private static function get_userinfo_cache() : \cache {
+    private static function get_userinfo_cache(): \cache {
         return \cache::make('mod_collaborativefolders', 'userinfo');
     }
 
@@ -290,8 +287,8 @@ public function get_username() {
      * @param string $foldername Name of a folder
      * @return string URL where the folder should be found
      */
-    public function link_from_foldername($foldername) : string {
-        $baseurl = rtrim($this->issuer->get('baseurl'), '/').'/';
+    public function link_from_foldername($foldername): string {
+        $baseurl = rtrim($this->issuer->get('baseurl'), '/') . '/';
         return sprintf('%sindex.php/apps/files/?dir=/%s', $baseurl, urlencode($foldername));
     }
 }

classes/local/clients/webdav_client_trait.php

@@ -43,7 +43,7 @@ trait webdav_client_trait {
      * @return \webdav_client An initialised WebDAV client for ownCloud.
      * @throws configuration_exception If configuration is missing (endpoints).
      */
-    private function initiate_webdavclient($client) : \webdav_client {
+    private function initiate_webdavclient($client): \webdav_client {
         if ($this->webdav !== null) {
             return $this->webdav;
         }
@@ -72,8 +72,14 @@ private function initiate_webdavclient($client) : \webdav_client {
         }
 
         // Authentication method is `bearer` for OAuth 2. Pass oauth client from which WebDAV obtains the token when needed.
-        $this->webdav = new \webdav_client($server, '', '', 'bearer', $webdavtype,
-            $client->get_accesstoken()->token);
+        $this->webdav = new \webdav_client(
+            $server,
+            '',
+            '',
+            'bearer',
+            $webdavtype,
+            $client->get_accesstoken()->token
+        );
 
         $this->davbasepath = $webdavendpoint['path'];
 

classes/local/sharing/share_exists_exception.php

@@ -32,7 +32,6 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class share_exists_exception extends \moodle_exception {
-
     /**
      * Constructor
      * @param string $hint optional param for additional information of the problem