Prezise the type of keys

Art4 · Art4 · commit a46ee529a414 · 2023-10-18T17:10:06.000+02:00
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
      */
diff --git a/src/V1/ResourceIdentifierCollection.php b/src/V1/ResourceIdentifierCollection.php
diff --git a/src/V1/ResourceItem.php b/src/V1/ResourceItem.php
diff --git a/src/V1/ResourceItemLink.php b/src/V1/ResourceItemLink.php
diff --git a/src/V1/ResourceNull.php b/src/V1/ResourceNull.php
diff --git a/tests/Fixtures/HelperTrait.php b/tests/Fixtures/HelperTrait.php
diff --git a/tests/Fixtures/V1Factory.php b/tests/Fixtures/V1Factory.php
diff --git a/tests/Functional/ParsingTest.php b/tests/Functional/ParsingTest.php
diff --git a/tests/Functional/SerializerTest.php b/tests/Functional/SerializerTest.php

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`
`9`	`9`	`namespace Art4\JsonApiClient;`
`10`	`10`
	`11`	`+use Art4\JsonApiClient\Helper\AccessKey;`
	`12`	`+`
`11`	`13`	`/**`
`12`	`14`	`* Accessable Interface`
`13`	`15`	`*/`
`@@ -16,7 +18,7 @@ interface Accessable`
`16`	`18`	`/**`
`17`	`19`	`* Get a value by a key`
`18`	`20`	`*`
`19`		`- * @param mixed $key The key`
	`21`	`+ * @param int\|string\|AccessKey<string> $key The key`
`20`	`22`	`*`
`21`	`23`	`* @return mixed`
`22`	`24`	`*/`
`@@ -27,7 +29,7 @@ public function get($key);`
`27`	`29`	`*`
`28`	`30`	* @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.
`29`	`31`	`*`
`30`		`- * @param mixed $key The key`
	`32`	`+ * @param int\|string\|AccessKey<string> $key The key`
`31`	`33`	`*`
`32`	`34`	`* @return bool`
`33`	`35`	`*/`
`@@ -39,7 +41,7 @@ public function has($key);`
`39`	`41`	`*`
`40`	`42`	* @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.
`41`	`43`	`*`
`42`		`- * @return array<string> Keys of all setted values`
	`44`	`+ * @return array<string\|int> Keys of all setted values`
`43`	`45`	`*/`
`44`	`46`	`public function getKeys();`
`45`	`47`	`// public function getKeys(): array;`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ final protected function set(string $key, $value): void`
`41`	`41`	`/**`
`42`	`42`	`* Returns the keys of all setted values`
`43`	`43`	`*`
`44`		`- * @return array<string> Keys of all setted values`
	`44`	`+ * @return array<int\|string> Keys of all setted values`
`45`	`45`	`*/`
`46`	`46`	`final public function getKeys(): array`
`47`	`47`	`{`
`@@ -51,7 +51,7 @@ final public function getKeys(): array`
`51`	`51`	`/**`
`52`	`52`	`* Check if a value exists`
`53`	`53`	`*`
`54`		`- * @param mixed $key The key`
	`54`	`+ * @param int\|string\|AccessKey<string> $key The key`
`55`	`55`	`*/`
`56`	`56`	`final public function has($key): bool`
`57`	`57`	`{`
`@@ -82,7 +82,7 @@ final public function has($key): bool`
`82`	`82`	`/**`
`83`	`83`	`* Get a value by a key`
`84`	`84`	`*`
`85`		`- * @param mixed $key The key`
	`85`	`+ * @param int\|string\|AccessKey<string> $key The key`
`86`	`86`	`*`
`87`	`87`	`* @return mixed`
`88`	`88`	`*/`
`@@ -126,7 +126,7 @@ private function getValue(string $key)`
`126`	`126`	`/**`
`127`	`127`	`* Parse a dot.notated.key to an object`
`128`	`128`	`*`
`129`		`- * @param string\|AccessKey<string> $key The key`
	`129`	`+ * @param int\|string\|AccessKey<string> $key The key`
`130`	`130`	`*`
`131`	`131`	`* @return AccessKey<string> The parsed key`
`132`	`132`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct(array $params = [])`
`35`	`35`	`/**`
`36`	`36`	`* Convert data in an array`
`37`	`37`	`*`
`38`		`- * @return array<string, mixed>\|null`
	`38`	`+ * @return array<int\|string, mixed>\|null`
`39`	`39`	`*/`
`40`	`40`	`public function serialize(Accessable $data): ?array`
`41`	`41`	`{`