Declare typed properties

woohoolabs · Aug 15, 2023 · 9474619 · 9474619
1 parent b8b12bc
commit 9474619
Show file tree

Hide file tree

Showing 25 changed files with 117 additions and 313 deletions.
diff --git a/src/JsonApi/Client/JsonApiAsyncClient.php b/src/JsonApi/Client/JsonApiAsyncClient.php
@@ -10,10 +10,7 @@
 
 class JsonApiAsyncClient
 {
-    /**
-     * @var HttpAsyncClient
-     */
-    private $client;
+    private HttpAsyncClient $client;
 
     public function __construct(HttpAsyncClient $client)
     {

diff --git a/src/JsonApi/Client/JsonApiClient.php b/src/JsonApi/Client/JsonApiClient.php
@@ -16,11 +16,7 @@ class JsonApiClient
      * @var ClientInterface
      */
     private $client;
-
-    /**
-     * @var DeserializerInterface
-     */
-    private $deserializer;
+    private DeserializerInterface $deserializer;
 
     public function __construct(ClientInterface $client, ?DeserializerInterface $deserializer = null)
     {

diff --git a/src/JsonApi/Hydrator/AbstractClassDocumentHydrator.php b/src/JsonApi/Hydrator/AbstractClassDocumentHydrator.php
@@ -53,10 +53,7 @@ public function hydrateCollection(Document $document): iterable
         return $this->hydratePrimaryResources($document);
     }
 
-    /**
-     * @return object
-     */
-    public function hydrateSingleResource(Document $document)
+    public function hydrateSingleResource(Document $document): object
     {
         if ($document->isSingleResourceDocument() === false) {
             throw new DocumentException(

diff --git a/src/JsonApi/Hydrator/ClassDocumentHydrator.php b/src/JsonApi/Hydrator/ClassDocumentHydrator.php
@@ -11,10 +11,7 @@
 
 class ClassDocumentHydrator extends AbstractClassDocumentHydrator
 {
-    /**
-     * @var AttributeHydratorInterface
-     */
-    private $attributeHydrator;
+    private AttributeHydratorInterface $attributeHydrator;
 
     public function __construct(?AttributeHydratorInterface $attributeHydrator = null)
     {

diff --git a/src/JsonApi/Request/JsonApiRequestBuilder.php b/src/JsonApi/Request/JsonApiRequestBuilder.php
@@ -18,45 +18,20 @@
 
 class JsonApiRequestBuilder
 {
-    /** @var RequestInterface */
-    private $request;
-
-    /** @var SerializerInterface */
-    private $serializer;
-
-    /** @var string */
-    private $method;
-
-    /** @var string */
-    private $protocolVersion;
-
-    /** @var string */
-    private $scheme;
-
-    /** @var string */
-    private $host;
-
-    /** @var int */
-    private $port;
-
-    /** @var string */
-    private $path;
-
-    /** @var array */
-    private $queryString;
-
-    /** @var array */
-    private $headers;
-
+    private RequestInterface $request;
+    private SerializerInterface $serializer;
+    private string $method;
+    private string $protocolVersion;
+    private string $scheme;
+    private string $host;
+    private ?int $port;
+    private string $path;
+    private array $queryString;
+    private array $headers;
     /** @var string[] */
-    private $appliedProfiles;
-
+    private array $appliedProfiles;
     /** @var string[] */
-    private $requestedProfiles;
-
-    /** @var string[] */
-    private $requiredProfiles;
-
+    private array $requestedProfiles;
     /** @var mixed */
     private $body;
 
@@ -73,12 +48,12 @@ public function initialize(): void
         $this->protocolVersion = "";
         $this->scheme = "http";
         $this->host = "";
+        $this->port = null;
         $this->path = "";
         $this->queryString = [];
         $this->headers = [];
         $this->appliedProfiles = [];
         $this->requestedProfiles = [];
-        $this->requiredProfiles = [];
     }
 
     public function fetch(): JsonApiRequestBuilder
@@ -134,23 +109,23 @@ public function setUri(string $uri): JsonApiRequestBuilder
         }
 
         if ($this->isBlankKey($parsedUri, "scheme") === false) {
-            $this->scheme = $parsedUri["scheme"];
+            $this->scheme = $parsedUri["scheme"] ?? "";
         }
 
         if ($this->isBlankKey($parsedUri, "port") === false) {
-            $this->port = $parsedUri["port"];
+            $this->port = $parsedUri["port"] ?? null;
         }
 
         if ($this->isBlankKey($parsedUri, "host") === false) {
-            $this->host = $parsedUri["host"];
+            $this->host = $parsedUri["host"] ?? "";
         }
 
         if ($this->isBlankKey($parsedUri, "path") === false) {
-            $this->path = $parsedUri["path"];
+            $this->path = $parsedUri["path"] ?? "";
         }
 
         if ($this->isBlankKey($parsedUri, "query") === false) {
-            parse_str($parsedUri["query"], $this->queryString);
+            parse_str($parsedUri["query"] ?? "", $this->queryString);
         }
 
         return $this;
@@ -170,7 +145,7 @@ public function setUriHost(string $host): JsonApiRequestBuilder
         return $this;
     }
 
-    public function setUriPort(int $port): JsonApiRequestBuilder
+    public function setUriPort(?int $port): JsonApiRequestBuilder
     {
         $this->port = $port;
 
@@ -185,7 +160,7 @@ public function setUriPath(string $path): JsonApiRequestBuilder
     }
 
     /**
-     * @param string|array $value
+     * @param string|array<int|string, mixed> $value
      */
     public function setUriQueryParam(string $name, $value): JsonApiRequestBuilder
     {

diff --git a/src/JsonApi/Request/ResourceObject.php b/src/JsonApi/Request/ResourceObject.php
@@ -6,25 +6,12 @@
 
 class ResourceObject
 {
-    /**
-     * @var string
-     */
-    private $type;
-
-    /**
-     * @var string
-     */
-    private $id;
-
-    /**
-     * @var array
-     */
-    private $attributes;
-
-    /**
-     * @var RelationshipInterface[]
-     */
-    private $relationships;
+    private string $type;
+    private string $id;
+    /** @var array<string, mixed> */
+    private array $attributes;
+    /** @var array<string, RelationshipInterface> */
+    private array $relationships;
 
     public static function create(string $type, string $id = ""): ResourceObject
     {

diff --git a/src/JsonApi/Request/ToManyRelationship.php b/src/JsonApi/Request/ToManyRelationship.php
@@ -6,10 +6,7 @@
 
 final class ToManyRelationship implements RelationshipInterface
 {
-    /**
-     * @var array
-     */
-    private $resourceIdentifiers = [];
+    private array $resourceIdentifiers = [];
 
     public static function create(): ToManyRelationship
     {

diff --git a/src/JsonApi/Request/ToOneRelationship.php b/src/JsonApi/Request/ToOneRelationship.php
@@ -6,20 +6,10 @@
 
 final class ToOneRelationship implements RelationshipInterface
 {
-    /**
-     * @var string
-     */
-    private $type;
-
-    /**
-     * @var string
-     */
-    private $id;
-
-    /**
-     * @var array
-     */
-    private $meta;
+    private string $type;
+    private string $id;
+    /** @var array<int|string, mixed> */
+    private array $meta;
 
     public static function create(string $type, string $id, array $meta = []): ToOneRelationship
     {

diff --git a/src/JsonApi/Response/AbstractResponse.php b/src/JsonApi/Response/AbstractResponse.php
@@ -9,10 +9,7 @@
 
 abstract class AbstractResponse implements ResponseInterface
 {
-    /**
-     * @var ResponseInterface
-     */
-    protected $response;
+    protected ResponseInterface $response;
 
     public function __construct(ResponseInterface $response)
     {
@@ -28,7 +25,7 @@ public function getProtocolVersion(): string
      * @param string $version
      * @return $this
      */
-    public function withProtocolVersion($version)
+    public function withProtocolVersion($version): ResponseInterface
     {
         $response = clone $this;
         $response->response = $this->response->withProtocolVersion($version);
@@ -74,7 +71,7 @@ public function getHeaderLine($name): string
      * @param string|string[] $value
      * @return $this
      */
-    public function withHeader($name, $value)
+    public function withHeader($name, $value): ResponseInterface
     {
         $response = clone $this;
         $response->response = $this->response->withHeader($name, $value);
@@ -87,7 +84,7 @@ public function withHeader($name, $value)
      * @param string|string[] $value
      * @return $this
      */
-    public function withAddedHeader($name, $value)
+    public function withAddedHeader($name, $value): ResponseInterface
     {
         $response = clone $this;
         $response->response = $this->response->withAddedHeader($name, $value);
@@ -99,7 +96,7 @@ public function withAddedHeader($name, $value)
      * @param string $name
      * @return $this
      */
-    public function withoutHeader($name)
+    public function withoutHeader($name): ResponseInterface
     {
         $response = clone $this;
         $response->response = $this->response->withoutHeader($name);
@@ -115,7 +112,7 @@ public function getBody(): StreamInterface
     /**
      * @return $this
      */
-    public function withBody(StreamInterface $body)
+    public function withBody(StreamInterface $body): ResponseInterface
     {
         $response = clone $this;
         $response->response = $this->response->withBody($body);
@@ -133,7 +130,7 @@ public function getStatusCode(): int
      * @param string $reasonPhrase
      * @return $this
      */
-    public function withStatus($code, $reasonPhrase = "")
+    public function withStatus($code, $reasonPhrase = ""): ResponseInterface
     {
         $response = clone $this;
         $response->response = $this->response->withStatus($code, $reasonPhrase);

diff --git a/src/JsonApi/Response/JsonApiResponse.php b/src/JsonApi/Response/JsonApiResponse.php
@@ -15,14 +15,9 @@
 
 class JsonApiResponse extends AbstractResponse
 {
-    /**
-     * @var DeserializerInterface
-     */
-    private $deserializer;
+    private DeserializerInterface $deserializer;
 
-    /**
-     * @var Document|false|null
-     */
+    /** @var Document|false|null */
     private $document = false;
 
     public function __construct(ResponseInterface $response, ?DeserializerInterface $deserializer = null)

diff --git a/src/JsonApi/Schema/Document.php b/src/JsonApi/Schema/Document.php
@@ -17,34 +17,15 @@
 
 final class Document
 {
-    /**
-     * @var JsonApiObject
-     */
-    private $jsonApi;
-
-    /**
-     * @var array
-     */
-    private $meta;
-
-    /**
-     * @var DocumentLinks
-     */
-    private $links;
-
-    /**
-     * @var ResourceObjects
-     */
-    private $resources;
-
-    /**
-     * @var Error[]
-     */
-    private $errors;
-
-    /**
-     * @param Error[] $errors
-     */
+    private JsonApiObject $jsonApi;
+    /** @var array<int|string, mixed> */
+    private array $meta;
+    private DocumentLinks $links;
+    private ResourceObjects $resources;
+    /** @var array<int, Error> */
+    private array $errors;
+
+    /** @param array<int, Error> $errors */
     public function __construct(JsonApiObject $jsonApi, array $meta, DocumentLinks $links, ResourceObjects $resources, array $errors)
     {
         $this->jsonApi = $jsonApi;