fix: phpstan errors

KondukterCRO · KondukterCRO · commit 498f568461f6 · 2022-02-09T13:24:45.000+01:00
diff --git a/src/Definition/Encoding/DocumentDataToPhpArrayEncoderInterface.php b/src/Definition/Encoding/DocumentDataToPhpArrayEncoderInterface.php
@@ -8,5 +8,6 @@
 
 interface DocumentDataToPhpArrayEncoderInterface
 {
+    /** @return null|array<mixed,mixed> */
     public function encode(DocumentDataInterface $documentData): ?array;
 }
diff --git a/src/Definition/Encoding/PhpArrayToAttributeCollectionEncoderInterface.php b/src/Definition/Encoding/PhpArrayToAttributeCollectionEncoderInterface.php
@@ -8,5 +8,6 @@
 
 interface PhpArrayToAttributeCollectionEncoderInterface
 {
+    /** @param array<string,mixed> $attributes */
     public function encode(array $attributes): AttributeCollectionInterface;
 }
diff --git a/src/Definition/Encoding/PhpArrayToLinkCollectionEncoderInterface.php b/src/Definition/Encoding/PhpArrayToLinkCollectionEncoderInterface.php
@@ -8,5 +8,6 @@
 
 interface PhpArrayToLinkCollectionEncoderInterface
 {
+    /** @param array<string,string> $links */
     public function encode(array $links): LinkCollectionInterface;
 }
diff --git a/src/Definition/Encoding/ResourceIdentifierCollectionToPhpArrayEncoderInterface.php b/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;
 }
diff --git a/src/Implementation/Encoding/DocumentDataToPhpArrayEncoder.php b/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()) {
diff --git a/src/Implementation/Encoding/PhpArrayToRelationshipCollectionEncoder.php b/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 = [];
diff --git a/src/Implementation/Encoding/ResourceIdentifierCollectionToPhpArrayEncoder.php b/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 = [];
diff --git a/src/Implementation/Model/Document/DocumentData.php b/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;
-    }
 }
diff --git a/src/Util/ArrayUtil.php b/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
     {
diff --git a/src/Util/Exception/ValidationException.php b/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;
diff --git a/src/Util/ValidResourceLinkageAssertion.php b/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);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@`
`8`	`8`
`9`	`9`	`interface DocumentDataToPhpArrayEncoderInterface`
`10`	`10`	`{`
	`11`	`+ /** @return null\|array<mixed,mixed> */`
`11`	`12`	`public function encode(DocumentDataInterface $documentData): ?array;`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@`
`8`	`8`
`9`	`9`	`interface PhpArrayToAttributeCollectionEncoderInterface`
`10`	`10`	`{`
	`11`	`+ /** @param array<string,mixed> $attributes */`
`11`	`12`	`public function encode(array $attributes): AttributeCollectionInterface;`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@`
`8`	`8`
`9`	`9`	`interface PhpArrayToLinkCollectionEncoderInterface`
`10`	`10`	`{`
	`11`	`+ /** @param array<string,string> $links */`
`11`	`12`	`public function encode(array $links): LinkCollectionInterface;`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@`
`8`	`8`
`9`	`9`	`interface ResourceIdentifierCollectionToPhpArrayEncoderInterface`
`10`	`10`	`{`
`11`		`- public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection);`
	`11`	`+ /** @return array<int,array<string,mixed>> */`
	`12`	`+ public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection): array;`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,6 @@ public function __construct(`
`37`	`37`	`$this->resourceIdentifierCollectionEncoder = $resourceIdentifierCollectionEncoder;`
`38`	`38`	`}`
`39`	`39`
`40`		`- /** @return array<mixed,mixed> */`
`41`	`40`	`public function encode(DocumentDataInterface $documentData): ?array`
`42`	`41`	`{`
`43`	`42`	`if ($documentData->isResource()) {`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ private function decodeRelationship(string $relationshipName, array $relationshi`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`/**`
`94`		`- * @param null\|array<int,array<string,string>> $resourceLinkage`
	`94`	`+ * @param null\|array<int\|string,array<string,string>\|string> $resourceLinkage`
`95`	`95`	`*`
`96`	`96`	`* @throws JsonApiEncodingException`
`97`	`97`	`*/`
`@@ -117,11 +117,13 @@ private function parseRelationshipData(?array $resourceLinkage): RelationshipDat`
`117`	`117`
`118`	`118`	`$isAssociativeArray = ArrayUtil::isMap($resourceLinkage);`
`119`	`119`	`if (false === $isAssociativeArray) {`
	`120`	`+ /** @var array<int,array<string,string>> $resourceLinkage */`
`120`	`121`	`$identifiersCollection = $this->parseResourceIdentifierCollection($resourceLinkage);`
`121`	`122`
`122`	`123`	`return ToManyRelationshipData::make($identifiersCollection);`
`123`	`124`	`}`
`124`		`-`
	`125`	`+ // at this point we have not null to one relationship`
	`126`	`+ /** @var array<string,string> $resourceLinkage */`
`125`	`127`	`$resourceIdentifier = new ResourceIdentifier(`
`126`	`128`	`$resourceLinkage['id'],`
`127`	`129`	`$resourceLinkage['type'],`
`@@ -131,6 +133,7 @@ private function parseRelationshipData(?array $resourceLinkage): RelationshipDat`
`131`	`133`	`return ToOneRelationshipData::make($resourceIdentifier);`
`132`	`134`	`}`
`133`	`135`
	`136`	`+ /** @param array<int, array<string,string>> $data */`
`134`	`137`	`private function parseResourceIdentifierCollection(array $data): ResourceIdentifierCollection`
`135`	`138`	`{`
`136`	`139`	`$resourceIdentifiers = [];`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,7 @@ public function __construct(ResourceIdentifierToPhpArrayEncoderInterface $resour`
`18`	`18`	`$this->resourceIdentifierToPhpArrayEncoder = $resourceIdentifierToPhpArrayEncoder;`
`19`	`19`	`}`
`20`	`20`
`21`		`- /**`
`22`		`- * @return array<int,array<string,mixed>>`
`23`		`- */`
	`21`	`+ /** @return array<int,array<string,mixed>> */`
`24`	`22`	`public function encode(ResourceIdentifierCollectionInterface $resourceIdentifierCollection): array`
`25`	`23`	`{`
`26`	`24`	`$resourceIdentifiers = [];`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ abstract class ArrayUtil`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`	`13`	`* @param array<string,mixed> $array`
`14`		`- * @param string[] $requiredKeys`
	`14`	`+ * @param array<int,string> $requiredKeys`
`15`	`15`	`*/`
`16`	`16`	`public static function hasRequiredKeys(array $array, array $requiredKeys): bool`
`17`	`17`	`{`
`@@ -21,7 +21,7 @@ public static function hasRequiredKeys(array $array, array $requiredKeys): bool`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * @param array<string,mixed> $array`
	`24`	`+ * @param array<int\|string,array<string,string>\|string> $array`
`25`	`25`	`*/`
`26`	`26`	`public static function isMap(array $array): bool`
`27`	`27`	`{`