Merge pull request #362 from dotkernel/issue-361

Issue #361: Increase `PHPStan` level to `8`

Author: alexmerlin

bin/composer-post-install-script.php

@@ -9,6 +9,9 @@
 
 // phpcs:disable PSR1.Files.SideEffects.FoundWithSymbols
 
+/**
+ * @param array{source: string, destination: string, environment: array<string>} $file
+ */
 function copyFile(array $file): void
 {
     if (! in_array(getEnvironment(), $file['environment'])) {
@@ -33,8 +36,11 @@ function getEnvironment(): string
     return getenv('COMPOSER_DEV_MODE') === '1' ? ENVIRONMENT_DEVELOPMENT : ENVIRONMENT_PRODUCTION;
 }
 
-// when adding files to the below array the `source` and `destination` paths must be relative to the project root folder
-// the `environment` key will indicate on what environments the file will be copied,
+/**
+ * When adding files to the below array:
+ * - `source` and `destination` paths must be relative to the project root folder
+ * - `environment` key will indicate on what environments the file will be copied
+ */
 $files = [
     [
         'source'      => 'config/autoload/local.php.dist',

phpstan.neon

@@ -2,12 +2,11 @@ includes:
     - vendor/phpstan/phpstan-doctrine/extension.neon
     - vendor/phpstan/phpstan-phpunit/extension.neon
 parameters:
-    level: 5
+    level: 8
     paths:
+        - bin
+        - config
+        - public
         - src
         - test
     treatPhpDocTypesAsCertain: false
-    ignoreErrors:
-        -
-            message: '#Parameter \#1 \$expected of method PHPUnit\\Framework\\Assert::assertSame\(\) contains unresolvable type.#'
-            path: test/Unit/App/Plugin/FormsPluginTest.php

src/Admin/src/Adapter/AuthenticationAdapter.php

@@ -30,6 +30,9 @@ class AuthenticationAdapter implements AdapterInterface
     private string $identity;
     private string $credential;
 
+    /**
+     * @param array<non-empty-string, mixed> $config
+     */
     #[Inject(
         EntityManagerInterface::class,
         'config.doctrine.authentication',
@@ -93,7 +96,7 @@ public function authenticate(): Result
         /** Check if the get credential method exists in the provided identity class */
         $getCredential = $this->validateMethod($identityClass, $this->config['orm_default']['credential_property']);
 
-        /** If passwords don't match, return failure response */
+        /** If passwords don't match, return a failure response */
         if (false === password_verify($this->getCredential(), $identityClass->$getCredential())) {
             return new Result(
                 Result::FAILURE_CREDENTIAL_INVALID,
@@ -105,7 +108,7 @@ public function authenticate(): Result
         /** Check for extra validation options */
         if (! empty($this->config['orm_default']['options'])) {
             foreach ($this->config['orm_default']['options'] as $property => $option) {
-                /** Check if value for the current option is provided */
+                /** Check if the value for the current option is provided */
                 if (! array_key_exists('value', $option)) {
                     throw new Exception(sprintf(
                         self::OPTION_VALUE_NOT_PROVIDED,
@@ -114,7 +117,7 @@ public function authenticate(): Result
                     ));
                 }
 
-                /** Check if message for the current option is provided */
+                /** Check if a message for the current option is provided */
                 if (! array_key_exists('message', $option)) {
                     throw new Exception(sprintf(
                         self::OPTION_VALUE_NOT_PROVIDED,
@@ -135,14 +138,20 @@ public function authenticate(): Result
             }
         }
 
+        /** @var non-empty-string[] $roles */
+        $roles = array_map(
+            fn (RoleInterface $role): string => (string) $role->getName()->value,
+            $identityClass->getRoles()
+        );
+
         $adminIdentity = new AdminIdentity(
             $identityClass->getUuid()->toString(),
-            $identityClass->getIdentity(),
+            (string) $identityClass->getIdentity(),
             $identityClass->getStatus(),
-            array_map(fn (RoleInterface $role): string => $role->getName()->value, $identityClass->getRoles()),
+            $roles,
             [
-                'firstName' => $identityClass->getFirstName(),
-                'lastName'  => $identityClass->getLastName(),
+                'firstName' => (string) $identityClass->getFirstName(),
+                'lastName'  => (string) $identityClass->getLastName(),
             ]
         );
 

src/Admin/src/ConfigProvider.php

@@ -36,8 +36,25 @@
 use Laminas\Form\ElementFactory;
 use Mezzio\Application;
 
+/**
+ * @phpstan-type ConfigType array{
+ *      dependencies: DependenciesType,
+ *      templates: TemplatesType,
+ * }
+ * @phpstan-type DependenciesType array{
+ *      delegators: non-empty-array<class-string, array<class-string>>,
+ *      factories: non-empty-array<class-string, class-string>,
+ *      aliases: non-empty-array<class-string, class-string>,
+ * }
+ * @phpstan-type TemplatesType array{
+ *      paths: non-empty-array<non-empty-string, non-empty-string[]>,
+ * }
+ */
 class ConfigProvider
 {
+    /**
+     * @return ConfigType
+     */
     public function __invoke(): array
     {
         return [
@@ -46,6 +63,9 @@ public function __invoke(): array
         ];
     }
 
+    /**
+     * @return DependenciesType
+     */
     public function getDependencies(): array
     {
         return [
@@ -86,6 +106,9 @@ public function getDependencies(): array
         ];
     }
 
+    /**
+     * @return TemplatesType
+     */
     public function getTemplates(): array
     {
         return [

src/Admin/src/Form/AccountForm.php

@@ -9,11 +9,17 @@
 use Laminas\Form\Element\Csrf;
 use Laminas\Form\Element\Submit;
 use Laminas\Form\Element\Text;
-use Laminas\InputFilter\InputFilterInterface;
 use Laminas\Session\Container;
 
+/**
+ * @phpstan-import-type EditAccountDataType from EditAccountInputFilter
+ * @extends AbstractForm<EditAccountDataType>
+ */
 class AccountForm extends AbstractForm
 {
+    /**
+     * @param array<non-empty-string, mixed> $options
+     */
     public function __construct(?string $name = null, array $options = [])
     {
         parent::__construct($name, $options);
@@ -58,9 +64,4 @@ public function init(): void
                 ->setAttribute('class', 'btn btn-primary btn-color btn-sm')
         );
     }
-
-    public function getInputFilter(): InputFilterInterface
-    {
-        return $this->inputFilter;
-    }
 }

src/Admin/src/Form/ChangePasswordForm.php

@@ -12,8 +12,15 @@
 use Laminas\InputFilter\InputFilterInterface;
 use Laminas\Session\Container;
 
+/**
+ * @phpstan-import-type ChangePasswordDataType from ChangePasswordInputFilter
+ * @extends AbstractForm<ChangePasswordDataType>
+ */
 class ChangePasswordForm extends AbstractForm
 {
+    /**
+     * @param array<non-empty-string, mixed> $options
+     */
     public function __construct(?string $name = null, array $options = [])
     {
         parent::__construct($name, $options);

src/Admin/src/Form/CreateAdminForm.php

@@ -13,11 +13,18 @@
 use Laminas\Form\Element\Select;
 use Laminas\Form\Element\Submit;
 use Laminas\Form\Element\Text;
-use Laminas\InputFilter\InputFilterInterface;
 use Laminas\Session\Container;
 
+/**
+ * @phpstan-import-type CreateAdminDataType from CreateAdminInputFilter
+ * @phpstan-import-type SelectDataType from AbstractForm
+ * @extends AbstractForm<CreateAdminDataType>
+ */
 class CreateAdminForm extends AbstractForm
 {
+    /**
+     * @param array<non-empty-string, mixed> $options
+     */
     public function __construct(?string $name = null, array $options = [])
     {
         parent::__construct($name, $options);
@@ -32,6 +39,9 @@ public function __construct(?string $name = null, array $options = [])
         $this->inputFilter->init();
     }
 
+    /**
+     * @phpstan-param SelectDataType[] $roles
+     */
     public function setRoles(array $roles): self
     {
         return $this->add(
@@ -86,9 +96,4 @@ public function init(): void
                 ->setAttribute('class', 'btn btn-sm btn-primary')
         );
     }
-
-    public function getInputFilter(): InputFilterInterface
-    {
-        return $this->inputFilter;
-    }
 }

src/Admin/src/Form/DeleteAdminForm.php

@@ -9,11 +9,17 @@
 use Laminas\Form\Element\Checkbox;
 use Laminas\Form\Element\Csrf;
 use Laminas\Form\Element\Submit;
-use Laminas\InputFilter\InputFilterInterface;
 use Laminas\Session\Container;
 
+/**
+ * @phpstan-import-type DeleteAdminDataType from DeleteAdminInputFilter
+ * @extends AbstractForm<DeleteAdminDataType>
+ */
 class DeleteAdminForm extends AbstractForm
 {
+    /**
+     * @param array<non-empty-string, mixed> $options
+     */
     public function __construct(?string $name = null, array $options = [])
     {
         parent::__construct($name, $options);
@@ -53,9 +59,4 @@ public function init(): void
                 ->setAttribute('class', 'btn btn-sm btn-danger')
         );
     }
-
-    public function getInputFilter(): InputFilterInterface
-    {
-        return $this->inputFilter;
-    }
 }

src/Admin/src/Form/EditAdminForm.php

@@ -13,13 +13,18 @@
 use Laminas\Form\Element\Select;
 use Laminas\Form\Element\Submit;
 use Laminas\Form\Element\Text;
-use Laminas\InputFilter\InputFilterInterface;
 use Laminas\Session\Container;
 
+/**
+ * @phpstan-import-type EditAdminDataType from EditAdminInputFilter
+ * @phpstan-import-type SelectDataType from AbstractForm
+ * @extends AbstractForm<EditAdminDataType>
+ */
 class EditAdminForm extends AbstractForm
 {
-    protected InputFilterInterface $inputFilter;
-
+    /**
+     * @param array<non-empty-string, mixed> $options
+     */
     public function __construct(?string $name = null, array $options = [])
     {
         parent::__construct($name, $options);
@@ -34,6 +39,9 @@ public function __construct(?string $name = null, array $options = [])
         $this->inputFilter->init();
     }
 
+    /**
+     * @phpstan-param SelectDataType[] $roles
+     */
     public function setRoles(array $roles): self
     {
         return $this->add(
@@ -81,9 +89,4 @@ public function init(): void
                 ->setAttribute('class', 'btn btn-sm btn-primary')
         );
     }
-
-    public function getInputFilter(): InputFilterInterface
-    {
-        return $this->inputFilter;
-    }
 }

src/Admin/src/Form/LoginForm.php

@@ -10,11 +10,17 @@
 use Laminas\Form\Element\Password;
 use Laminas\Form\Element\Submit;
 use Laminas\Form\Element\Text;
-use Laminas\InputFilter\InputFilterInterface;
 use Laminas\Session\Container;
 
+/**
+ * @phpstan-import-type LoginDataType from LoginInputFilter
+ * @extends AbstractForm<LoginDataType>
+ */
 class LoginForm extends AbstractForm
 {
+    /**
+     * @param array<non-empty-string, mixed> $options
+     */
     public function __construct(?string $name = null, array $options = [])
     {
         parent::__construct($name, $options);
@@ -57,9 +63,4 @@ public function init(): void
                 ->setAttribute('class', 'btn btn-primary')
         );
     }
-
-    public function getInputFilter(): InputFilterInterface
-    {
-        return $this->inputFilter;
-    }
 }