Add typed parameters and return types in internal and final classes

Author: Art4

src/Element.php

@@ -27,9 +27,7 @@ interface Element
     /**
      * Sets the manager and parent
      *
-     * @param mixed                          $data    The data for this Element
-     * @param \Art4\JsonApiClient\Manager    $manager The manager
-     * @param \Art4\JsonApiClient\Accessable $parent  The parent
+     * @param mixed $data The data for this Element
      */
     public function __construct($data, Manager $manager, Accessable $parent);
 }

src/Helper/AbstractElement.php

@@ -39,9 +39,7 @@ abstract class AbstractElement implements Accessable, Element
     /**
      * Sets the manager and parent
      *
-     * @param mixed                          $data    The data for this Element
-     * @param \Art4\JsonApiClient\Manager    $manager The manager
-     * @param \Art4\JsonApiClient\Accessable $parent  The parent
+     * @param mixed $data The data for this Element
      */
     public function __construct($data, Manager $manager, Accessable $parent)
     {
@@ -53,33 +51,26 @@ public function __construct($data, Manager $manager, Accessable $parent)
 
     /**
      * Returns the Manager
-     *
-     * @return \Art4\JsonApiClient\Manager
      */
-    protected function getManager()
+    protected function getManager(): Manager
     {
         return $this->manager;
     }
 
     /**
      * Get the parent
-     *
-     * @return \Art4\JsonApiClient\Accessable
      */
-    protected function getParent()
+    protected function getParent(): Accessable
     {
         return $this->parent;
     }
 
     /**
      * Create an element
      *
-     * @param mixed $name
      * @param mixed $data
-     *
-     * @return \Art4\JsonApiClient\Accessable
      */
-    protected function create($name, $data)
+    protected function create(string $name, $data): Accessable
     {
         return $this->getManager()->getFactory()->make(
             $name,
@@ -91,8 +82,6 @@ protected function create($name, $data)
      * Parse the data
      *
      * @param mixed $data
-     *
-     * @return void
      */
-    abstract protected function parse($data);
+    abstract protected function parse($data): void;
 }

src/Helper/AccessKey.php

@@ -35,7 +35,7 @@ final class AccessKey extends SplStack
      *
      * @return AccessKey<string>
      */
-    public static function create($key)
+    public static function create($key): AccessKey
     {
         // Ignore arrays and objects
         if (is_object($key) or is_array($key)) {
@@ -61,14 +61,12 @@ public static function create($key)
     /**
      * @var string Raw key
      */
-    public $raw = '';
+    public string $raw = '';
 
     /**
      * Transforms the Key to a string
-     *
-     * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return $this->raw;
     }

src/Helper/AccessableTrait.php

@@ -37,29 +37,24 @@ trait AccessableTrait
     /**
      * Set a value
      *
-     * @param string $key   The Key
      * @param mixed  $value The Value
-     *
-     * @return self
      */
-    protected function set($key, $value)
+    final protected function set(string $key, $value): void
     {
         // Allow non-associative array for collections
         if ($key === '') {
             $this->data[] = $value;
         } else {
             $this->data[$key] = $value;
         }
-
-        return $this;
     }
 
     /**
      * Returns the keys of all setted values
      *
      * @return array<string> Keys of all setted values
      */
-    public function getKeys()
+    final public function getKeys()
     {
         return array_keys($this->data);
     }
@@ -71,7 +66,7 @@ public function getKeys()
      *
      * @return bool
      */
-    public function has($key)
+    final public function has($key)
     {
         $key = $this->parseKey($key);
 
@@ -90,7 +85,7 @@ public function has($key)
 
         // #TODO Handle other objects and arrays
         if (! $value instanceof Accessable) {
-            //throw new AccessException('The existance for the key "' . $key->raw . '" could\'nt be checked.');
+            // throw new AccessException('The existance for the key "' . $key->raw . '" could\'nt be checked.');
             return false;
         }
 
@@ -128,11 +123,11 @@ public function get($key)
     /**
      * Get a value by the key
      *
-     * @param string $key The key of the value
+     * @throws AccessException
      *
      * @return mixed The value
      */
-    private function getValue($key)
+    private function getValue(string $key)
     {
         if (array_key_exists($key, $this->data)) {
             return $this->data[$key];
@@ -148,7 +143,7 @@ private function getValue($key)
      *
      * @return AccessKey<string> The parsed key
      */
-    private function parseKey($key)
+    private function parseKey($key): AccessKey
     {
         if (is_object($key) and $key instanceof AccessKey) {
             return $key;

src/Helper/Parser.php

@@ -19,6 +19,7 @@
 
 namespace Art4\JsonApiClient\Helper;
 
+use Art4\JsonApiClient\Accessable;
 use Art4\JsonApiClient\Exception\Exception;
 use Art4\JsonApiClient\Input\RequestStringInput;
 use Art4\JsonApiClient\Input\ResponseStringInput;
@@ -31,29 +32,21 @@
 final class Parser
 {
     /**
-     * @param string $jsonString
-     *
-     * @throws \Art4\JsonApiClient\Exception\ValidationException If $jsonString contains invalid JSON API
      * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input
-     *
-     * @return \Art4\JsonApiClient\Accessable
+     * @throws \Art4\JsonApiClient\Exception\ValidationException If $jsonString contains invalid JSON API
      */
-    public static function parseResponseString($jsonString)
+    public static function parseResponseString(string $jsonString): Accessable
     {
         $manager = new ErrorAbortManager(new Factory());
 
         return $manager->parse(new ResponseStringInput($jsonString));
     }
 
     /**
-     * @param string $jsonString
-     *
-     * @throws \Art4\JsonApiClient\Exception\ValidationException If $jsonString contains invalid JSON API
      * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input
-     *
-     * @return \Art4\JsonApiClient\Accessable
+     * @throws \Art4\JsonApiClient\Exception\ValidationException If $jsonString contains invalid JSON API
      */
-    public static function parseRequestString($jsonString)
+    public static function parseRequestString(string $jsonString): Accessable
     {
         $manager = new ErrorAbortManager(new Factory());
 
@@ -62,12 +55,8 @@ public static function parseRequestString($jsonString)
 
     /**
      * Checks if a string is a valid JSON API response body
-     *
-     * @param string $jsonString
-     *
-     * @return bool true, if $jsonString contains valid JSON API, else false
      */
-    public static function isValidResponseString($jsonString)
+    public static function isValidResponseString(string $jsonString): bool
     {
         try {
             static::parseResponseString($jsonString);
@@ -80,12 +69,8 @@ public static function isValidResponseString($jsonString)
 
     /**
      * Checks if a string is a valid JSON API request body
-     *
-     * @param string $jsonString
-     *
-     * @return bool true, if $jsonString contains valid JSON API, else false
      */
-    public static function isValidRequestString($jsonString)
+    public static function isValidRequestString(string $jsonString): bool
     {
         try {
             static::parseRequestString($jsonString);

src/Input/RequestInput.php

@@ -20,7 +20,7 @@
 namespace Art4\JsonApiClient\Input;
 
 /**
- * Input Interface
+ * Request Input Interface
  */
 interface RequestInput
 {

src/Input/StringInputTrait.php

@@ -35,10 +35,8 @@ trait StringInputTrait
      * @param string $string
      *
      * @throws InputException if $string is not a string
-     *
-     * @return string
      */
-    public function prepareString($string)
+    final public function prepareString($string): string
     {
         if (! is_string($string)) {
             throw new InputException(sprintf(
@@ -53,13 +51,11 @@ public function prepareString($string)
     /**
      * Decodes a json string
      *
-     * @param string $jsonString
-     *
      * @throws InputException if something went wrong with the input
      *
      * @return mixed
      */
-    protected function decodeJson($jsonString)
+    final protected function decodeJson(string $jsonString)
     {
         $jsonErrors = [
             \JSON_ERROR_DEPTH => 'JSON_ERROR_DEPTH - Maximum stack depth exceeded',

src/Manager.php

@@ -29,8 +29,6 @@ interface Manager
     /**
      * Parse the input
      *
-     * @param \Art4\JsonApiClient\Input\Input $input
-     *
      * @throws \Art4\JsonApiClient\Exception\InputException If $input contains invalid JSON API
      * @throws \Art4\JsonApiClient\Exception\ValidationException If $input contains invalid JSON API
      *

src/Manager/ErrorAbortManager.php

@@ -19,6 +19,7 @@
 
 namespace Art4\JsonApiClient\Manager;
 
+use Art4\JsonApiClient\Accessable;
 use Art4\JsonApiClient\Exception\InputException;
 use Art4\JsonApiClient\Exception\ValidationException;
 use Art4\JsonApiClient\Factory;
@@ -44,10 +45,6 @@ final class ErrorAbortManager implements Manager
 
     /**
      * Create a Manager
-     *
-     * @param \Art4\JsonApiClient\Factory $factory
-     *
-     * @return object
      */
     public function __construct(Factory $factory)
     {
@@ -57,14 +54,10 @@ public function __construct(Factory $factory)
     /**
      * Parse the input
      *
-     * @param \Art4\JsonApiClient\Input\Input $input
-     *
      * @throws \Art4\JsonApiClient\Exception\InputException If $input contains invalid JSON API
      * @throws \Art4\JsonApiClient\Exception\ValidationException If $input contains invalid JSON API
-     *
-     * @return \Art4\JsonApiClient\Accessable
      */
-    public function parse(Input $input)
+    public function parse(Input $input): Accessable
     {
         // fill config
         $this->config = $this->default;
@@ -88,10 +81,8 @@ public function parse(Input $input)
 
     /**
      * Get a factory from the manager
-     *
-     * @return \Art4\JsonApiClient\Factory
      */
-    public function getFactory()
+    public function getFactory(): Factory
     {
         return $this->factory;
     }

src/Serializer/ArraySerializer.php

@@ -46,11 +46,9 @@ public function __construct(array $params = [])
     /**
      * Convert data in an array
      *
-     * @param \Art4\JsonApiClient\Accessable $data The data for serialization
-     *
      * @return array<string, mixed>|null
      */
-    public function serialize(Accessable $data)
+    public function serialize(Accessable $data): ?array
     {
         $fullArray = (bool) $this->config['recursive'];