PHPStan cleanup pass

ericsizemore · Dec 24, 2023 · fd74833 · fd74833
1 parent daa18cd
commit fd74833
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -69,7 +69,7 @@ As an example, let's say you want to get a list of the available platforms. To d
 ```php
 <?php
 
-use Esi\LibrariesIO\Platform\Platform;
+use Esi\LibrariesIO\Platform;
 
 $api = new Platform('..yourapikey..', \sys_get_temp_dir());
 $response = $api->makeRequest();

diff --git a/src/AbstractBase.php b/src/AbstractBase.php
@@ -190,7 +190,7 @@ public abstract function makeRequest(string $endpoint, array $options): Response
      * Processes the available parameters for a given endpoint.
      *
      * @param string $endpoint
-     * @return array<string, array<int, string>|string>
+     * @return array<string, array<string>|string>
      */
     public abstract function endpointParameters(string $endpoint): array;
 
@@ -212,6 +212,7 @@ public function processEndpointFormat(string $format, array $options): string
             if ($key === 'page' || $key === 'per_page') {
                 continue;
             }
+            /** @var string $val **/
             $format = str_replace(":$key", $val, $format);
         }
         return $format;
@@ -221,8 +222,8 @@ public function processEndpointFormat(string $format, array $options): string
      * Helper function to make sure that the $options passed to the child class' makeRequest() 
      * contains the required options listed in the endpoints options.
      *
-     * @param array<string, array<int, string>|string> $endpointOptions
-     * @param array<string, int|string>                $options
+     * @param array<int, string>        $endpointOptions
+     * @param array<string, int|string> $options
      * @return bool
      */
     public function verifyEndpointOptions(array $endpointOptions, array $options): bool

diff --git a/src/Platform.php b/src/Platform.php
@@ -14,6 +14,8 @@
  */
 namespace Esi\LibrariesIO;
 
+use InvalidArgumentException;
+
 use Esi\LibrariesIO\{
     Exception\RateLimitExceededException,
     AbstractBase
@@ -73,6 +75,7 @@ public function makeRequest(string $endpoint = 'platforms', ?array $options = nu
 
         // Attempt the request
         try {
+            /** @phpstan-ignore-next-line **/
             return $this->client->get($endpointParameters['format']);
         } catch (ClientException $e) {
             if ($e->getResponse()->getStatusCode() === 429) {

diff --git a/src/Project.php b/src/Project.php
@@ -72,6 +72,7 @@ public function makeRequest(string $endpoint, array $options): ResponseInterface
             );
         }
 
+        /** @var array<int, string> $endpointOptions **/        
         $endpointOptions = $endpointParameters['options'];
 
         if (!parent::verifyEndpointOptions($endpointOptions, $options)) {
@@ -105,7 +106,7 @@ public function makeRequest(string $endpoint, array $options): ResponseInterface
         parent::makeClient($query);
 
         // Attempt the request
-        $endpointParameters['format'] = parent::processEndpointFormat($endpointParameters['format'], $options);
+        $endpointParameters['format'] = parent::processEndpointFormat(/** @phpstan-ignore-line **/$endpointParameters['format'], $options);
 
         try {
             return $this->client->get($endpointParameters['format']);

diff --git a/src/Repository.php b/src/Repository.php
@@ -62,7 +62,7 @@ final class Repository extends AbstractBase
     /**
      * {@inheritdoc}
      */
-    public function makeRequest(string $endpoint, ?array $options = null): ResponseInterface
+    public function makeRequest(string $endpoint, array $options): ResponseInterface
     {
         // Make sure we have the format and options for $endpoint
         $endpointParameters = $this->endpointParameters($endpoint);
@@ -73,6 +73,7 @@ public function makeRequest(string $endpoint, ?array $options = null): ResponseI
             );
         }
 
+        /** @var array<int, string> $endpointOptions **/
         $endpointOptions = $endpointParameters['options'];
 
         if (!parent::verifyEndpointOptions($endpointOptions, $options)) {
@@ -89,7 +90,7 @@ public function makeRequest(string $endpoint, ?array $options = null): ResponseI
         ]);
 
         // Attempt the request
-        $endpointParameters['format'] = parent::processEndpointFormat($endpointParameters['format'], $options);
+        $endpointParameters['format'] = parent::processEndpointFormat(/** @phpstan-ignore-line **/$endpointParameters['format'], $options);
 
         try {
             return $this->client->get($endpointParameters['format']);

diff --git a/src/User.php b/src/User.php
@@ -64,7 +64,7 @@ final class User extends AbstractBase
     /**
      * {@inheritdoc}
      */
-    public function makeRequest(string $endpoint, ?array $options = null): ResponseInterface
+    public function makeRequest(string $endpoint, array $options): ResponseInterface
     {
         // Make sure we have the format and options for $endpoint
         $endpointParameters = $this->endpointParameters($endpoint);
@@ -75,6 +75,7 @@ public function makeRequest(string $endpoint, ?array $options = null): ResponseI
             );
         }
 
+        /** @var array<int, string> $endpointOptions **/
         $endpointOptions = $endpointParameters['options'];
 
         if (!parent::verifyEndpointOptions($endpointOptions, $options)) {
@@ -91,7 +92,7 @@ public function makeRequest(string $endpoint, ?array $options = null): ResponseI
         ]);
 
         // Attempt the request
-        $endpointParameters['format'] = parent::processEndpointFormat($endpointParameters['format'], $options);
+        $endpointParameters['format'] = parent::processEndpointFormat(/** @phpstan-ignore-line **/$endpointParameters['format'], $options);
 
         // Attempt the request
         try {