Let PHPStan check array and iterable types & generics

phpstan.neon

@@ -1,7 +1,5 @@
 parameters:
   level: max
-  checkMissingIterableValueType: false
-  checkGenericClassInNonGenericObjectType: false
   paths:
     - src/batch/src/
     - src/batch-box-spout/src/

src/batch-box-spout/src/FlatFileReader.php

@@ -38,7 +38,7 @@ final class FlatFileReader implements
     private string $type;
 
     /**
-     * @var array
+     * @phpstan-var array{delimiter?: string, enclosure?: string}
      */
     private array $options;
 
@@ -48,7 +48,7 @@ final class FlatFileReader implements
     private string $headersMode;
 
     /**
-     * @var array|null
+     * @phpstan-var list<string>|null
      */
     private ?array $headers;
 
@@ -57,6 +57,10 @@ final class FlatFileReader implements
      */
     private ?string $filePath;
 
+    /**
+     * @phpstan-param array{delimiter?: string, enclosure?: string} $options
+     * @phpstan-param list<string>|null                             $headers
+     */
     public function __construct(
         string $type,
         array $options = [],

src/batch-box-spout/src/FlatFileWriter.php

@@ -33,7 +33,7 @@ final class FlatFileWriter implements
     private string $type;
 
     /**
-     * @var array|null
+     * @phpstan-var list<string>|null
      */
     private ?array $headers;
 
@@ -53,10 +53,14 @@ final class FlatFileWriter implements
     private ?string $filePath;
 
     /**
-     * @var array
+     * @phpstan-var array{delimiter?: string, enclosure?: string}
      */
     private array $options;
 
+    /**
+     * @phpstan-param list<string>|null                             $headers
+     * @phpstan-param array{delimiter?: string, enclosure?: string} $options
+     */
     public function __construct(string $type, array $headers = null, string $filePath = null, array $options = [])
     {
         $this->type = $type;

src/batch-doctrine-dbal/src/DoctrineDBALJobExecutionStorage.php

@@ -11,6 +11,7 @@
 use Doctrine\DBAL\Schema\Schema;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Persistence\ConnectionRegistry;
+use Generator;
 use Yokai\Batch\Exception\CannotStoreJobExecutionException;
 use Yokai\Batch\Exception\JobExecutionNotFoundException;
 use Yokai\Batch\Exception\RuntimeException;
@@ -36,11 +37,11 @@ final class DoctrineDBALJobExecutionStorage implements QueryableJobExecutionStor
      */
     private string $table;
 
+    private JobExecutionRowNormalizer $normalizer;
+
     /**
-     * @var JobExecutionRowNormalizer|null
+     * @phpstan-param array{connection?: string, table?: string} $options
      */
-    private ?JobExecutionRowNormalizer $normalizer = null;
-
     public function __construct(ConnectionRegistry $doctrine, array $options)
     {
         $options = array_filter($options) + self::DEFAULT_OPTIONS;
@@ -230,6 +231,9 @@ private function getSchema(): Schema
         return $schema;
     }
 
+    /**
+     * @phpstan-return array<string, string>
+     */
     private function types(): array
     {
         return [
@@ -247,6 +251,9 @@ private function types(): array
         ];
     }
 
+    /**
+     * @phpstan-return array<string, string>
+     */
     private function identity(JobExecution $execution): array
     {
         return [
@@ -255,6 +262,9 @@ private function identity(JobExecution $execution): array
         ];
     }
 
+    /**
+     * @phpstan-return array<string, string>
+     */
     private function fetchRow(string $jobName, string $id): array
     {
         $qb = $this->connection->createQueryBuilder();
@@ -289,7 +299,13 @@ private function fetchRow(string $jobName, string $id): array
         }
     }
 
-    private function queryList(string $query, array $parameters, array $types): iterable
+    /**
+     * @phpstan-param array<string, mixed>      $parameters
+     * @phpstan-param array<string, int|string> $types
+     *
+     * @phpstan-return Generator<JobExecution>
+     */
+    private function queryList(string $query, array $parameters, array $types): Generator
     {
         /** @var Result $statement */
         $statement = $this->connection->executeQuery($query, $parameters, $types);
@@ -301,21 +317,25 @@ private function queryList(string $query, array $parameters, array $types): iter
         $statement->free();
     }
 
+    /**
+     * @phpstan-return array<string, mixed>
+     */
     private function toRow(JobExecution $jobExecution): array
     {
         return $this->getNormalizer()->toRow($jobExecution);
     }
 
+    /**
+     * @phpstan-param array<string, mixed> $row
+     */
     private function fromRow(array $row): JobExecution
     {
         return $this->getNormalizer()->fromRow($row);
     }
 
     private function getNormalizer(): JobExecutionRowNormalizer
     {
-        if ($this->normalizer === null) {
-            $this->normalizer = new JobExecutionRowNormalizer($this->connection->getDatabasePlatform());
-        }
+        $this->normalizer ??= new JobExecutionRowNormalizer($this->connection->getDatabasePlatform());
 
         return $this->normalizer;
     }

src/batch-doctrine-dbal/src/DoctrineDBALQueryReader.php

@@ -40,6 +40,7 @@ public function __construct(ConnectionRegistry $doctrine, string $sql, string $c
 
     /**
      * @inheritdoc
+     * @phpstan-return Generator<array<string, string>>
      */
     public function read(): Generator
     {

src/batch-doctrine-dbal/src/JobExecutionRowNormalizer.php

@@ -31,6 +31,9 @@ public function __construct(AbstractPlatform $platform)
         $this->platform = $platform;
     }
 
+    /**
+     * @phpstan-return array<string, mixed>
+     */
     public function toRow(JobExecution $jobExecution): array
     {
         return [
@@ -48,6 +51,9 @@ public function toRow(JobExecution $jobExecution): array
         ];
     }
 
+    /**
+     * @phpstan-param array<string, mixed> $data
+     */
     public function fromRow(array $data, JobExecution $parent = null): JobExecution
     {
         $data['status'] = intval($data['status']);
@@ -93,6 +99,9 @@ public function fromRow(array $data, JobExecution $parent = null): JobExecution
         return $jobExecution;
     }
 
+    /**
+     * @phpstan-return array<string, mixed>
+     */
     public function toChildRow(JobExecution $jobExecution): array
     {
         return [
@@ -112,6 +121,9 @@ public function toChildRow(JobExecution $jobExecution): array
      * @param array|string $value
      *
      * @return array
+     *
+     * @phpstan-param array<int|string, mixed>|string $value
+     * @phpstan-return array<int|string, mixed>
      */
     private function jsonFromString($value): array
     {
@@ -135,6 +147,9 @@ private function dateFromString(?string $date): ?DateTimeImmutable
         return DateTimeImmutable::createFromFormat($this->platform->getDateTimeFormatString(), $date) ?: null;
     }
 
+    /**
+     * @phpstan-return array<string, mixed>
+     */
     private function failureToArray(Failure $failure): array
     {
         return [
@@ -146,6 +161,9 @@ private function failureToArray(Failure $failure): array
         ];
     }
 
+    /**
+     * @phpstan-param array<string, mixed> $array
+     */
     private function failureFromArray(array $array): Failure
     {
         return new Failure(
@@ -157,6 +175,9 @@ private function failureFromArray(array $array): Failure
         );
     }
 
+    /**
+     * @phpstan-return array<string, mixed>
+     */
     private function warningToArray(Warning $warning): array
     {
         return [
@@ -166,6 +187,9 @@ private function warningToArray(Warning $warning): array
         ];
     }
 
+    /**
+     * @phpstan-param array<string, mixed> $array
+     */
     private function warningFromArray(array $array): Warning
     {
         return new Warning($array['message'], $array['parameters'], $array['context']);

src/batch-symfony-console/src/CommandRunner.php

@@ -35,18 +35,15 @@ public function __construct(string $binDir, string $logDir, PhpExecutableFinder
     }
 
     /**
-     * @param string $commandName
-     * @param array  $arguments
+     * @phpstan-param array<string, mixed> $arguments
      */
     public function run(string $commandName, array $arguments = []): void
     {
         $this->exec($this->buildCommand($commandName, $arguments));
     }
 
     /**
-     * @param string $commandName
-     * @param string $logFilename
-     * @param array  $arguments
+     * @phpstan-param array<string, mixed> $arguments
      */
     public function runAsync(string $commandName, string $logFilename, array $arguments = []): void
     {
@@ -64,6 +61,9 @@ protected function exec(string $command): void
         exec($command);
     }
 
+    /**
+     * @phpstan-param array<string, mixed> $arguments
+     */
     private function buildCommand(string $commandName, array $arguments): string
     {
         return sprintf(

src/batch-symfony-console/src/RunJobCommand.php

@@ -15,6 +15,8 @@
 
 final class RunJobCommand extends Command
 {
+    protected static $defaultName = 'yokai:batch:run';
+
     public const EXIT_SUCCESS_CODE = 0;
     public const EXIT_ERROR_CODE = 1;
     public const EXIT_WARNING_CODE = 2;
@@ -29,7 +31,7 @@ final class RunJobCommand extends Command
      */
     public function __construct(JobLauncherInterface $jobLauncher)
     {
-        parent::__construct(null);
+        parent::__construct();
         $this->jobLauncher = $jobLauncher;
     }
 
@@ -38,10 +40,8 @@ public function __construct(JobLauncherInterface $jobLauncher)
      */
     protected function configure(): void
     {
-        $this
-            ->setName('yokai:batch:run')
-            ->addArgument('job', InputArgument::REQUIRED)
-            ->addArgument('configuration', InputArgument::OPTIONAL);
+        $this->addArgument('job', InputArgument::REQUIRED);
+        $this->addArgument('configuration', InputArgument::OPTIONAL);
     }
 
     /**
@@ -118,6 +118,8 @@ private function outputExecution(JobExecution $jobExecution, OutputInterface $ou
      *
      * @throws InvalidArgumentException
      * @return array
+     *
+     * @phpstan-return array<string, mixed>
      */
     private function decodeConfiguration(string $data): array
     {

src/batch-symfony-framework/src/DependencyInjection/YokaiBatchExtension.php

@@ -24,6 +24,7 @@ final class YokaiBatchExtension extends Extension
 {
     /**
      * @inheritDoc
+     * @phpstan-param list<array<string, mixed>> $configs
      */
     public function load(array $configs, ContainerBuilder $container): void
     {
@@ -79,6 +80,9 @@ private function getLoader(ContainerBuilder $container): ConfigLoader\LoaderInte
         return new ConfigLoader\DelegatingLoader($resolver);
     }
 
+    /**
+     * @param array<string, mixed> $config
+     */
     private function configureStorage(ContainerBuilder $container, array $config): void
     {
         if (isset($config['service'])) {

src/batch-symfony-messenger/src/LaunchJobMessage.php

@@ -12,10 +12,13 @@ final class LaunchJobMessage
     private string $jobName;
 
     /**
-     * @var array
+     * @phpstan-var array<string, mixed>
      */
     private array $configuration;
 
+    /**
+     * @phpstan-param array<string, mixed> $configuration
+     */
     public function __construct(string $jobName, array $configuration = [])
     {
         $this->jobName = $jobName;
@@ -27,6 +30,9 @@ public function getJobName(): string
         return $this->jobName;
     }
 
+    /**
+     * @phpstan-return array<string, mixed>
+     */
     public function getConfiguration(): array
     {
         return $this->configuration;

src/batch-symfony-serializer/src/DenormalizeItemProcessor.php

@@ -27,10 +27,13 @@ final class DenormalizeItemProcessor implements ItemProcessorInterface
     private ?string $format;
 
     /**
-     * @var array
+     * @phpstan-var array<string, mixed>
      */
     private array $context;
 
+    /**
+     * @phpstan-param array<string, mixed> $context
+     */
     public function __construct(
         DenormalizerInterface $denormalizer,
         string $type,

src/batch-symfony-serializer/src/NormalizeItemProcessor.php

@@ -22,10 +22,13 @@ final class NormalizeItemProcessor implements ItemProcessorInterface
     private ?string $format;
 
     /**
-     * @var array
+     * @phpstan-var array<string, mixed>
      */
     private array $context;
 
+    /**
+     * @phpstan-param array<string, mixed> $context
+     */
     public function __construct(NormalizerInterface $normalizer, string $format = null, array $context = [])
     {
         $this->normalizer = $normalizer;