refactor: update phpstan to max level

Author: Moirae

phpstan.neon

@@ -1,4 +1,4 @@
 parameters:
     paths:
         - src/
-    level: 6
+    level: max

src/Definition/Encoding/ErrorCollectionToPhpArrayEncoderInterface.php

@@ -8,6 +8,6 @@
 
 interface ErrorCollectionToPhpArrayEncoderInterface
 {
-    /** @return array<string,mixed> */
-    public function encode(ErrorCollectionInterface $errorCollection);
+    /** @return array<int,array<string,mixed>> */
+    public function encode(ErrorCollectionInterface $errorCollection): array;
 }

src/Definition/Encoding/LinkCollectionToPhpArrayEncoderInterface.php

@@ -8,5 +8,8 @@
 
 interface LinkCollectionToPhpArrayEncoderInterface
 {
+    /**
+     * @return array<string,mixed>
+     */
     public function encode(LinkCollectionInterface $linkCollection): array;
 }

src/Definition/Encoding/MetaToPhpArrayEncoderInterface.php

@@ -8,5 +8,6 @@
 
 interface MetaToPhpArrayEncoderInterface
 {
-    public function encode(MetaInterface $meta);
+    /** @return array<string,mixed> */
+    public function encode(MetaInterface $meta): array;
 }

src/Definition/Encoding/PhpArrayToMetaEncoderInterface.php

@@ -8,5 +8,6 @@
 
 interface PhpArrayToMetaEncoderInterface
 {
+    /** @param array<string,mixed> $meta */
     public function decode(array $meta): MetaInterface;
 }

src/Definition/Encoding/PhpArrayToRelationshipCollectionEncoderInterface.php

@@ -5,8 +5,14 @@
 namespace Undabot\JsonApi\Definition\Encoding;
 
 use Undabot\JsonApi\Definition\Model\Resource\Relationship\RelationshipCollectionInterface;
+use Undabot\JsonApi\Implementation\Encoding\Exception\JsonApiEncodingException;
 
 interface PhpArrayToRelationshipCollectionEncoderInterface
 {
+    /**
+     * @param array<string,array<string,mixed>> $relationships
+     *
+     * @throws JsonApiEncodingException
+     */
     public function encode(array $relationships): RelationshipCollectionInterface;
 }

src/Definition/Encoding/PhpArrayToResourceEncoderInterface.php

@@ -10,6 +10,8 @@
 interface PhpArrayToResourceEncoderInterface
 {
     /**
+     * @param array<string,mixed> $resource
+     *
      * @throws JsonApiEncodingException
      */
     public function decode(array $resource): ResourceInterface;

src/Definition/Encoding/ResourceCollectionToPhpArrayEncoderInterface.php

@@ -8,5 +8,6 @@
 
 interface ResourceCollectionToPhpArrayEncoderInterface
 {
+    /** @return array<int,array<string,mixed>> */
     public function encode(ResourceCollectionInterface $resource);
 }

src/Definition/Encoding/ResourceIdentifierToPhpArrayEncoderInterface.php

@@ -8,5 +8,6 @@
 
 interface ResourceIdentifierToPhpArrayEncoderInterface
 {
+    /** @return array<string,mixed> */
     public function encode(ResourceIdentifierInterface $resourceIdentifier);
 }

src/Definition/Model/Meta/MetaInterface.php

@@ -6,5 +6,6 @@
 
 interface MetaInterface
 {
+    /** @return array<string,mixed> */
     public function getData(): array;
 }

src/Definition/Model/Request/GetResourceCollectionRequestInterface.php

@@ -14,10 +14,16 @@
 
 interface GetResourceCollectionRequestInterface
 {
+    /**
+     * @return null|array<int,mixed>
+     */
     public function getIncludes(): ?array;
 
     public function isIncluded(string $name): bool;
 
+    /**
+     * @return null|array<int,mixed>
+     */
     public function getSparseFieldset(): ?array;
 
     public function getFilterSet(): ?FilterSet;

src/Definition/Model/Request/GetResourceRequestInterface.php

@@ -11,10 +11,20 @@ interface GetResourceRequestInterface
 {
     public function getId(): string;
 
+    /**
+     * @todo change definition after interface implementation
+     *
+     * @return null|array<mixed>
+     */
     public function getIncludes(): ?array;
 
     public function isIncluded(string $name): bool;
 
+    /**
+     * @todo change definition after interface implementation
+     *
+     * @return null|array<mixed>
+     */
     public function getSparseFieldset(): ?array;
 
     /**

src/Definition/Model/Resource/Attribute/AttributeInterface.php

@@ -8,5 +8,5 @@ interface AttributeInterface
 {
     public function getName(): string;
 
-    public function getValue();
+    public function getValue(): mixed;
 }

src/Implementation/Encoding/ErrorCollectionToPhpArrayEncoder.php

@@ -19,7 +19,7 @@ public function __construct(ErrorToPhpArrayEncoderInterface $errorEncoder)
         $this->errorEncoder = $errorEncoder;
     }
 
-    /** @return array<string,mixed> */
+    /** @return array<int,array<string,mixed>> */
     public function encode(ErrorCollectionInterface $errorCollection): array
     {
         $serializedErrors = [];

src/Implementation/Encoding/LinkCollectionToPhpArrayEncoder.php

@@ -19,6 +19,9 @@ public function __construct(LinkToPhpArrayEncoderInterface $linkEncoder)
         $this->linkEncoder = $linkEncoder;
     }
 
+    /**
+     * @return array<string,mixed>
+     */
     public function encode(LinkCollectionInterface $linkCollection): array
     {
         $links = [];

src/Implementation/Encoding/MetaToPhpArrayEncoder.php

@@ -9,6 +9,7 @@
 
 class MetaToPhpArrayEncoder implements MetaToPhpArrayEncoderInterface
 {
+    /** @return array<string,mixed> */
     public function encode(MetaInterface $meta): array
     {
         return $meta->getData();

src/Implementation/Encoding/PhpArrayToMetaEncoder.php

@@ -10,6 +10,7 @@
 
 class PhpArrayToMetaEncoder implements PhpArrayToMetaEncoderInterface
 {
+    /** @param array<string,mixed> $meta */
     public function decode(array $meta): MetaInterface
     {
         return new Meta($meta);

src/Implementation/Encoding/PhpArrayToRelationshipCollectionEncoder.php

@@ -32,6 +32,8 @@ public function __construct(
     }
 
     /**
+     * @param array<string,array<string,mixed>> $relationships
+     *
      * @throws JsonApiEncodingException
      */
     public function encode(array $relationships): RelationshipCollectionInterface
@@ -48,6 +50,8 @@ public function encode(array $relationships): RelationshipCollectionInterface
     }
 
     /**
+     * @param array<string,mixed> $relationshipValue
+     *
      * @throws JsonApiEncodingException
      */
     private function decodeRelationship(string $relationshipName, array $relationshipValue): Relationship

src/Implementation/Encoding/PhpArrayToResourceEncoder.php

@@ -37,6 +37,8 @@ public function __construct(
     }
 
     /**
+     * @param array<string,mixed> $resource
+     *
      * @throws JsonApiEncodingException
      */
     public function decode(array $resource): ResourceInterface
@@ -69,6 +71,9 @@ public function decode(array $resource): ResourceInterface
         );
     }
 
+    /**
+     * @param null|array<string,mixed> $rawMeta
+     */
     private function parseMeta(?array $rawMeta): ?MetaInterface
     {
         if (null === $rawMeta) {

src/Implementation/Encoding/RelationshipToPhpArrayEncoder.php

@@ -57,6 +57,9 @@ public function encode(RelationshipInterface $relationship): array
         return $serializedRelationship;
     }
 
+    /**
+     * @return null|array<mixed,mixed>
+     */
     private function encodeRelationshipData(?RelationshipDataInterface $data): ?array
     {
         if ($data instanceof ToOneRelationshipDataInterface) {
@@ -71,7 +74,10 @@ private function encodeRelationshipData(?RelationshipDataInterface $data): ?arra
         throw new DomainException('Invalid relationship data');
     }
 
-    private function encodeToOneRelationshipData(ToOneRelationshipDataInterface $data)
+    /**
+     * @return null|array<string,mixed>
+     */
+    private function encodeToOneRelationshipData(ToOneRelationshipDataInterface $data): ?array
     {
         if (null === $data->getData()) {
             return null;
@@ -80,7 +86,10 @@ private function encodeToOneRelationshipData(ToOneRelationshipDataInterface $dat
         return $this->resourceIdentifierToPhpArrayEncoder->encode($data->getData());
     }
 
-    private function encodeToManyRelationshipData(ToManyRelationshipDataInterface $data)
+    /**
+     * @return array<int,array<string,mixed>>
+     */
+    private function encodeToManyRelationshipData(ToManyRelationshipDataInterface $data): array
     {
         if ($data->isEmpty()) {
             return [];

src/Implementation/Encoding/ResourceCollectionToPhpArrayEncoder.php

@@ -18,6 +18,7 @@ public function __construct(ResourceToPhpArrayEncoderInterface $resourceToPhpArr
         $this->resourceToPhpArrayEncoder = $resourceToPhpArrayEncoder;
     }
 
+    /** @return array<int,array<string,mixed>> */
     public function encode(ResourceCollectionInterface $resourceCollection): array
     {
         $resources = [];

src/Implementation/Encoding/ResourceIdentifierCollectionToPhpArrayEncoder.php

@@ -18,6 +18,9 @@ public function __construct(ResourceIdentifierToPhpArrayEncoderInterface $resour
         $this->resourceIdentifierToPhpArrayEncoder = $resourceIdentifierToPhpArrayEncoder;
     }
 
+    /**
+     * @return array<int,array<string,mixed>>
+     */
     public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection): array
     {
         $resourceIdentifiers = [];

src/Implementation/Encoding/ResourceIdentifierToPhpArrayEncoder.php

@@ -18,6 +18,7 @@ public function __construct(MetaToPhpArrayEncoderInterface $metaToPhpArrayEncode
         $this->metaToPhpArrayEncoder = $metaToPhpArrayEncoder;
     }
 
+    /** @return array<string,mixed> */
     public function encode(ResourceIdentifierInterface $resourceIdentifier)
     {
         $serializedResourceIdentifier = [

src/Implementation/Model/Error/ErrorCollection.php

@@ -5,6 +5,8 @@
 namespace Undabot\JsonApi\Implementation\Model\Error;
 
 use ArrayIterator;
+use Assert\Assertion;
+use Assert\AssertionFailedException;
 use InvalidArgumentException;
 use Undabot\JsonApi\Definition\Model\Error\ErrorCollectionInterface;
 use Undabot\JsonApi\Definition\Model\Error\ErrorInterface;
@@ -17,7 +19,13 @@ final class ErrorCollection implements ErrorCollectionInterface
     /** @param ErrorInterface[] $errors */
     public function __construct(array $errors)
     {
-        $this->makeSureAllErrorsAreValid($errors);
+        try {
+            Assertion::allIsInstanceOf($errors, ErrorInterface::class);
+        } catch (AssertionFailedException $exception) {
+//            $message = sprintf('ResourceIdentifierInterface expected, %s given', \get_class($resourceIdentifier));
+//
+//            throw new InvalidArgumentException($message);
+        }
         $this->errors = $errors;
     }
 
@@ -36,16 +44,4 @@ public function getIterator(): ArrayIterator
     {
         return new ArrayIterator($this->getErrors());
     }
-
-    /** @param ErrorInterface[] $errors */
-    private function makeSureAllErrorsAreValid(array $errors): void
-    {
-        foreach ($errors as $error) {
-            if (false === ($error instanceof ErrorInterface)) {
-                $message = sprintf('Error expected, %s given', \get_class($error));
-
-                throw new InvalidArgumentException($message);
-            }
-        }
-    }
 }

src/Implementation/Model/Meta/Meta.php

@@ -8,14 +8,16 @@
 
 class Meta implements MetaInterface
 {
-    /** @var array */
+    /** @var array<string,mixed> */
     private $data = [];
 
+    /** @param array<string,mixed> $data */
     public function __construct(array $data)
     {
         $this->data = $data;
     }
 
+    /** @return array<string,mixed> */
     public function getData(): array
     {
         return $this->data;

src/Implementation/Model/Resource/ResourceCollection.php

@@ -5,6 +5,8 @@
 namespace Undabot\JsonApi\Implementation\Model\Resource;
 
 use ArrayIterator;
+use Assert\Assertion;
+use Assert\AssertionFailedException;
 use InvalidArgumentException;
 use Undabot\JsonApi\Definition\Model\Resource\ResourceCollectionInterface;
 use Undabot\JsonApi\Definition\Model\Resource\ResourceInterface;
@@ -17,7 +19,13 @@ final class ResourceCollection implements ResourceCollectionInterface
     /** @param ResourceInterface[] $resources */
     public function __construct(array $resources)
     {
-        $this->makeSureResourcesAreValid($resources);
+        try {
+            Assertion::allIsInstanceOf($resources, ResourceInterface::class);
+        } catch (AssertionFailedException $exception) {
+//            $message = sprintf('ResourceIdentifierInterface expected, %s given', \get_class($resourceIdentifier));
+//
+//            throw new InvalidArgumentException($message);
+        }
         $this->resources = $resources;
     }
 
@@ -36,16 +44,4 @@ public function getIterator(): ArrayIterator
     {
         return new ArrayIterator($this->getResources());
     }
-
-    /** @param ResourceInterface[] $resources */
-    private function makeSureResourcesAreValid(array $resources): void
-    {
-        foreach ($resources as $resource) {
-            if (false === ($resource instanceof ResourceInterface)) {
-                $message = sprintf('ResourceInterface expected, %s given', \get_class($resource));
-
-                throw new InvalidArgumentException($message);
-            }
-        }
-    }
 }