Issue #415: Increased PHPStan level to 8

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,7 +2,7 @@ includes:
     - vendor/phpstan/phpstan-doctrine/extension.neon
     - vendor/phpstan/phpstan-phpunit/extension.neon
 parameters:
-    level: 5
+    level: 8
     paths:
         - bin
         - config

src/Admin/src/Command/AdminCreateCommand.php

@@ -25,6 +25,7 @@
 
 use function implode;
 use function sprintf;
+use function trim;
 
 use const PHP_EOL;
 
@@ -75,6 +76,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $messages = [];
             foreach ($inputFilter->getMessages() as $field => $errors) {
                 foreach ($errors as $error) {
+                    /** @var scalar $error */
                     $messages[] = sprintf('%s: %s', $field, $error);
                 }
             }
@@ -90,6 +92,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     }
 
     /**
+     * @return array{
+     *     identity: string,
+     *     password: string,
+     *     passwordConfirm: string,
+     *     firstName: string,
+     *     lastName: string,
+     *     status: 'active',
+     *     roles: array{uuid: non-empty-string}[],
+     * }
      * @throws Exception
      */
     private function getData(InputInterface $input): array
@@ -100,11 +111,11 @@ private function getData(InputInterface $input): array
         }
 
         return [
-            'identity'        => $input->getOption('identity'),
-            'password'        => $input->getOption('password'),
-            'passwordConfirm' => $input->getOption('password'),
-            'firstName'       => $input->getOption('firstName'),
-            'lastName'        => $input->getOption('lastName'),
+            'identity'        => trim($input->getOption('identity')),
+            'password'        => trim($input->getOption('password')),
+            'passwordConfirm' => trim($input->getOption('password')),
+            'firstName'       => trim($input->getOption('firstName')),
+            'lastName'        => trim($input->getOption('lastName')),
             'status'          => AdminStatusEnum::Active->value,
             'roles'           => [
                 ['uuid' => $adminRole->getUuid()->toString()],

src/Admin/src/ConfigProvider.php

@@ -28,8 +28,22 @@
 use Mezzio\Application;
 use Mezzio\Hal\Metadata\MetadataMap;
 
+/**
+ * @phpstan-import-type MetadataType from AppConfigProvider
+ * @phpstan-type DependenciesType array{
+ *     delegators: array<class-string, class-string[]>,
+ *     factories: array<class-string, class-string>,
+ *     aliases: array<class-string, class-string>,
+ * }
+ */
 class ConfigProvider
 {
+    /**
+     * @return array{
+     *     dependencies: DependenciesType,
+     *     "Mezzio\Hal\Metadata\MetadataMap": MetadataType[],
+     * }
+     */
     public function __invoke(): array
     {
         return [
@@ -38,6 +52,9 @@ public function __invoke(): array
         ];
     }
 
+    /**
+     * @return DependenciesType
+     */
     private function getDependencies(): array
     {
         return [
@@ -74,6 +91,9 @@ private function getDependencies(): array
         ];
     }
 
+    /**
+     * @return MetadataType[]
+     */
     private function getHalConfig(): array
     {
         return [

src/Admin/src/Handler/Account/PatchAdminAccountResourceHandler.php

@@ -43,12 +43,12 @@ public function handle(ServerRequestInterface $request): ResponseInterface
             );
         }
 
+        /** @var non-empty-array<non-empty-string, mixed> $data */
+        $data = (array) $this->inputFilter->getValues();
+
         return $this->createResponse(
             $request,
-            $this->adminService->saveAdmin(
-                (array) $this->inputFilter->getValues(),
-                $request->getAttribute(IdentityInterface::class)
-            )
+            $this->adminService->saveAdmin($data, $request->getAttribute(IdentityInterface::class))
         );
     }
 }

src/Admin/src/Handler/Admin/PatchAdminResourceHandler.php

@@ -45,12 +45,12 @@ public function handle(ServerRequestInterface $request): ResponseInterface
             );
         }
 
+        /** @var non-empty-array<non-empty-string, mixed> $data */
+        $data = (array) $this->inputFilter->getValues();
+
         return $this->createResponse(
             $request,
-            $this->adminService->saveAdmin(
-                (array) $this->inputFilter->getValues(),
-                $request->getAttribute(Admin::class)
-            )
+            $this->adminService->saveAdmin($data, $request->getAttribute(Admin::class))
         );
     }
 }

src/Admin/src/Handler/Admin/PostAdminResourceHandler.php

@@ -42,9 +42,9 @@ public function handle(ServerRequestInterface $request): ResponseInterface
             );
         }
 
-        return $this->createdResponse(
-            $request,
-            $this->adminService->saveAdmin((array) $this->inputFilter->getValues())
-        );
+        /** @var non-empty-array<non-empty-string, mixed> $data */
+        $data = (array) $this->inputFilter->getValues();
+
+        return $this->createdResponse($request, $this->adminService->saveAdmin($data));
     }
 }

src/Admin/src/Service/AdminRoleService.php

@@ -43,7 +43,7 @@ public function findAdminRole(string $id): AdminRole
     }
 
     /**
-     * @param array<string, mixed> $params
+     * @param array<non-empty-string, mixed> $params
      */
     public function getAdminRoles(array $params): QueryBuilder
     {

src/Admin/src/Service/AdminRoleServiceInterface.php

@@ -19,7 +19,7 @@ public function getAdminRoleRepository(): AdminRoleRepository;
     public function findAdminRole(string $id): AdminRole;
 
     /**
-     * @param array<string, mixed> $params
+     * @param array<non-empty-string, mixed> $params
      */
     public function getAdminRoles(array $params): QueryBuilder;
 }

src/Admin/src/Service/AdminService.php

@@ -58,7 +58,7 @@ public function findAdmin(string $uuid): Admin
     }
 
     /**
-     * @param array<string, mixed> $params
+     * @param array<non-empty-string, mixed> $params
      */
     public function getAdmins(array $params): QueryBuilder
     {
@@ -82,6 +82,7 @@ public function getAdmins(array $params): QueryBuilder
     }
 
     /**
+     * @param non-empty-array<non-empty-string, mixed> $data
      * @throws BadRequestException
      * @throws ConflictException
      * @throws NotFoundException
@@ -118,7 +119,7 @@ public function saveAdmin(array $data, ?Admin $admin = null): Admin
             $admin->setStatus($status);
         }
 
-        $this->validateUniqueAdmin($admin->getIdentity(), $admin->getUuid());
+        $this->validateUniqueAdmin((string) $admin->getIdentity(), $admin->getUuid());
 
         if (array_key_exists('roles', $data) && count($data['roles']) > 0) {
             $admin->resetRoles();

src/Admin/src/Service/AdminServiceInterface.php

@@ -23,11 +23,12 @@ public function deleteAdmin(Admin $admin): void;
     public function findAdmin(string $uuid): Admin;
 
     /**
-     * @param array<string, mixed> $params
+     * @param array<non-empty-string, mixed> $params
      */
     public function getAdmins(array $params): QueryBuilder;
 
     /**
+     * @param non-empty-array<non-empty-string, mixed> $data
      * @throws BadRequestException
      * @throws ConflictException
      * @throws NotFoundException

src/App/src/Attribute/BaseDeprecation.php

@@ -10,6 +10,9 @@
 
 readonly class BaseDeprecation
 {
+    /**
+     * @throws SunsetException
+     */
     public function __construct(
         public ?string $sunset = null,
         public ?string $link = null,
@@ -18,10 +21,20 @@ public function __construct(
         public string $type = 'text/html',
     ) {
         if (null !== $sunset && ! (new Date())->isValid($sunset)) {
-            throw new SunsetException(Message::invalidValue('sunset'));
+            throw SunsetException::create(Message::invalidValue('sunset'));
         }
     }
 
+    /**
+     * @return array{
+     *     sunset: string|null,
+     *     link: string|null,
+     *     rel: string,
+     *     type: string,
+     *     deprecationReason: string|null,
+     *     deprecationType: class-string,
+     * }
+     */
     public function toArray(): array
     {
         return [

src/App/src/ConfigProvider.php

@@ -30,15 +30,45 @@
 use Mezzio\Hal\Metadata\RouteBasedResourceMetadata;
 use Mezzio\ProblemDetails\ProblemDetailsMiddleware;
 
+/**
+ * @phpstan-type CollectionType array{
+ *      __class__: class-string,
+ *      collection_class: class-string,
+ *      collection_relation: non-empty-string,
+ *      route: non-empty-string,
+ *  }
+ * @phpstan-type ResourceType array{
+ *      __class__: class-string,
+ *      resource_class: class-string,
+ *      route: non-empty-string,
+ *      extractor: class-string,
+ *      resource_identifier: non-empty-string,
+ *      route_identifier_placeholder: non-empty-string,
+ *  }
+ * @phpstan-type MetadataType CollectionType|ResourceType
+ * @phpstan-type DependenciesType array{
+ *      delegators: array<class-string, class-string[]>,
+ *      factories: array<class-string, class-string>,
+ *      aliases: array<class-string, class-string>,
+ *  }
+ */
 class ConfigProvider
 {
+    /**
+     * @return array{
+     *     dependencies: DependenciesType,
+     * }
+     */
     public function __invoke(): array
     {
         return [
             'dependencies' => $this->getDependencies(),
         ];
     }
 
+    /**
+     * @return DependenciesType
+     */
     private function getDependencies(): array
     {
         return [
@@ -73,6 +103,9 @@ private function getDependencies(): array
 
     /**
      * @param class-string $collectionClass
+     * @param non-empty-string $route
+     * @param non-empty-string $collectionRelation
+     * @return CollectionType
      */
     public static function getCollection(string $collectionClass, string $route, string $collectionRelation): array
     {
@@ -86,6 +119,10 @@ public static function getCollection(string $collectionClass, string $route, str
 
     /**
      * @param class-string $resourceClass
+     * @param non-empty-string $route
+     * @param non-empty-string $resourceIdentifier
+     * @param non-empty-string $resourceIdentifierPlaceholder
+     * @return ResourceType
      */
     public static function getResource(
         string $resourceClass,

src/App/src/Exception/BadRequestException.php

@@ -13,6 +13,10 @@ class BadRequestException extends Exception implements ProblemDetailsExceptionIn
 {
     use CommonProblemDetailsExceptionTrait;
 
+    /**
+     * @param non-empty-string $detail
+     * @param array<string, mixed> $additional
+     */
     public static function create(string $detail, string $type = '', string $title = '', array $additional = []): self
     {
         $exception = new self();

src/App/src/Exception/ConflictException.php

@@ -13,6 +13,10 @@ class ConflictException extends Exception implements ProblemDetailsExceptionInte
 {
     use CommonProblemDetailsExceptionTrait;
 
+    /**
+     * @param non-empty-string $detail
+     * @param array<string, mixed> $additional
+     */
     public static function create(string $detail, string $type = '', string $title = '', array $additional = []): self
     {
         $exception = new self();

src/App/src/Exception/ExpiredException.php

@@ -13,6 +13,10 @@ class ExpiredException extends Exception implements ProblemDetailsExceptionInter
 {
     use CommonProblemDetailsExceptionTrait;
 
+    /**
+     * @param non-empty-string $detail
+     * @param array<string, mixed> $additional
+     */
     public static function create(string $detail, string $type = '', string $title = '', array $additional = []): self
     {
         $exception = new self();

src/App/src/Exception/ForbiddenException.php

@@ -13,6 +13,10 @@ class ForbiddenException extends Exception implements ProblemDetailsExceptionInt
 {
     use CommonProblemDetailsExceptionTrait;
 
+    /**
+     * @param non-empty-string $detail
+     * @param array<string, mixed> $additional
+     */
     public static function create(string $detail, string $type = '', string $title = '', array $additional = []): self
     {
         $exception = new self();

src/App/src/Exception/NotAcceptableException.php

@@ -13,6 +13,10 @@ class NotAcceptableException extends Exception implements ProblemDetailsExceptio
 {
     use CommonProblemDetailsExceptionTrait;
 
+    /**
+     * @param non-empty-string $detail
+     * @param array<string, mixed> $additional
+     */
     public static function create(string $detail, string $type = '', string $title = '', array $additional = []): self
     {
         $exception = new self();

src/App/src/Exception/NotFoundException.php

@@ -13,6 +13,10 @@ class NotFoundException extends Exception implements ProblemDetailsExceptionInte
 {
     use CommonProblemDetailsExceptionTrait;
 
+    /**
+     * @param non-empty-string $detail
+     * @param array<string, mixed> $additional
+     */
     public static function create(string $detail, string $type = '', string $title = '', array $additional = []): self
     {
         $exception = new self();