fix: phpstan errors

Author: KondukterCRO

src/Definition/Encoding/DocumentDataToPhpArrayEncoderInterface.php

@@ -8,5 +8,6 @@
 
 interface DocumentDataToPhpArrayEncoderInterface
 {
+    /** @return null|array<mixed,mixed> */
     public function encode(DocumentDataInterface $documentData): ?array;
 }

src/Definition/Encoding/PhpArrayToAttributeCollectionEncoderInterface.php

@@ -8,5 +8,6 @@
 
 interface PhpArrayToAttributeCollectionEncoderInterface
 {
+    /** @param array<string,mixed> $attributes */
     public function encode(array $attributes): AttributeCollectionInterface;
 }

src/Definition/Encoding/PhpArrayToLinkCollectionEncoderInterface.php

@@ -8,5 +8,6 @@
 
 interface PhpArrayToLinkCollectionEncoderInterface
 {
+    /** @param array<string,string> $links */
     public function encode(array $links): LinkCollectionInterface;
 }

src/Definition/Encoding/ResourceIdentifierCollectionToPhpArrayEncoderInterface.php

@@ -8,5 +8,6 @@
 
 interface ResourceIdentifierCollectionToPhpArrayEncoderInterface
 {
-    public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection);
+    /** @return array<int,array<string,mixed>> */
+    public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection): array;
 }

src/Implementation/Encoding/DocumentDataToPhpArrayEncoder.php

@@ -37,7 +37,6 @@ public function __construct(
         $this->resourceIdentifierCollectionEncoder = $resourceIdentifierCollectionEncoder;
     }
 
-    /** @return array<mixed,mixed> */
     public function encode(DocumentDataInterface $documentData): ?array
     {
         if ($documentData->isResource()) {

src/Implementation/Encoding/PhpArrayToRelationshipCollectionEncoder.php

@@ -91,7 +91,7 @@ private function decodeRelationship(string $relationshipName, array $relationshi
     }
 
     /**
-     * @param null|array<int,array<string,string>> $resourceLinkage
+     * @param null|array<int|string,array<string,string>|string> $resourceLinkage
      *
      * @throws JsonApiEncodingException
      */
@@ -117,11 +117,13 @@ private function parseRelationshipData(?array $resourceLinkage): RelationshipDat
 
         $isAssociativeArray = ArrayUtil::isMap($resourceLinkage);
         if (false === $isAssociativeArray) {
+            /** @var array<int,array<string,string>> $resourceLinkage */
             $identifiersCollection = $this->parseResourceIdentifierCollection($resourceLinkage);
 
             return ToManyRelationshipData::make($identifiersCollection);
         }
-
+        // at this point we have not null to one relationship
+        /** @var array<string,string> $resourceLinkage */
         $resourceIdentifier = new ResourceIdentifier(
             $resourceLinkage['id'],
             $resourceLinkage['type'],
@@ -131,6 +133,7 @@ private function parseRelationshipData(?array $resourceLinkage): RelationshipDat
         return ToOneRelationshipData::make($resourceIdentifier);
     }
 
+    /** @param array<int, array<string,string>> $data */
     private function parseResourceIdentifierCollection(array $data): ResourceIdentifierCollection
     {
         $resourceIdentifiers = [];

src/Implementation/Encoding/ResourceIdentifierCollectionToPhpArrayEncoder.php

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

src/Implementation/Model/Document/DocumentData.php

@@ -53,25 +53,46 @@ public function isEmpty(): bool
 
     public function getResource(): ResourceInterface
     {
-        return $this->returnDataIfTrue($this->isResource(), 'Data is not Resource');
+        $data = $this->data;
+        if (true !== $this->isResource()) {
+            throw new DomainException('Data is not Resource');
+        }
+        /** @var ResourceInterface $data */
+
+        return $data;
     }
 
     public function getResourceCollection(): ResourceCollectionInterface
     {
-        return $this->returnDataIfTrue($this->isResourceCollection(), 'Data is not Resource Collection');
+        $data = $this->data;
+        if (true !== $this->isResourceCollection()) {
+            throw new DomainException('Data is not Resource Collection');
+        }
+        /** @var ResourceCollectionInterface $data */
+
+        return $data;
     }
 
     public function getResourceIdentifier(): ResourceIdentifierInterface
     {
-        return $this->returnDataIfTrue($this->isResourceIdentifier(), 'Data is not Resource Identifier');
+        $data = $this->data;
+        if (true !== $this->isResourceIdentifier()) {
+            throw new DomainException('Data is not Resource Identifier');
+        }
+        /** @var ResourceIdentifierInterface $data */
+
+        return $data;
     }
 
     public function getResourceIdentifierCollection(): ResourceIdentifierCollectionInterface
     {
-        return $this->returnDataIfTrue(
-            $this->isResourceIdentifierCollection(),
-            'Data is not Resource Identifier Collection'
-        );
+        $data = $this->data;
+        if (true !== $this->isResourceIdentifierCollection()) {
+            throw new DomainException('Data is not Resource Identifier Collection');
+        }
+        /** @var ResourceIdentifierCollectionInterface $data */
+
+        return $data;
     }
 
     /**
@@ -115,16 +136,4 @@ private function makeSureDataIsValid($data): void
 
         throw new InvalidArgumentException('Invalid data provided');
     }
-
-    /**
-     * @return null|ResourceCollection|ResourceIdentifierCollection|ResourceIdentifierInterface|ResourceInterface
-     */
-    private function returnDataIfTrue(bool $condition, string $errorMessage)
-    {
-        if (true !== $condition) {
-            throw new DomainException($errorMessage);
-        }
-
-        return $this->data;
-    }
 }

src/Util/ArrayUtil.php

@@ -11,7 +11,7 @@ abstract class ArrayUtil
 {
     /**
      * @param array<string,mixed> $array
-     * @param string[]            $requiredKeys
+     * @param array<int,string>   $requiredKeys
      */
     public static function hasRequiredKeys(array $array, array $requiredKeys): bool
     {
@@ -21,7 +21,7 @@ public static function hasRequiredKeys(array $array, array $requiredKeys): bool
     }
 
     /**
-     * @param array<string,mixed> $array
+     * @param array<int|string,array<string,string>|string> $array
      */
     public static function isMap(array $array): bool
     {

src/Util/Exception/ValidationException.php

@@ -15,12 +15,14 @@ class ValidationException extends Exception
      */
     private $value;
 
+    /** @var array<int,mixed> */
     private array $constraints;
 
     /**
      * ValidationException constructor.
      *
-     * @param mixed $value
+     * @param mixed            $value
+     * @param array<int,mixed> $constraints
      */
     public function __construct(
         string $message,
@@ -29,7 +31,7 @@ public function __construct(
         $value = null,
         array $constraints = []
     ) {
-        parent::__construct($message, $code);
+        parent::__construct($message, $code ?? 0);
 
         $this->propertyPath = $propertyPath;
         $this->value = $value;

src/Util/ValidResourceLinkageAssertion.php

@@ -15,7 +15,7 @@ class ValidResourceLinkageAssertion
      * - a single resource identifier object for non-empty to-one relationships.
      * - an array of resource identifier objects for non-empty to-many relationships.
      *
-     * @param null|array<string,string> $resourceLinkage
+     * @param null|array<int|string,array<string,string>|string> $resourceLinkage
      *
      * @throws ValidationException
      */
@@ -30,13 +30,15 @@ public static function assert(?array $resourceLinkage): void
         }
 
         if (false === ArrayUtil::isMap($resourceLinkage)) {
+            /** @var array<int,array<string,string>> $resourceLinkage */
             foreach ($resourceLinkage as $linkItem) {
                 ValidResourceIdentifierAssertion::assert($linkItem);
             }
 
             return;
         }
 
+        /** @var array<string,mixed> $resourceLinkage */
         ValidResourceIdentifierAssertion::assert($resourceLinkage);
     }
 }