fix linting

Author: kwibus

.gitignore

@@ -1,2 +1 @@
-/vendor/
 .well-known/

.gitlab-ci.yml

@@ -36,7 +36,7 @@ default:
     - export PATH="/opt/moodle-plugin-ci/bin:/opt/moodle-plugin-ci/vendor/bin:$PATH"
     # TODO not always needed
     # install moodle
-    # - moodle-plugin-ci install --db-host db 
+    # - moodle-plugin-ci install --db-host db
     # - '{ php -S 0.0.0.0:8000 -t "$CI_PROJECT_DIR/moodle" >/dev/null 2>&1 & }'
 
 # install dependencies:

classes/claim/address.php

@@ -29,18 +29,17 @@
  */
 class address implements claim {
 
-
     /**
      * Get addres claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user user user want the address claim from
      * @return array() Returns address information of user
      */
     public function claim($user): array {
         $claims = [
             'address' => [
                 // Not inplemented 'formatted', 'region' 'postal_code'.
                 'street_address' => $user->address,
-                'locality' => $user->address,
+                'locality' => $user->city,
                 'country' => $user->country,
             ],
         ];

classes/claim/claim.php

@@ -33,7 +33,7 @@ interface claim {
 
     /**
      * Get addres claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user user user want the address claim from
      * @return array() Returns address information of user
      */
     public function claim(array $user);

classes/claim/email.php

@@ -31,7 +31,7 @@ class email implements claim {
 
     /**
      * Get email claim.
-     * @param array of core_user user user want the email claim from
+     * @param array $user core_user user user want the email claim from
      * @return array() Returns email information of user
      */
     public function claim($user) {

classes/claim/enrolments.php

@@ -31,7 +31,7 @@ class enrolments implements claim {
     // TODO maybe also return role, and external id.
     /**
      * Get addres claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user want the address claim from
      * @return array() Returns address information of user enrolments which array of course short names
      */
     public function claim($user) {

classes/claim/phone.php

@@ -31,7 +31,7 @@ class phone implements claim {
 
     /**
      * Get phone claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user want the address claim from
      * @return array() Returns phone_number information of user
      */
     public function claim($user) {

classes/claim/profile.php

@@ -32,7 +32,7 @@ class profile implements claim {
 
     /**
      * Get addres claim.
-     * @param array of core_user user user want the address claim from
+     * @param array $user core_user want the address claim from
      * @return array() Returns profile information of user
      */
     public function claim($user) {

classes/client.php

@@ -27,26 +27,38 @@
  * class that manges settings for client for this IdP.
  */
 class client {
-    /**@var int id primary for this client in the database */
+    /** @var int $id primary for this client in the database */
     public int $id; // Has to be pulic now because the way its send to database in update.
 
-    /**@var string $clientid name of the client */
+    /** @var string $clientid name of the client */
     public string $clientid;
-    /**@var string $clientsecret password of this client*/
+
+    /** @var string $clientsecret password of this client*/
     public string $clientsecret;
-    /**@var string $redirecturi addres of the clinet to send user to after identification*/
+
+    /** @var string $redirecturi addres of the clinet to send user to after identification*/
     public string $redirecturi;
-    /**@var array $granttypes types of oauth flows server will accept for this client*/
+
+    /** @var array $granttypes types of oauth flows server will accept for this client*/
     public array $granttypes;
-    /**@var array $scopes the client is allowed to request, which in our case are the claims*/
+
+    /** @var array $scope the client is allowed to request, which in our case are the claims*/
     public array $scope;
-    /**@var int $userid if client grantype used is client_authenticat. which user the client inperonates */
+
+    /** @var int $userid if client grantype used is client_authenticat. which user the client inperonates */
     public int $userid;
-    /**@var int $noconfirmation if user is asked to confirm that client is allowed to get this information of the user*/
+
+    /** @var int $noconfirmation if user is asked to confirm that client is allowed to get this information of the user*/
     public int $noconfirmation;
 
     /**
      * Initialze the client class.
+     * @param int $clientid
+     * @param string $redirecturi
+     * @param array $granttypes
+     * @param array $scope
+     * @param int $userid
+     * @param bool $noconfirmation
      */
     public function __construct($clientid, $redirecturi, $granttypes, $scope, $userid, $noconfirmation) {
         $this->clientid = $clientid;
@@ -71,6 +83,8 @@ public function id() {
     // TODO Use $storage->getClientDetails instead .
     /**
      * Get client by client id from database.
+     *
+     * @param int $id clientid
      */
     public static function get_client_by_id($id) {
         global $DB;
@@ -130,6 +144,8 @@ public function delete() {
 
     /**
      * Generate public private key pair
+     *
+     * @param int $clientid
      */
     public static function generate_key_pair($clientid) {
         global $DB;

classes/form/authorize.php

@@ -18,16 +18,15 @@
  * local_oauth user granted event.
  *
  * @package    local_oauth
- * @copyright
+ * @copyright   https://github.com/examus/moodle-local_oauth
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 namespace local_oauth\form;
 
 use moodleform;
 
 /**
- * Form that request the use if he the client should be authorize,
- * to get information specified by the requested scope.
+ * Form that request the use if he the client should be authorize, to get information specified by the requested scope.
  */
 class authorize extends moodleform {