Cleaned up code after PHPStan code analysis

Author: rimi-itk

composer.json

@@ -15,7 +15,8 @@
     "require-dev": {
         "php": "^8.3",
         "ergebnis/composer-normalize": "^2.52",
-        "friendsofphp/php-cs-fixer": "^3.95"
+        "friendsofphp/php-cs-fixer": "^3.95",
+        "phpstan/phpstan": "^2.2"
     },
     "autoload": {
         "psr-4": {

phpstan.dist.neon

@@ -0,0 +1,16 @@
+parameters:
+    level: 6
+    paths:
+        - src
+
+    treatPhpDocTypesAsCertain: false
+
+    ignoreErrors:
+        - message: '#Method ItkDev\\F2ApiClient\\Client\\ApiClient::[^ ]+\(\) has parameter \$[^ ]+ with no value type specified in iterable type array.#'
+          path: src/*
+
+        - message: '#Method ItkDev\\F2ApiClient\\Model\\[^ ]+::jsonSerialize\(\) return type has no value type specified in iterable type array.#'
+          path: src/*
+
+        - message: '#Method ItkDev\\F2ApiClient\\Command\\F2ApiClientCommand::responseToArray\(\) has parameter \$response with no value type specified in iterable type array.#'
+          path: src/Command/F2ApiClientCommand.php

src/Client/ApiClient.php

@@ -27,15 +27,35 @@
 /**
  * @phpstan-type AccessToken array{access_token: string, token_type: string, expires_in: int, refresh_token: string}
  * @phpstan-type ServiceIndex array<string, array{href: string, title: string}>
- */
+ * @phpstan-type OptionsInput array{
+ *   api_uri: non-empty-string,
+ *   api_username: non-empty-string,
+ *   api_secret: non-empty-string,
+ *   f2_username: non-empty-string,
+ *   cache_item_pool: CacheItemPoolInterface,
+ *   cache_item_lifetime?: int,
+ * }
+ * @phpstan-type Options array{
+ *    api_uri: non-empty-string,
+ *    api_username: non-empty-string,
+ *    api_secret: non-empty-string,
+ *    f2_username: non-empty-string,
+ *    cache_item_pool: CacheItemPoolInterface,
+ *    cache_item_lifetime: int,
+ *  }*/
 class ApiClient
 {
     use LoggerAwareTrait;
     use LoggerTrait;
 
+    /** @var Options */
     private readonly array $options;
+
     private ?HttpClientInterface $client = null;
 
+    /**
+     * @param OptionsInput $options
+     */
     public function __construct(array $options)
     {
         $resolver = new OptionsResolver();
@@ -68,7 +88,7 @@ public function getServiceIndex(): array
                 ],
             ]);
 
-            /** @var ServiceIndex */
+            /* @var ServiceIndex */
             return $response->toArray();
         });
     }
@@ -140,6 +160,9 @@ public function caseCreate(array $caseData): CaseFile
         return $this->createItemResult($response, CaseFile::class);
     }
 
+    /**
+     * @return Atom[]
+     */
     public function matterSearch(string $searchTerms, int $count = 10): array
     {
         $query = [
@@ -366,10 +389,10 @@ protected function configureOptions(OptionsResolver $resolver): void
                 'api_secret',
                 'f2_username',
             ])
-            ->setDefault('cache_item_lifetime', 86_400)
-            ->setAllowedTypes('cache_item_lifetime', 'int')
             ->setRequired('cache_item_pool')
-            ->setAllowedTypes('cache_item_pool', CacheItemPoolInterface::class);
+            ->setAllowedTypes('cache_item_pool', CacheItemPoolInterface::class)
+            ->setDefault('cache_item_lifetime', 86_400)
+            ->setAllowedTypes('cache_item_lifetime', 'int');
     }
 
     protected function getRequestUrl(string $rel, array $values = []): string
@@ -468,7 +491,7 @@ protected function createItemResult(ResponseInterface $response, string $class):
     {
         $item = new \SimpleXMLElement($response->getContent());
 
-        /** @var T */
+        /* @var T */
         return $class::fromSimpleXMLElement($item);
     }
 

src/Command/F2ApiClientCommand.php

@@ -5,6 +5,7 @@
 namespace ItkDev\F2ApiClient\Command;
 
 use ItkDev\F2ApiClient\Client\ApiClient;
+use ItkDev\F2ApiClient\Model\AbstractItem;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\Console\Attribute\Argument;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -80,7 +81,10 @@ private function createClient(?string $cacheDirectory): ApiClient
         return new ApiClient($config);
     }
 
-    private function responseToArray($response): array
+    /**
+     * @return array<string, mixed>
+     */
+    private function responseToArray(array|AbstractItem $response): array
     {
         // @mago-ignore analysis:invalid-type-cast
         return (array) json_decode(

src/Model/AbstractF2Item.php

@@ -15,8 +15,6 @@ abstract class AbstractF2Item extends AbstractItem implements \Stringable
     #[\Override]
     public function setFromSimpleXMLElement(\SimpleXMLElement $sxe): static
     {
-        parent::setFromSimpleXMLElement($sxe);
-
         $this->id = (int) $sxe->Id;
         $this->links = Links::fromSimpleXMLElement($sxe);
 
@@ -34,7 +32,7 @@ public function jsonSerialize(): array
     {
         return [
             'id' => $this->id,
-            'links' => $this->links?->jsonSerialize(),
+            'links' => $this->links->jsonSerialize(),
         ];
     }
 }

src/Model/AbstractItem.php

@@ -9,6 +9,7 @@ abstract class AbstractItem implements \JsonSerializable, \Stringable
     public static function fromSimpleXMLElement(\SimpleXMLElement $sxe): static
     {
         // @mago-ignore analysis:unsafe-instantiation
+        // @phpstan-ignore new.static
         return (new static())->setFromSimpleXMLElement($sxe);
     }
 
@@ -27,10 +28,8 @@ public function setFromSimpleXMLElement(\SimpleXMLElement $sxe): static
     protected static function listOf(string $class, \SimpleXMLElement $sxe): array
     {
         $items = [];
+        /** @var \SimpleXMLElement $child */
         foreach ($sxe as $child) {
-            if (!$child instanceof \SimpleXMLElement) {
-                continue;
-            }
             /** @var T $item */
             $item = $class::fromSimpleXMLElement($child);
             $items[] = $item;