Prezise the type of keys

Art4 · Oct 18, 2023 · a46ee52 · a46ee52
1 parent 01ccd18
commit a46ee52
Show file tree

Hide file tree

Showing 26 changed files with 89 additions and 66 deletions.
diff --git a/src/Accessable.php b/src/Accessable.php
@@ -8,6 +8,8 @@
 
 namespace Art4\JsonApiClient;
 
+use Art4\JsonApiClient\Helper\AccessKey;
+
 /**
  * Accessable Interface
  */
@@ -16,7 +18,7 @@ interface Accessable
     /**
      * Get a value by a key
      *
-     * @param mixed $key The key
+     * @param int|string|AccessKey<string> $key The key
      *
      * @return mixed
      */
@@ -27,7 +29,7 @@ public function get($key);
      *
      * @deprecated `\Art4\JsonApiClient\Accessable::has()` will add `bool` as a native return type declaration in v2.0. Do the same in your implementation now to avoid errors.
      *
-     * @param mixed $key The key
+     * @param int|string|AccessKey<string> $key The key
      *
      * @return bool
      */
@@ -39,7 +41,7 @@ public function has($key);
      *
      * @deprecated `\Art4\JsonApiClient\Accessable::getKeys()` will add `array` as a native return type declaration in v2.0. Do the same in your implementation now to avoid errors.
      *
-     * @return array<string> Keys of all setted values
+     * @return array<string|int> Keys of all setted values
      */
     public function getKeys();
     // public function getKeys(): array;

diff --git a/src/Helper/AccessableTrait.php b/src/Helper/AccessableTrait.php
@@ -41,7 +41,7 @@ final protected function set(string $key, $value): void
     /**
      * Returns the keys of all setted values
      *
-     * @return array<string> Keys of all setted values
+     * @return array<int|string> Keys of all setted values
      */
     final public function getKeys(): array
     {
@@ -51,7 +51,7 @@ final public function getKeys(): array
     /**
      * Check if a value exists
      *
-     * @param mixed $key The key
+     * @param int|string|AccessKey<string> $key The key
      */
     final public function has($key): bool
     {
@@ -82,7 +82,7 @@ final public function has($key): bool
     /**
      * Get a value by a key
      *
-     * @param mixed $key The key
+     * @param int|string|AccessKey<string> $key The key
      *
      * @return mixed
      */
@@ -126,7 +126,7 @@ private function getValue(string $key)
     /**
      * Parse a dot.notated.key to an object
      *
-     * @param string|AccessKey<string> $key The key
+     * @param int|string|AccessKey<string> $key The key
      *
      * @return AccessKey<string> The parsed key
      */

diff --git a/src/Serializer/ArraySerializer.php b/src/Serializer/ArraySerializer.php
@@ -35,7 +35,7 @@ public function __construct(array $params = [])
     /**
      * Convert data in an array
      *
-     * @return array<string, mixed>|null
+     * @return array<int|string, mixed>|null
      */
     public function serialize(Accessable $data): ?array
     {

diff --git a/src/V1/Attributes.php b/src/V1/Attributes.php
@@ -8,9 +8,11 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
+
 
 /**
  * Attributes Object
@@ -50,7 +52,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/Document.php b/src/V1/Document.php
@@ -9,9 +9,10 @@
 namespace Art4\JsonApiClient\V1;
 
 use Art4\JsonApiClient\Accessable;
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Document Top Level Object
@@ -73,7 +74,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/DocumentLink.php b/src/V1/DocumentLink.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Document Link Object
@@ -103,7 +104,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/Error.php b/src/V1/Error.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Error Object
@@ -105,7 +106,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/ErrorCollection.php b/src/V1/ErrorCollection.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Error Collection Object
@@ -44,7 +45,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this document
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/ErrorLink.php b/src/V1/ErrorLink.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Error Link Object
@@ -63,7 +64,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/ErrorSource.php b/src/V1/ErrorSource.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Error Source Object
@@ -52,7 +53,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this document
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/Jsonapi.php b/src/V1/Jsonapi.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * JSON API Object
@@ -48,7 +49,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/Link.php b/src/V1/Link.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Link Object
@@ -44,7 +45,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/Meta.php b/src/V1/Meta.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Meta Object
@@ -46,7 +47,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/Relationship.php b/src/V1/Relationship.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Resource Identifier Object
@@ -59,7 +60,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/RelationshipCollection.php b/src/V1/RelationshipCollection.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Relationship Collection Object
@@ -54,7 +55,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/RelationshipLink.php b/src/V1/RelationshipLink.php
@@ -11,6 +11,7 @@
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
 use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Relationship Link Object
@@ -105,7 +106,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/ResourceCollection.php b/src/V1/ResourceCollection.php
@@ -9,9 +9,10 @@
 namespace Art4\JsonApiClient\V1;
 
 use Art4\JsonApiClient\Accessable;
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Resource Object
@@ -47,7 +48,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */

diff --git a/src/V1/ResourceIdentifier.php b/src/V1/ResourceIdentifier.php
@@ -8,9 +8,10 @@
 
 namespace Art4\JsonApiClient\V1;
 
-use Art4\JsonApiClient\Helper\AbstractElement;
 use Art4\JsonApiClient\Exception\AccessException;
 use Art4\JsonApiClient\Exception\ValidationException;
+use Art4\JsonApiClient\Helper\AbstractElement;
+use Art4\JsonApiClient\Helper\AccessKey;
 
 /**
  * Resource Identifier Object
@@ -59,7 +60,7 @@ protected function parse($object): void
     /**
      * Get a value by the key of this object
      *
-     * @param string $key The key of the value
+     * @param int|string|AccessKey<string> $key The key of the value
      *
      * @return mixed The value
      */