Fix PHPStan errors.

Author: Pierre Tondereau

.travis.yml

@@ -24,21 +24,21 @@ matrix:
       env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest" EXECUTE_CS_CHECK=true COVERAGE=true
     - php: 7.2
     - php: 7.3
-      env: SYMFONY_REQUIRE="4.4.*"
+      env: SYMFONY_REQUIRE="4.3.*"
     - php: 7.4
-      env: SYMFONY_REQUIRE="4.4.*"
+      env: SYMFONY_REQUIRE="4.3.*"
     - php: 7.4
       env: SYMFONY_REQUIRE="5.0.*"
     - php: 7.4
       env: SYMFONY_REQUIRE="5.1.*@dev"
     - php: nightly
-      env: SYMFONY_REQUIRE="4.4.*"
+      env: SYMFONY_REQUIRE="4.3.*"
   allow_failures:
     # Allow failures on next Symfony minor, should always be tested on newest stable PHP branch
     - php: 7.4
       env: SYMFONY_REQUIRE="5.1.*@dev"
     - php: nightly
-      env: SYMFONY_REQUIRE="4.4.*"
+      env: SYMFONY_REQUIRE="4.3.*"
 
 before_install:
   - phpenv config-rm xdebug.ini || return 0

composer.json

@@ -72,7 +72,8 @@
     "prooph/php-cs-fixer-config": "^0.2.1",
     "matthiasnoback/symfony-dependency-injection-test": "^4.1",
     "phpstan/phpstan": "^0.12",
-    "symfony/messenger": "^4.3 || ^5.0"
+    "symfony/messenger": "^4.3 || ^5.0",
+    "phpstan/phpstan-symfony": "^0.12.1"
   },
   "suggest": {
     "prooph/event-store-bus-bridge": "To Marry CQRS (ProophSerivceBus) with Event Sourcing"

phpstan.neon

@@ -1,5 +1,7 @@
 parameters:
     reportUnmatchedIgnoredErrors: false
+    checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false
     ignoreErrors:
         # Only available in ArrayNodeDefinition which is given
         - '#Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::children\(\)\.#'
@@ -9,6 +11,7 @@ parameters:
         # TreeBuilder in Symfony 4.2 and up has a constructor and a getRootNode() method
         - '#Class Symfony\\Component\\Config\\Definition\\Builder\\TreeBuilder does not have a constructor and must be instantiated without any parameters\.#'
         - '#Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\TreeBuilder::getRootNode\(\)#'
+        - '#Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\TreeBuilder::root\(\)#'
         # More Symfony 4.2 compatibility errors
         - '#Parameter \#2 \$deleteEmittedEvents of method Prooph\\EventStore\\Projection\\ProjectionManager::deleteProjection\(\) expects bool, array<string>\|bool\|string\|null given\.#'
         - '#Property Prooph\\Bundle\\EventStore\\Command\\AbstractProjectionCommand::\$projectionName \(string\) does not accept array<string>\|string\|null\.#'
@@ -18,4 +21,5 @@ parameters:
         # MariaDbEventStore is available since pdo-event-store v1.3
         - '#Class Prooph\\EventStore\\Pdo\\MariaDbEventStore not found\.#'
         - '#Method Prooph\\Bundle\\EventStore\\ProjectionManagerFactory::createProjectionManager\(\) should return Prooph\\EventStore\\Projection\\ProjectionManager but returns Prooph\\EventStore\\Pdo\\Projection\\MariaDbProjectionManager\.#'
-        - '#Instantiated class Prooph\\EventStore\\Pdo\\Projection\\MariaDbProjectionManager not found\.#'
+        - '#Instantiated class Prooph\\EventStore\\Pdo\\Projection\\MariaDbProjectionManager not found\.#'
+        - '#Parameter \#1 $argument of class ReflectionClass constructor expects class-string<T of object>\|T of object, string\|null given.#'

src/Command/AbstractProjectionCommand.php

@@ -75,12 +75,12 @@ public function __construct(
         parent::__construct();
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this->addArgument(static::ARGUMENT_PROJECTION_NAME, InputArgument::REQUIRED, 'The name of the Projection');
     }
 
-    protected function initialize(InputInterface $input, OutputInterface $output)
+    protected function initialize(InputInterface $input, OutputInterface $output): void
     {
         $input->validate();
 
@@ -89,18 +89,18 @@ protected function initialize(InputInterface $input, OutputInterface $output)
         $this->projectionName = $input->getArgument(static::ARGUMENT_PROJECTION_NAME);
 
         if (! $this->projectionManagerForProjectionsLocator->has($this->projectionName)) {
-            throw new RuntimeException(\sprintf('ProjectionManager for "%s" not found', $this->projectionName));
+            throw new RuntimeException(\vsprintf('ProjectionManager for "%s" not found', is_array($this->projectionName) ? $this->projectionName : [$this->projectionName]));
         }
         $this->projectionManager = $this->projectionManagerForProjectionsLocator->get($this->projectionName);
 
         if (! $this->projectionsLocator->has($this->projectionName)) {
-            throw new RuntimeException(\sprintf('Projection "%s" not found', $this->projectionName));
+            throw new RuntimeException(\vsprintf('Projection "%s" not found', is_array($this->projectionName) ? $this->projectionName : [$this->projectionName]));
         }
         $this->projection = $this->projectionsLocator->get($this->projectionName);
 
         if ($this->projection instanceof ReadModelProjection) {
             if (! $this->projectionReadModelLocator->has($this->projectionName)) {
-                throw new RuntimeException(\sprintf('ReadModel for "%s" not found', $this->projectionName));
+                throw new RuntimeException(\vsprintf('ReadModel for "%s" not found', is_array($this->projectionName) ? $this->projectionName : [$this->projectionName]));
             }
             $this->readModel = $this->projectionReadModelLocator->get($this->projectionName);
 
@@ -114,7 +114,7 @@ protected function initialize(InputInterface $input, OutputInterface $output)
         if (null === $this->projector) {
             throw new RuntimeException('Projection was not created');
         }
-        $output->writeln(\sprintf('<header>Initialized projection "%s"</header>', $this->projectionName));
+        $output->writeln(\vsprintf('<header>Initialized projection "%s"</header>', is_array($this->projectionName) ? $this->projectionName : [$this->projectionName]));
         try {
             $state = $this->projectionManager->fetchProjectionStatus($this->projectionName)->getValue();
         } catch (\Prooph\EventStore\Exception\RuntimeException $e) {

src/Command/FormatsOutput.php

@@ -9,7 +9,7 @@
 
 trait FormatsOutput
 {
-    protected function formatOutput(OutputInterface $output)
+    protected function formatOutput(OutputInterface $output): void
     {
         $outputFormatter = $output->getFormatter();
         $outputFormatter->setStyle('header', new OutputFormatterStyle('green', null));

src/Command/ProjectionDeleteCommand.php

@@ -12,7 +12,7 @@ class ProjectionDeleteCommand extends AbstractProjectionCommand
 {
     protected const OPTION_WITH_EVENTS = 'with-emitted-events';
 
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
         $this
@@ -21,7 +21,7 @@ protected function configure()
             ->addOption(static::OPTION_WITH_EVENTS, 'w', InputOption::VALUE_NONE, 'Delete with emitted events');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $withEvents = $input->getOption(self::OPTION_WITH_EVENTS);
         if ($withEvents) {
@@ -30,5 +30,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $output->writeln(\sprintf('<action>Deleting projection </action><highlight>%s</highlight>', $this->projectionName));
         }
         $this->projectionManager->deleteProjection($this->projectionName, $withEvents);
+
+        return 0;
     }
 }

src/Command/ProjectionNamesCommand.php

@@ -40,7 +40,7 @@ public function __construct(ContainerInterface $projectionManagersLocator, array
         parent::__construct();
     }
 
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName('event-store:projection:names')
@@ -64,6 +64,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             });
         }
 
+        /** @var string|null $filter */
         $filter = $input->getArgument(self::ARGUMENT_FILTER);
         $regex = $input->getOption(static::OPTION_REGEX);
 
@@ -80,8 +81,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $output->writeln('</action>');
 
         $names = [];
-        $offset = (int) $input->getOption(self::OPTION_OFFSET);
-        $limit = (int) $input->getOption(self::OPTION_LIMIT);
+        /** @var int $offset */
+        $offset = $input->getOption(self::OPTION_OFFSET);
+        /** @var int $limit */
+        $limit = $input->getOption(self::OPTION_LIMIT);
         $maxNeeded = $offset + $limit;
 
         foreach ($managerNames as $managerName) {

src/Command/ProjectionResetCommand.php

@@ -9,7 +9,7 @@
 
 class ProjectionResetCommand extends AbstractProjectionCommand
 {
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
         $this

src/Command/ProjectionStateCommand.php

@@ -9,7 +9,7 @@
 
 class ProjectionStateCommand extends AbstractProjectionCommand
 {
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
         $this
@@ -20,7 +20,10 @@ protected function configure()
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $output->writeln('<action>Current state:</action>');
-        $output->writeln(\json_encode($this->projectionManager->fetchProjectionState($this->projectionName)));
+
+        /** @var string $state */
+        $state = \json_encode($this->projectionManager->fetchProjectionState($this->projectionName));
+        $output->writeln($state);
 
         return 0;
     }

src/Command/ProjectionStopCommand.php

@@ -9,7 +9,7 @@
 
 class ProjectionStopCommand extends AbstractProjectionCommand
 {
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
         $this

src/Command/ProjectionStreamPositionsCommand.php

@@ -10,7 +10,7 @@
 
 class ProjectionStreamPositionsCommand extends AbstractProjectionCommand
 {
-    protected function configure()
+    protected function configure(): void
     {
         parent::configure();
         $this

src/DependencyInjection/Compiler/MetadataEnricherPass.php

@@ -18,7 +18,7 @@
 
 class MetadataEnricherPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (! $container->hasParameter('prooph_event_store.stores')) {
             return;
@@ -30,6 +30,8 @@ public function process(ContainerBuilder $container)
 
         foreach ($stores as $name => $store) {
             $storeEnricherPlugins = $container->findTaggedServiceIds(\sprintf('prooph_event_store.%s.metadata_enricher', $name));
+
+            /** @var array<string, string> $plugins */
             $plugins = \array_merge($globalPlugins, $storeEnricherPlugins);
             $enrichers = [];
 

src/DependencyInjection/Compiler/PluginLocatorPass.php

@@ -13,7 +13,7 @@
 
 final class PluginLocatorPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (! $container->hasParameter('prooph_event_store.stores')) {
             return;
@@ -28,6 +28,7 @@ public function process(ContainerBuilder $container)
             $storePlugins[] = $container->findTaggedServiceIds(\sprintf('prooph_event_store.%s.plugin', $name));
         }
 
+        /** @var array<string, string> $plugins */
         $plugins = \array_merge($globalPlugins, ...$storePlugins);
 
         $locatorPlugins = [];

src/DependencyInjection/Compiler/PluginsPass.php

@@ -16,7 +16,7 @@
 
 class PluginsPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (! $container->hasParameter('prooph_event_store.stores')) {
             return;

src/DependencyInjection/Compiler/RegisterProjectionsPass.php

@@ -39,7 +39,9 @@ public function process(ContainerBuilder $container): void
 
         foreach ($projectionIds as $id) {
             $projectorDefinition = $container->getDefinition($id);
-            $projectionClass = new ReflectionClass($projectorDefinition->getClass());
+            /** @var object $projectorDefinitionClass */
+            $projectorDefinitionClass = $projectorDefinition->getClass();
+            $projectionClass = new ReflectionClass($projectorDefinitionClass);
 
             self::assertProjectionHasAValidClass($id, $projectionClass);
 

src/DependencyInjection/ProophEventStoreExtension.php

@@ -134,7 +134,7 @@ private static function collectProjectionsForLocators(
      * @param array            $config
      * @param ContainerBuilder $container
      */
-    private function loadEventStores(string $class, array $config, ContainerBuilder $container)
+    private function loadEventStores(string $class, array $config, ContainerBuilder $container): void
     {
         $eventStores = [];
 
@@ -163,7 +163,7 @@ private function loadEventStores(string $class, array $config, ContainerBuilder
      * @throws \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
      * @throws \Prooph\Bundle\EventStore\Exception\RuntimeException
      */
-    private function loadEventStore(string $name, array $options, ContainerBuilder $container)
+    private function loadEventStore(string $name, array $options, ContainerBuilder $container): void
     {
         $eventStoreId = 'prooph_event_store.'.$name;
         $eventStoreDefinition = $container

src/ProophEventStoreBundle.php

@@ -21,7 +21,7 @@
 
 final class ProophEventStoreBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

src/RepositoryFactory.php

@@ -19,6 +19,9 @@
 
 class RepositoryFactory
 {
+    /**
+     * @return mixed
+     */
     public function create(
         string $repositoryClass,
         EventStore $eventStore,