Fix PHPStan and enable it in CI

.github/workflows/build.yml

@@ -158,9 +158,9 @@ jobs:
                 name: Validate database schema
                 run: (cd tests/Application && bin/console doctrine:schema:validate)
 
-            # -
-            #     name: Run PHPStan
-            #     run: bin/phpstan analyse -c phpstan.neon -l max src/
+            -
+                name: Run PHPStan
+                run: bin/phpstan analyse -c phpstan.neon
 
             # -
             #     name: Run PHPSpec

composer.json

@@ -5,10 +5,10 @@
     "license": "MIT",
     "require": {
         "php": "^7.3",
-        "sylius/sylius": "~1.8.0 || ~1.9.0",
         "portphp/portphp": "^1.2",
-        "symfony/stopwatch": "^4.4 || ^5.2",
-        "queue-interop/queue-interop": "^0.6.2 || ^0.7 || ^0.8"
+        "queue-interop/queue-interop": "^0.6.2 || ^0.7 || ^0.8",
+        "sylius/sylius": "~1.8.0 || ~1.9.0",
+        "symfony/stopwatch": "^4.4 || ^5.2"
     },
     "suggest": {
         "portphp/spreadsheet": "To support importing Excel and LibreOffice Calc files, use version ^1.1",
@@ -32,10 +32,11 @@
         "lakion/mink-debug-extension": "^1.2.3",
         "phpspec/phpspec": "^7.0",
         "phpstan/extension-installer": "^1.0",
-        "phpstan/phpstan": "0.12.82",
-        "phpstan/phpstan-doctrine": "0.12.33",
+        "phpstan/phpstan": "^0.12.82",
+        "phpstan/phpstan-doctrine": "^0.12.33",
         "phpstan/phpstan-strict-rules": "^0.12.0",
-        "phpstan/phpstan-webmozart-assert": "0.12.12",
+	"phpstan/phpstan-symfony": "^0.12.0",
+        "phpstan/phpstan-webmozart-assert": "^0.12.12",
         "phpunit/phpunit": "^9.5",
         "sensiolabs/security-checker": "^6.0",
         "sylius-labs/coding-standard": "^3.2",

phpstan.neon

@@ -1,7 +1,13 @@
 parameters:
+    level: max
+    paths:
+        - src
     reportUnmatchedIgnoredErrors: false
     checkMissingIterableValueType: false
 
+    symfony:
+       console_application_loader: src/FOSSyliusImportExportPlugin.php
+
     excludes_analyse:
         # Makes PHPStan crash
         - 'src/DependencyInjection/Configuration.php'

src/Command/ExportDataCommand.php

@@ -60,7 +60,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         /** @var string $exporter */
         $exporter = $input->getArgument('exporter');
 
-        if (empty($exporter)) {
+        if ('' === $exporter) {
             $this->listExporters($input, $output);
 
             return 0;
@@ -121,7 +121,7 @@ private function listExporters(InputInterface $input, OutputInterface $output, ?
 
         $list = [];
         foreach ($exporters as $exporter => $formats) {
-            // prints the exporterentity, implodes the types and outputs them in a form
+            // prints the exporter entity, implodes the types and outputs them in a form
             $list[] = sprintf(
                 '%s (formats: %s)',
                 $exporter,
@@ -132,7 +132,7 @@ private function listExporters(InputInterface $input, OutputInterface $output, ?
         $io = new SymfonyStyle($input, $output);
         $io->listing($list);
 
-        if ($errorMessage) {
+        if (null !== $errorMessage) {
             throw new \RuntimeException($errorMessage);
         }
     }

src/Command/ExportDataToMessageQueueCommand.php

@@ -46,15 +46,15 @@ protected function configure(): void
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output): void
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         /** @var string $exporter */
         $exporter = $input->getArgument('exporter');
 
-        if (empty($exporter)) {
+        if ('' === $exporter) {
             $this->listExporters($input, $output);
 
-            return;
+            return 0;
         }
 
         $domain = 'sylius';
@@ -82,6 +82,8 @@ protected function execute(InputInterface $input, OutputInterface $output): void
         $mqItemWriter = $this->container->get('sylius.message_queue_writer');
         $this->export($mqItemWriter, $name, $idsToExport, $exporter);
         $this->finishExport($items, 'message queue', $name, $output);
+
+        return 0;
     }
 
     private function listExporters(InputInterface $input, OutputInterface $output, ?string $errorMessage = null): void
@@ -110,7 +112,7 @@ private function listExporters(InputInterface $input, OutputInterface $output, ?
         $io = new SymfonyStyle($input, $output);
         $io->listing($list);
 
-        if ($errorMessage) {
+        if (null !== $errorMessage) {
             throw new \RuntimeException($errorMessage);
         }
     }

src/Command/ImportDataCommand.php

@@ -54,7 +54,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         /** @var string $importer */
         $importer = $input->getArgument('importer');
-        if (empty($importer)) {
+        if ('' === $importer) {
             $this->listImporters($input, $output);
 
             return 0;
@@ -104,7 +104,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io = new SymfonyStyle($input, $output);
 
         $details = $input->getOption('details');
-        if ($details) {
+        if ('' !== $details) {
             $imported = implode(', ', $result->getSuccessRows());
             $skipped = implode(', ', $result->getSkippedRows());
             $failed = implode(', ', $result->getFailedRows());
@@ -153,7 +153,7 @@ private function listImporters(InputInterface $input, OutputInterface $output, ?
         $io = new SymfonyStyle($input, $output);
         $io->listing($list);
 
-        if ($errorMessage) {
+        if (null !== $errorMessage) {
             throw new \RuntimeException($errorMessage);
         }
     }

src/Command/ImportDataFromMessageQueueCommand.php

@@ -51,7 +51,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         /** @var string $importer */
         $importer = $input->getArgument('importer');
 
-        if (empty($importer)) {
+        if ('' === $importer) {
             $this->listImporters($input, $output);
 
             return 0;
@@ -92,7 +92,7 @@ private function finishImport(string $name, OutputInterface $output): void
         $output->writeln($message);
     }
 
-    private function importJsonDataFromMessageQueue(ItemReaderInterface $mqItemReader, $importer, SingleDataArrayImporterInterface $service, OutputInterface $output, int $timeout): void
+    private function importJsonDataFromMessageQueue(ItemReaderInterface $mqItemReader, string $importer, SingleDataArrayImporterInterface $service, OutputInterface $output, int $timeout): void
     {
         $mqItemReader->initQueue('sylius.export.queue.' . $importer);
         $mqItemReader->readAndImport($service, $timeout);
@@ -124,7 +124,7 @@ private function listImporters(InputInterface $input, OutputInterface $output, ?
         $io = new SymfonyStyle($input, $output);
         $io->listing($list);
 
-        if ($errorMessage) {
+        if (null !== $errorMessage) {
             throw new \RuntimeException($errorMessage);
         }
     }

src/Controller/ExportDataController.php

@@ -126,11 +126,13 @@ private function getResourcesItems(ResourceGridView $resources): array
 
             for ($i = 0; $i < $data->getNbPages(); ++$i) {
                 $data->setCurrentPage($i + 1);
-                $results = array_merge($results, iterator_to_array($data->getCurrentPageResults()));
+                $results = array_merge($results, (array) $data->getCurrentPageResults());
             }
 
             return $results;
         }
+
+        return [];
     }
 
     /**

src/Controller/ImportDataController.php

@@ -72,7 +72,7 @@ public function importAction(Request $request): RedirectResponse
         }
         $referer = $request->headers->get('referer');
 
-        return new RedirectResponse($referer);
+        return new RedirectResponse($referer ?? '');
     }
 
     private function getForm(string $importerType): FormInterface

src/DependencyInjection/Compiler/RegisterExporterPass.php

@@ -45,12 +45,12 @@ public function process(ContainerBuilder $container): void
             $name = ExporterRegistry::buildServiceName($type, $format);
             $exportersRegistry->addMethodCall('register', [$name, new Reference($id)]);
 
-            if ($container->getParameter('sylius.exporter.web_ui')) {
+            if (null !== $container->getParameter('sylius.exporter.web_ui')) {
                 $this->registerTypeAndFormat($type, $format);
             }
         }
 
-        if ($container->getParameter('sylius.exporter.web_ui') && !empty($this->typesAndFormats)) {
+        if (null !==  $container->getParameter('sylius.exporter.web_ui') && (null !== $this->typesAndFormats && '' != $this->typesAndFormats)) {
             $this->registerEventListenersForExportButton($container);
         }
     }

src/DependencyInjection/Compiler/RegisterImporterPass.php

@@ -12,14 +12,17 @@
 
 final class RegisterImporterPass implements CompilerPassInterface
 {
+    /** @var string[] */
     private $eventHookNames = [
         'taxonomy' => 'app.block_event_listener.admin.taxon.create.after_content',
     ];
 
+    /** @var string[] */
     private $eventNames = [
         'taxonomy' => 'sonata.block.event.sylius.admin.taxon.create.after_content',
     ];
 
+    /** @var string[] */
     private $templateNames = [
         'taxonomy' => '@FOSSyliusImportExportPlugin/Taxonomy/import.html.twig',
     ];
@@ -50,7 +53,7 @@ public function process(ContainerBuilder $container): void
 
             $importersRegistry->addMethodCall('register', [$name, new Reference($id)]);
 
-            if ($container->getParameter('sylius.importer.web_ui')) {
+            if (null !== $container->getParameter('sylius.importer.web_ui')) {
                 $this->registerImportFormBlockEvent($container, $type);
             }
         }

src/DependencyInjection/ParameterBag/ParameterBag.php

@@ -16,15 +16,19 @@
 
 final class ParameterBag extends FrozenParameterBag implements ParameterBagInterface
 {
+    /** @var Container */
     private $container;
 
-    public function __construct(Container $container)
+    public function __construct(Container $container, array $parameters = [])
     {
+        parent::__construct($parameters);
         $this->container = $container;
     }
 
     /**
      * {@inheritdoc}
+     * 
+     * @return string[]
      */
     public function all()
     {
@@ -33,6 +37,8 @@ public function all()
 
     /**
      * {@inheritdoc}
+     *
+     * @param string $name
      */
     public function get($name)
     {
@@ -41,6 +47,8 @@ public function get($name)
 
     /**
      * {@inheritdoc}
+     *
+     * @param string $name
      */
     public function has($name)
     {

src/Exporter/JsonResourceExporter.php

@@ -9,24 +9,12 @@
 
 final class JsonResourceExporter extends ResourceExporter
 {
+    /** @var array[] */
     private $data = [];
 
     /** @var string */
     private $filename;
 
-    /**
-     * @param string[] $resourceKeys
-     */
-    public function __construct(
-        PluginPoolInterface $pluginPool,
-        array $resourceKeys,
-        ?TransformerPoolInterface $transformerPool
-    ) {
-        $this->pluginPool = $pluginPool;
-        $this->transformerPool = $transformerPool;
-        $this->resourceKeys = $resourceKeys;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -48,7 +36,8 @@ public function export(array $idsToExport): void
      */
     public function getExportedData(): string
     {
-        return json_encode($this->data) ?: '';
+        $data = json_encode($this->data);
+        return $data !== false ? $data : '';
     }
 
     /**

src/Exporter/MqItemWriter.php

@@ -42,7 +42,7 @@ public function write(array $items): void
     {
         foreach ($items as $item) {
             $message = $this->context->createMessage(
-                json_encode($item) ?: '',
+                false !== json_encode($item) ? json_encode($item) : '',
                 [],
                 ['recordedOn' => (new \DateTime())->format('Y-m-d H:i:s')]
             );

src/Exporter/ORM/Hydrator/OrderHydrator.php

@@ -7,6 +7,7 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Query;
 use Doctrine\ORM\QueryBuilder;
+use Sylius\Component\Core\Model\Order;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 
@@ -46,7 +47,7 @@ public function getHydratedResources(array $idsToExport): array
     private function findOrdersQb(array $idsToExport): QueryBuilder
     {
         /**
-         * @var \Doctrine\ORM\EntityRepository
+         * @var \Doctrine\ORM\EntityRepository<Order>
          */
         $repository = $this->repository;
 
@@ -62,7 +63,7 @@ private function findOrdersQb(array $idsToExport): QueryBuilder
     private function hydrateOrderItemsQb(array $idsToExport): QueryBuilder
     {
         /**
-         * @var \Doctrine\ORM\EntityRepository
+         * @var \Doctrine\ORM\EntityRepository<Order>
          */
         $repository = $this->repository;
 

src/Exporter/Plugin/OrderResourcePlugin.php

@@ -143,7 +143,7 @@ private function addOrderItemData(array $items, OrderInterface $resource): void
         $str = '';
 
         foreach ($items as $itemId => $item) {
-            if (!empty($str)) {
+            if (null != $str && '' != $str) {
                 $str .= ' | ';
             }
             $str .= sprintf('%dx %s(id:%d)', $item['count'], $item['name'], $itemId);

src/Exporter/Plugin/PluginPool.php

@@ -61,7 +61,7 @@ public function getDataForId(string $id): array
             $result = $this->getDataForIdFromPlugin($id, $plugin, $result);
         }
 
-        if (!empty($this->exportKeysNotFound)) {
+        if (null != $this->exportKeysNotFound && '' != $this->exportKeysNotFound) {
             throw new \InvalidArgumentException(sprintf(
                 'Not all defined export keys have been found: "%s". Choose from: "%s"',
                 implode(', ', $this->exportKeysNotFound),
@@ -80,14 +80,14 @@ public function getDataForId(string $id): array
     private function getDataForIdFromPlugin(string $id, PluginInterface $plugin, array $result): array
     {
         foreach ($plugin->getData($id, $this->exportKeys) as $exportKey => $exportValue) {
-            if (false === empty($result[$exportKey])) {
+            if (false === ([] === $result[$exportKey])) {
                 continue;
             }
 
             // no other plugin has delivered a value till now
             $result[$exportKey] = $exportValue;
 
-            $foundKey = array_search($exportKey, $this->exportKeysNotFound);
+            $foundKey = array_search($exportKey, $this->exportKeysNotFound, true);
             unset($this->exportKeysNotFound[$foundKey]);
         }