Merge pull request #68 from Art4/prepare-typehinting-in-interfaces

Prepare for typehints in interfaces

Author: Art4

CHANGELOG.md

@@ -11,16 +11,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Added type hints for parameters and return types in internal and final classes
 - New tests for improving backward compatibility in interfaces
+- Support for PHP 8.1 is added in CI tests
 
 ### Changed
 
 - Switched from Travis-CI to Github Actions
 
+### 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.
+- `\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.
+- `\Art4\JsonApiClient\Exception\Exception` will extend `\Throwable` in v2.0, do the same in your implementation now to avoid errors.
+- `\Art4\JsonApiClient\Factory::make()` methods first parameter signature will be `string` in v2.0.
+- `\Art4\JsonApiClient\Factory::make()` will add `\Art4\JsonApiClient\Accessable` as a native return type declaration in v2.0, do the same in your implementation now to avoid errors.
+- `\Art4\JsonApiClient\Input\Input::getAsObject()` will add `\stdClass` as a native return type declaration in v2.0, do the same in your implementation now to avoid errors.
+- `\Art4\JsonApiClient\Manager::parse()` will add `\Art4\JsonApiClient\Accessable` as a native return type declaration in v2.0, do the same in your implementation now to avoid errors.
+- `\Art4\JsonApiClient\Manager::getFactory()` will add `\Art4\JsonApiClient\Factory` as a native return type declaration in v2.0, do the same in your implementation now to avoid errors.
+- `\Art4\JsonApiClient\Manager::getParam()` methods first parameter signature will be `string` in v2.0.
+- `\Art4\JsonApiClient\Serializer\Serializer::serialize()` will add `?array` as a native return type declaration in v2.0, do the same in your implementation now to avoid errors.
+
 ## [1.0.0 - 2021-03-05](https://github.com/Art4/json-api-client/compare/0.10.2...1.0.0)
 
 ### Added
 
-- Support for PHP 8 added
+- Support for PHP 8.0 added
 
 ### Changed
 

src/Accessable.php

@@ -36,16 +36,22 @@ public function get($key);
     /**
      * Check if a value exists
      *
+     * @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
      *
      * @return bool
      */
     public function has($key);
+    // public function has($key): bool;
 
     /**
      * Returns the keys of all setted values
      *
+     * @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
      */
     public function getKeys();
+    // public function getKeys(): array;
 }

src/Exception/AccessException.php

@@ -19,6 +19,6 @@
 
 namespace Art4\JsonApiClient\Exception;
 
-class AccessException extends \RuntimeException implements Exception
+class AccessException extends \RuntimeException implements Exception, \Throwable
 {
 }

src/Exception/Exception.php

@@ -19,6 +19,10 @@
 
 namespace Art4\JsonApiClient\Exception;
 
+/**
+ * @deprecated `\Art4\JsonApiClient\Exception\Exception` will extend `\Throwable` in v2.0. Do the same in your implementation now to avoid errors.
+ */
+// interface Exception extends \Throwable
 interface Exception
 {
 }

src/Exception/FactoryException.php

@@ -19,6 +19,6 @@
 
 namespace Art4\JsonApiClient\Exception;
 
-class FactoryException extends \Exception implements Exception
+class FactoryException extends \Exception implements Exception, \Throwable
 {
 }

src/Exception/InputException.php

@@ -19,6 +19,6 @@
 
 namespace Art4\JsonApiClient\Exception;
 
-class InputException extends \Exception implements Exception
+class InputException extends \Exception implements Exception, \Throwable
 {
 }

src/Exception/ValidationException.php

@@ -19,6 +19,6 @@
 
 namespace Art4\JsonApiClient\Exception;
 
-class ValidationException extends \InvalidArgumentException implements Exception
+class ValidationException extends \InvalidArgumentException implements Exception, \Throwable
 {
 }

src/Factory.php

@@ -19,8 +19,6 @@
 
 namespace Art4\JsonApiClient;
 
-use Art4\JsonApiClient\Accessable;
-
 /**
  * Factory Interface
  */
@@ -29,10 +27,14 @@ interface Factory
     /**
      * Create a new instance of a class
      *
+     * @deprecated The `\Art4\JsonApiClient\Factory::make()` methods first parameter signature will be `string` in v2.0.
+     * @deprecated `\Art4\JsonApiClient\Factory::make()` will add `\Art4\JsonApiClient\Accessable` as a native return type declaration in v2.0. Do the same in your implementation now to avoid errors.
+     *
      * @param string $name
      * @param array<mixed|Manager|Accessable>  $args
      *
      * @return \Art4\JsonApiClient\Accessable
      */
     public function make($name, array $args = []);
+    // public function make(string $name, array $args = []): Accessable;
 }

src/Helper/AccessableTrait.php

@@ -32,7 +32,7 @@ trait AccessableTrait
     /**
      * @var array<mixed>
      */
-    private $data = [];
+    private array $data = [];
 
     /**
      * Set a value
@@ -54,7 +54,7 @@ final protected function set(string $key, $value): void
      *
      * @return array<string> Keys of all setted values
      */
-    final public function getKeys()
+    final public function getKeys(): array
     {
         return array_keys($this->data);
     }
@@ -63,10 +63,8 @@ final public function getKeys()
      * Check if a value exists
      *
      * @param mixed $key The key
-     *
-     * @return bool
      */
-    final public function has($key)
+    final public function has($key): bool
     {
         $key = $this->parseKey($key);
 

src/Input/Input.php

@@ -27,12 +27,15 @@ interface Input
     /**
      * Get the input as simple object
      *
-     * This should be a native PH stdClass object, so Manager could
+     * @deprecated `\Art4\JsonApiClient\Input\Input::getAsObject()` will add `\stdClass` as a native return type declaration in v2.0. Do the same in your implementation now to avoid errors.
+     *
+     * This should be a native PHP stdClass object, so Manager could
      * iterate over all public attributes
      *
      * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input
      *
      * @return \stdClass
      */
     public function getAsObject();
+    // public function getAsObject(): \stdClass;
 }