refactor: update stan to lvl6

Author: Moirae

phpstan.neon

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

src/Definition/Encoding/AttributeCollectionToPhpArrayEncoderInterface.php

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

src/Definition/Encoding/DocumentDataToPhpArrayEncoderInterface.php

@@ -8,5 +8,5 @@
 
 interface DocumentDataToPhpArrayEncoderInterface
 {
-    public function encode(DocumentDataInterface $documentData);
+    public function encode(DocumentDataInterface $documentData): ?array;
 }

src/Definition/Encoding/DocumentToPhpArrayEncoderInterface.php

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

src/Definition/Encoding/ErrorCollectionToPhpArrayEncoderInterface.php

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

src/Definition/Encoding/ErrorToPhpArrayEncoderInterface.php

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

src/Definition/Encoding/LinkToPhpArrayEncoderInterface.php

@@ -8,5 +8,8 @@
 
 interface LinkToPhpArrayEncoderInterface
 {
+    /**
+     * @return null|array<string,mixed>|string
+     */
     public function encode(LinkInterface $link);
 }

src/Definition/Encoding/RelationshipCollectionToPhpArrayEncoderInterface.php

@@ -8,5 +8,8 @@
 
 interface RelationshipCollectionToPhpArrayEncoderInterface
 {
+    /**
+     * @return array<string,mixed>
+     */
     public function encode(RelationshipCollectionInterface $relationship);
 }

src/Definition/Encoding/RelationshipToPhpArrayEncoderInterface.php

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

src/Definition/Encoding/ResourceToPhpArrayEncoderInterface.php

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

src/Definition/Encoding/SourceToPhpArrayEncoderInterface.php

@@ -8,5 +8,8 @@
 
 interface SourceToPhpArrayEncoderInterface
 {
-    public function encode(SourceInterface $source);
+    /**
+     * @return array<string,null|string>
+     */
+    public function encode(SourceInterface $source): array;
 }

src/Definition/Exception/Request/UnsupportedFilterAttributeGivenException.php

@@ -8,10 +8,13 @@
 
 class UnsupportedFilterAttributeGivenException extends RequestException
 {
+    /**
+     * @param string[] $unsupportedFilters
+     */
     public function __construct(
         array $unsupportedFilters,
         ?string $message = null,
-        $code = 0,
+        int $code = 0,
         Throwable $previous = null
     ) {
         if (null === $message) {

src/Definition/Exception/Request/UnsupportedIncludeValuesGivenException.php

@@ -8,10 +8,13 @@
 
 class UnsupportedIncludeValuesGivenException extends RequestException
 {
+    /**
+     * @param string[] $unsupportedIncludes
+     */
     public function __construct(
         array $unsupportedIncludes,
         ?string $message = null,
-        $code = 0,
+        int $code = 0,
         Throwable $previous = null
     ) {
         if (null === $message) {

src/Definition/Exception/Request/UnsupportedSortRequestedException.php

@@ -8,8 +8,15 @@
 
 class UnsupportedSortRequestedException extends RequestException
 {
-    public function __construct(array $unsupportedSorts, ?string $message = null, $code = 0, Throwable $previous = null)
-    {
+    /**
+     * @param string[] $unsupportedSorts
+     */
+    public function __construct(
+        array $unsupportedSorts,
+        ?string $message = null,
+        int $code = 0,
+        Throwable $previous = null
+    ) {
         if (null === $message) {
             $message = sprintf(
                 'Unsupported sort query params given: `%s`',

src/Definition/Exception/Request/UnsupportedSparseFieldsetRequestedException.php

@@ -8,10 +8,13 @@
 
 class UnsupportedSparseFieldsetRequestedException extends RequestException
 {
+    /**
+     * @param string[] $unsupportedIncludes
+     */
     public function __construct(
         array $unsupportedIncludes,
         ?string $message = null,
-        $code = 0,
+        int $code = 0,
         Throwable $previous = null
     ) {
         if (null === $message) {

src/Definition/Model/Error/ErrorCollectionInterface.php

@@ -6,7 +6,11 @@
 
 use IteratorAggregate;
 
+/**
+ * @extends IteratorAggregate<int,ErrorInterface>
+ */
 interface ErrorCollectionInterface extends IteratorAggregate
 {
+    /** @return ErrorInterface[] */
     public function getErrors(): array;
 }

src/Definition/Model/Link/LinkCollectionInterface.php

@@ -6,13 +6,18 @@
 
 use IteratorAggregate;
 
+/**
+ * @extends IteratorAggregate<int,LinkInterface>
+ */
 interface LinkCollectionInterface extends IteratorAggregate
 {
     public function hasLink(string $linkName): bool;
 
     public function getLink(string $linkName): ?LinkInterface;
 
+    /** @return string[] */
     public function getLinkNames(): array;
 
+    /** @return LinkInterface[] */
     public function getLinks(): array;
 }

src/Definition/Model/Link/LinkNamesEnum.php

@@ -17,6 +17,7 @@ abstract class LinkNamesEnum
     public const LINK_NAME_PAGINATION_PREV = 'prev';
     public const LINK_NAME_PAGINATION_NEXT = 'next';
 
+    /** @return array<string,mixed> */
     public static function getValues(): array
     {
         $oClass = new ReflectionClass(__CLASS__);

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

@@ -6,8 +6,12 @@
 
 use IteratorAggregate;
 
+/**
+ * @extends IteratorAggregate<int,AttributeInterface>
+ */
 interface AttributeCollectionInterface extends IteratorAggregate
 {
+    /** @return AttributeInterface[] */
     public function getAttributes(): array;
 
     public function getAttributeByName(string $name): ?AttributeInterface;

src/Definition/Model/Resource/Relationship/RelationshipCollectionInterface.php

@@ -6,8 +6,14 @@
 
 use IteratorAggregate;
 
+/**
+ * @extends IteratorAggregate<int,RelationshipInterface>
+ */
 interface RelationshipCollectionInterface extends IteratorAggregate
 {
+    /**
+     * @return RelationshipInterface[]
+     */
     public function getRelationships(): array;
 
     public function getRelationshipByName(string $name): ?RelationshipInterface;

src/Definition/Model/Resource/ResourceCollectionInterface.php

@@ -6,7 +6,13 @@
 
 use IteratorAggregate;
 
+/**
+ * @extends IteratorAggregate<int,ResourceInterface>
+ */
 interface ResourceCollectionInterface extends IteratorAggregate
 {
+    /**
+     * @return ResourceInterface[] $resources
+     */
     public function getResources(): array;
 }

src/Definition/Model/Resource/ResourceIdentifierCollectionInterface.php

@@ -6,7 +6,13 @@
 
 use IteratorAggregate;
 
+/**
+ * @extends IteratorAggregate<int,ResourceIdentifierInterface>
+ */
 interface ResourceIdentifierCollectionInterface extends IteratorAggregate
 {
+    /**
+     * @return ResourceIdentifierInterface[]
+     */
     public function getResourceIdentifiers(): array;
 }

src/Implementation/Encoding/DocumentToPhpArrayEncoder.php

@@ -43,6 +43,7 @@ public function __construct(
         $this->resourceCollectionEncoder = $resourceCollectionEncoder;
     }
 
+    /** @return array<string,mixed> */
     public function encode(DocumentInterface $document): array
     {
         $serializedDocument = [];

src/Implementation/Encoding/ErrorCollectionToPhpArrayEncoder.php

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

src/Implementation/Encoding/ErrorToPhpArrayEncoder.php

@@ -31,6 +31,7 @@ public function __construct(
         $this->metaEncoder = $metaEncoder;
     }
 
+    /** @return array<string,mixed> */
     public function encode(ErrorInterface $error): array
     {
         $serializedError = [];

src/Implementation/Encoding/LinkToPhpArrayEncoder.php

@@ -11,16 +11,15 @@
 
 class LinkToPhpArrayEncoder implements LinkToPhpArrayEncoderInterface
 {
-    /** @var MetaToPhpArrayEncoder */
-    private $metaToPhpArrayEncoder;
+    private MetaToPhpArrayEncoder $metaToPhpArrayEncoder;
 
     public function __construct(MetaToPhpArrayEncoder $metaToPhpArrayEncoder)
     {
         $this->metaToPhpArrayEncoder = $metaToPhpArrayEncoder;
     }
 
     /**
-     * @return null|array|string
+     * @return null|array<string,mixed>|string
      */
     public function encode(LinkInterface $link)
     {
@@ -40,6 +39,9 @@ public function encode(LinkInterface $link)
         return null;
     }
 
+    /**
+     * @return array<string,mixed>
+     */
     private function encodeLinkObject(LinkObject $linkObject): array
     {
         $serializedLinkObject = [];

src/Implementation/Encoding/RelationshipCollectionToPhpArrayEncoder.php

@@ -19,6 +19,9 @@ public function __construct(RelationshipToPhpArrayEncoderInterface $relationship
         $this->relationshipToPhpArrayEncoder = $relationshipToPhpArrayEncoder;
     }
 
+    /**
+     * @return array<string,mixed>
+     */
     public function encode(RelationshipCollectionInterface $relationshipCollection): array
     {
         $relationships = [];

src/Implementation/Encoding/RelationshipToPhpArrayEncoder.php

@@ -35,6 +35,9 @@ public function __construct(
         $this->resourceIdentifierToPhpArrayEncoder = $resourceIdentifierToPhpArrayEncoder;
     }
 
+    /**
+     * @return array<string,mixed>
+     */
     public function encode(RelationshipInterface $relationship): array
     {
         $serializedRelationship = [];

src/Implementation/Encoding/ResourceToPhpArrayEncoder.php

@@ -37,6 +37,7 @@ public function __construct(
         $this->attributeCollectionEncoder = $attributeCollectionEncoder;
     }
 
+    /** @return array<string,mixed> */
     public function encode(ResourceInterface $resource): array
     {
         $serializedResource = [

src/Implementation/Encoding/SourceToPhpArrayEncoder.php

@@ -9,6 +9,9 @@
 
 class SourceToPhpArrayEncoder implements SourceToPhpArrayEncoderInterface
 {
+    /**
+     * @return array<string,null|string>
+     */
     public function encode(SourceInterface $source): array
     {
         $serializedSource = [];

src/Implementation/Factory/RelationshipDataFactory.php

@@ -13,8 +13,14 @@
 
 class RelationshipDataFactory
 {
-    public function make(string $type, bool $toMany, $data): ?RelationshipDataInterface
-    {
+    /**
+     * @param null|string|string[] $data
+     */
+    public function make(
+        string $type,
+        bool $toMany,
+        $data
+    ): ?RelationshipDataInterface {
         if (null === $data && true === $toMany) {
             return ToManyRelationshipData::makeEmpty();
         }

src/Implementation/Model/Document/Document.php

@@ -16,23 +16,17 @@
 
 class Document implements DocumentInterface
 {
-    /** @var null|DocumentDataInterface */
-    private $data;
+    private ?DocumentDataInterface $data;
 
-    /** @var null|ErrorCollectionInterface */
-    private $errors;
+    private ?ErrorCollectionInterface $errors;
 
-    /** @var null|MetaInterface */
-    private $meta;
+    private ?MetaInterface $meta;
 
-    /** @var null|MetaInterface */
-    private $jsonApiMeta;
+    private ?MetaInterface $jsonApiMeta;
 
-    /** @var null|LinkCollectionInterface */
-    private $links;
+    private ?LinkCollectionInterface $links;
 
-    /** @var null|ResourceCollectionInterface */
-    private $included;
+    private ?ResourceCollectionInterface $included;
 
     public function __construct(
         ?DocumentDataInterface $data,