Merge pull request #63 from Art4/phpstan-level-2

Art4 · web-flow · commit 6d489c15e895 · 2021-10-04T13:18:16.000+02:00
Fix errors for PHPStan level 2
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -49,6 +49,6 @@ jobs:
         run: composer install --no-progress --prefer-dist --optimize-autoloader
 
       - name: Run PHPStan
-        run: vendor/bin/phpstan.phar analyze src --level 1
+        run: vendor/bin/phpstan.phar analyze src --level 2
 
       - run: echo "🍏 This job's status is ${{ job.status }}."
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![Latest Version](https://img.shields.io/github/release/Art4/json-api-client.svg)](https://github.com/Art4/json-api-client/releases)
 [![Software License](https://img.shields.io/badge/license-GPL3-brightgreen.svg)](LICENSE)
-[![Build Status](https://github.com/art4/json-api-client/actions/workflows/unit-tests.yml/badge.svg?branch=v1.x)](https://github.com/Art4/json-api-client/actionst)
+[![Build Status](https://github.com/art4/json-api-client/actions/workflows/unit-tests.yml/badge.svg?branch=v1.x)](https://github.com/Art4/json-api-client/actions)
 [![Total Downloads](https://img.shields.io/packagist/dt/art4/json-api-client.svg)](https://packagist.org/packages/art4/json-api-client)
 
 JsonApiClient :construction_worker_woman: is a PHP Library to validate and handle the response body from a [JSON API](http://jsonapi.org) Server.
diff --git a/src/Helper/Parser.php b/src/Helper/Parser.php
@@ -33,7 +33,8 @@ final class Parser
     /**
      * @param string $jsonString
      *
-     * @throws \Art4\JsonApiClient\Exception\Exception
+     * @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
      */
@@ -47,7 +48,8 @@ public static function parseResponseString($jsonString)
     /**
      * @param string $jsonString
      *
-     * @throws \Art4\JsonApiClient\Exception\Exception
+     * @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
      */
diff --git a/src/Input/Input.php b/src/Input/Input.php
@@ -30,9 +30,9 @@ interface Input
      * This should be a native PH stdClass object, so Manager could
      * iterate over all public attributes
      *
-     * @throws InputException if somethin went wrong with the input
+     * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input
      *
-     * @return stdClass
+     * @return \stdClass
      */
     public function getAsObject();
 }
diff --git a/src/Input/RequestStringInput.php b/src/Input/RequestStringInput.php
@@ -33,7 +33,7 @@ final class RequestStringInput implements Input, RequestInput
      *
      * @param string $string
      *
-     * @throws InputException if $string is not a string
+     * @throws \Art4\JsonApiClient\Exception\InputException if $string is not a string
      */
     public function __construct($string)
     {
@@ -46,9 +46,9 @@ public function __construct($string)
      * This should be a native PH stdClass object, so Manager could
      * iterate over all public attributes
      *
-     * @throws InputException if somethin went wrong with the input
+     * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input
      *
-     * @return stdClass
+     * @return \stdClass
      */
     public function getAsObject()
     {
diff --git a/src/Input/ResponseStringInput.php b/src/Input/ResponseStringInput.php
@@ -33,7 +33,7 @@ final class ResponseStringInput implements Input
      *
      * @param string $string
      *
-     * @throws InputException if $string is not a string
+     * @throws \Art4\JsonApiClient\Exception\InputException if $string is not a string
      */
     public function __construct($string)
     {
@@ -46,9 +46,9 @@ public function __construct($string)
      * This should be a native PH stdClass object, so Manager could
      * iterate over all public attributes
      *
-     * @throws InputException if somethin went wrong with the input
+     * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input
      *
-     * @return stdClass
+     * @return \stdClass
      */
     public function getAsObject()
     {
diff --git a/src/Input/StringInputTrait.php b/src/Input/StringInputTrait.php
@@ -52,7 +52,7 @@ public function prepareString($string)
      *
      * @param string $jsonString
      *
-     * @throws InputException if somethin went wrong with the input
+     * @throws InputException if something went wrong with the input
      *
      * @return object
      */
diff --git a/src/Manager/ErrorAbortManager.php b/src/Manager/ErrorAbortManager.php
@@ -43,7 +43,6 @@ final class ErrorAbortManager implements Manager
      * Create a Manager
      *
      * @param \Art4\JsonApiClient\Factory $factory
-     * @param mixed                      $params  A config array
      *
      * @return object
      */
diff --git a/src/Serializer/ArraySerializer.php b/src/Serializer/ArraySerializer.php
@@ -75,7 +75,7 @@ public function serialize(Accessable $data)
     /**
      * Transforms objects to arrays
      *
-     * @param $val
+     * @param mixed $val
      *
      * @return mixed
      */
diff --git a/src/V1/Document.php b/src/V1/Document.php
@@ -99,12 +99,11 @@ public function get($key)
     /**
      * Parse the data value
      *
-     *
      * @param null|object $data Data value
      *
      * @throws ValidationException If $data isn't null or an object
      *
-     * @return Accessable The parsed data
+     * @return \Art4\JsonApiClient\Accessable The parsed data
      */
     private function parseData($data)
     {

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,8 @@ final class Parser`
`33`	`33`	`/**`
`34`	`34`	`* @param string $jsonString`
`35`	`35`	`*`
`36`		`- * @throws \Art4\JsonApiClient\Exception\Exception`
	`36`	`+ * @throws \Art4\JsonApiClient\Exception\ValidationException If $jsonString contains invalid JSON API`
	`37`	`+ * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input`
`37`	`38`	`*`
`38`	`39`	`* @return \Art4\JsonApiClient\Accessable`
`39`	`40`	`*/`
`@@ -47,7 +48,8 @@ public static function parseResponseString($jsonString)`
`47`	`48`	`/**`
`48`	`49`	`* @param string $jsonString`
`49`	`50`	`*`
`50`		`- * @throws \Art4\JsonApiClient\Exception\Exception`
	`51`	`+ * @throws \Art4\JsonApiClient\Exception\ValidationException If $jsonString contains invalid JSON API`
	`52`	`+ * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input`
`51`	`53`	`*`
`52`	`54`	`* @return \Art4\JsonApiClient\Accessable`
`53`	`55`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -30,9 +30,9 @@ interface Input`
`30`	`30`	`* This should be a native PH stdClass object, so Manager could`
`31`	`31`	`* iterate over all public attributes`
`32`	`32`	`*`
`33`		`- * @throws InputException if somethin went wrong with the input`
	`33`	`+ * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input`
`34`	`34`	`*`
`35`		`- * @return stdClass`
	`35`	`+ * @return \stdClass`
`36`	`36`	`*/`
`37`	`37`	`public function getAsObject();`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ final class RequestStringInput implements Input, RequestInput`
`33`	`33`	`*`
`34`	`34`	`* @param string $string`
`35`	`35`	`*`
`36`		`- * @throws InputException if $string is not a string`
	`36`	`+ * @throws \Art4\JsonApiClient\Exception\InputException if $string is not a string`
`37`	`37`	`*/`
`38`	`38`	`public function __construct($string)`
`39`	`39`	`{`
`@@ -46,9 +46,9 @@ public function __construct($string)`
`46`	`46`	`* This should be a native PH stdClass object, so Manager could`
`47`	`47`	`* iterate over all public attributes`
`48`	`48`	`*`
`49`		`- * @throws InputException if somethin went wrong with the input`
	`49`	`+ * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input`
`50`	`50`	`*`
`51`		`- * @return stdClass`
	`51`	`+ * @return \stdClass`
`52`	`52`	`*/`
`53`	`53`	`public function getAsObject()`
`54`	`54`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ final class ResponseStringInput implements Input`
`33`	`33`	`*`
`34`	`34`	`* @param string $string`
`35`	`35`	`*`
`36`		`- * @throws InputException if $string is not a string`
	`36`	`+ * @throws \Art4\JsonApiClient\Exception\InputException if $string is not a string`
`37`	`37`	`*/`
`38`	`38`	`public function __construct($string)`
`39`	`39`	`{`
`@@ -46,9 +46,9 @@ public function __construct($string)`
`46`	`46`	`* This should be a native PH stdClass object, so Manager could`
`47`	`47`	`* iterate over all public attributes`
`48`	`48`	`*`
`49`		`- * @throws InputException if somethin went wrong with the input`
	`49`	`+ * @throws \Art4\JsonApiClient\Exception\InputException if something went wrong with the input`
`50`	`50`	`*`
`51`		`- * @return stdClass`
	`51`	`+ * @return \stdClass`
`52`	`52`	`*/`
`53`	`53`	`public function getAsObject()`
`54`	`54`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public function prepareString($string)`
`52`	`52`	`*`
`53`	`53`	`* @param string $jsonString`
`54`	`54`	`*`
`55`		`- * @throws InputException if somethin went wrong with the input`
	`55`	`+ * @throws InputException if something went wrong with the input`
`56`	`56`	`*`
`57`	`57`	`* @return object`
`58`	`58`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ final class ErrorAbortManager implements Manager`
`43`	`43`	`* Create a Manager`
`44`	`44`	`*`
`45`	`45`	`* @param \Art4\JsonApiClient\Factory $factory`
`46`		`- * @param mixed $params A config array`
`47`	`46`	`*`
`48`	`47`	`* @return object`
`49`	`48`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public function serialize(Accessable $data)`
`75`	`75`	`/**`
`76`	`76`	`* Transforms objects to arrays`
`77`	`77`	`*`
`78`		`- * @param $val`
	`78`	`+ * @param mixed $val`
`79`	`79`	`*`
`80`	`80`	`* @return mixed`
`81`	`81`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -99,12 +99,11 @@ public function get($key)`
`99`	`99`	`/**`
`100`	`100`	`* Parse the data value`
`101`	`101`	`*`
`102`		`- *`
`103`	`102`	`* @param null\|object $data Data value`
`104`	`103`	`*`
`105`	`104`	`* @throws ValidationException If $data isn't null or an object`
`106`	`105`	`*`
`107`		`- * @return Accessable The parsed data`
	`106`	`+ * @return \Art4\JsonApiClient\Accessable The parsed data`
`108`	`107`	`*/`
`109`	`108`	`private function parseData($data)`
`110`	`109`	`{`