Refactoring/upgrading code to work with phpstan.

.travis.yml

@@ -24,6 +24,7 @@ before_script:
 script:
   - XDEBUG_MODE=coverage ./vendor/phpunit/phpunit/phpunit --coverage-html docs/tests/
   - XDEBUG_MODE=coverage ./vendor/phpunit/phpunit/phpunit --coverage-text --coverage-clover=coverage.clover
+  - ./vendor/bin/phpstan
 
 after_success:
   - bash <(curl -s https://codecov.io/bash)

README.md

@@ -72,6 +72,10 @@ Tests can be run as follows:
 
 * `./vendor/phpunit/phpunit/phpunit`
 
+Static analysis/code review can be performed by using [phpstan](https://phpstan.org/):
+
+* `./vendor/bin/phpstan`
+
 The following tests and also creates code coverage (usually maintained at 100%)
 
 * `./vendor/phpunit/phpunit/phpunit --coverage-html docs/tests/`

composer.json

@@ -24,6 +24,7 @@
     "require-dev": {
         "floor9design/testing-tools": "*",
         "mockery/mockery": "dev-master",
+        "phpstan/phpstan": "^0.12.83",
         "phpunit/phpunit": "^9.0"
     },
     "autoload": {

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+    level: max
+    paths:
+        - src

src/Models/DataResource.php

@@ -52,6 +52,7 @@ class DataResource
     var ?string $type = null;
 
     /**
+     * @phpstan-var array[]
      * @var array|null
      */
     var ?array $attributes = null;
@@ -99,6 +100,7 @@ public function setType(?string $type): DataResource
     }
 
     /**
+     * @phpstan-return array[]|null
      * @return array|null
      * @see $attributes
      */
@@ -108,6 +110,7 @@ public function getAttributes(): ?array
     }
 
     /**
+     * @phpstan-param array[]|null $attributes
      * @param array|null $attributes
      * @return DataResource
      * @see $attributes
@@ -124,6 +127,7 @@ public function setAttributes(?array $attributes): DataResource
      * DataResource constructor.
      * @param string|null $id
      * @param string|null $type
+     * @phpstan-param array[]|null $attributes
      * @param array|null $attributes
      */
     public function __construct(
@@ -138,6 +142,7 @@ public function __construct(
     }
 
     /**
+     * @phpstan-return array{id:string|null,type:string|null,attributes:array[]|null}
      * @return array
      */
     public function toArray(): array

src/Models/Error.php

@@ -228,7 +228,7 @@ public function setSource(?object $source): Error
      * @param string|null $code
      * @param string|null $title
      * @param string|null $detail
-     * @param string|null $source
+     * @param object|null $source
      */
     public function __construct(
         ?string $id = null,
@@ -250,7 +250,7 @@ public function __construct(
     }
 
     /**
-     * @return array
+     * @return array<string, object|string|null>
      */
     public function toArray(): array
     {