wip: fixes phpdoc linter warnings/errors.

ilios · Dec 5, 2023 · 7b14f8a · 7b14f8a
1 parent eb35e6b
commit 7b14f8a
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 3 deletions.
diff --git a/classes/ilios_client.php b/classes/ilios_client.php
@@ -31,7 +31,6 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-/** @global $CFG */
 require_once($CFG->dirroot . '/lib/filelib.php');
 
 /**
@@ -55,12 +54,19 @@ class ilios_client {
     const API_URL = '/api/v3';
 
     /**
+     * Constructor.
+     *
      * @param string $iliosbaseurl The Ilios base URL
      * @param curl $curl the cURL client
      */
     public function __construct(protected string $iliosbaseurl, protected curl $curl) {
     }
 
+    /**
+     * Returns the Ilios API base URL.
+     *
+     * @return string
+     */
     protected function get_api_base_url(): string {
         return $this->iliosbaseurl . self::API_URL;
     }
@@ -70,8 +76,8 @@ protected function get_api_base_url(): string {
      *
      * @param string $accesstoken the Ilios API access token
      * @param string $entitytype the entity type of data to retrieve
-     * @param array|string $filters e.g. array('id' => 3)
-     * @param array|string $sortorder e.g. array('title' => "ASC")
+     * @param mixed $filters e.g. array('id' => 3)
+     * @param mixed $sortorder e.g. array('title' => "ASC")
      * @param int $batchsize the maximum number of entities to retrieve per batch.
      * @return array
      * @throws moodle_exception

diff --git a/classes/privacy/provider.php b/classes/privacy/provider.php
@@ -32,6 +32,10 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class provider implements null_provider {
+
+    /**
+     * @inheritdoc
+     */
     public static function get_reason(): string {
         return 'privacy:metadata';
     }

diff --git a/tests/ilios_client_test.php b/tests/ilios_client_test.php
@@ -374,19 +374,34 @@ public function test_get_by_ids_fails_with_invalid_token(string $accesstoken): v
         $this->ilios_client->get_by_ids($accesstoken, 'does_not_matter', 100);
     }
 
+    /**
+     * Returns empty access tokens.
+     *
+     * @return array[]
+     */
     public static function empty_token_provider(): array {
         return [
                 [''],
                 ['   '],
         ];
     }
 
+    /**
+     * Returns "corrupted" access tokens.
+     *
+     * @return array[]
+     */
     public static function corrupted_token_provider(): array {
         return [
                 ['AAAAA.BBBBB.CCCCCC'], // Has the right number of segments, but bunk payload.
         ];
     }
 
+    /**
+     * Returns access tokens with invalid numbers of segments.
+     *
+     * @return array[]
+     */
     public static function invalid_token_provider(): array {
         return [
                 ['AAAA'], // Not enough segments.
@@ -395,6 +410,11 @@ public static function invalid_token_provider(): array {
         ];
     }
 
+    /**
+     * Returns expired access tokens.
+     *
+     * @return array[]
+     */
     public static function expired_token_provider(): array {
         $key = 'doesnotmatterhere';
         $payload = ['exp' => (new DateTime('-2 days'))->getTimestamp()];