IBX-9727: Fixed strict types of IO layer

src/bundle/Core/Imagine/Filter/FilterConfiguration.php

@@ -12,18 +12,17 @@
 
 class FilterConfiguration extends BaseFilterConfiguration
 {
-    /** @var \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface */
-    private $configResolver;
+    private ConfigResolverInterface $configResolver;
 
-    /**
-     * @param \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface $configResolver
-     */
-    public function setConfigResolver(ConfigResolverInterface $configResolver)
+    public function setConfigResolver(ConfigResolverInterface $configResolver): void
     {
         $this->configResolver = $configResolver;
     }
 
-    public function get($filter)
+    /**
+     * @return array<string, mixed>
+     */
+    public function get($filter): array
     {
         $configuredVariations = $this->configResolver->getParameter('image_variations');
         if (!array_key_exists($filter, $configuredVariations)) {
@@ -35,13 +34,16 @@ public function get($filter)
         return [
             'cache' => 'ibexa',
             'data_loader' => 'ibexa',
-            'reference' => isset($configuredVariations[$filter]['reference']) ? $configuredVariations[$filter]['reference'] : null,
+            'reference' => $configuredVariations[$filter]['reference'] ?? null,
             'filters' => $this->getVariationFilters($filter, $configuredVariations),
             'post_processors' => $this->getVariationPostProcessors($filter, $configuredVariations),
         ] + $filterConfig;
     }
 
-    public function all()
+    /**
+     * @return array<string, mixed>
+     */
+    public function all(): array
     {
         return $this->configResolver->getParameter('image_variations') + parent::all();
     }
@@ -52,26 +54,18 @@ public function all()
      * Both variations configured in Ibexa (SiteAccess context) and LiipImagineBundle are used.
      * Ibexa variations always have precedence.
      *
-     * @param string $variationName
-     * @param array $configuredVariations Variations set in eZ.
+     * @param array<string, array{filters: array<mixed>}> $configuredVariations Variations set in eZ.
      *
-     * @return array
+     * @return array<mixed>
      */
-    private function getVariationFilters($variationName, array $configuredVariations)
+    private function getVariationFilters(string $variationName, array $configuredVariations): array
     {
         if (!isset($configuredVariations[$variationName]['filters']) && !isset($this->filters[$variationName]['filters'])) {
             return [];
         }
 
         // Check variations configured in Ibexa config first.
-        if (isset($configuredVariations[$variationName]['filters'])) {
-            $filters = $configuredVariations[$variationName]['filters'];
-        } else {
-            // Falback to variations configured in LiipImagineBundle.
-            $filters = $this->filters[$variationName]['filters'];
-        }
-
-        return $filters;
+        return $configuredVariations[$variationName]['filters'] ?? $this->filters[$variationName]['filters'];
     }
 
     /**
@@ -80,19 +74,14 @@ private function getVariationFilters($variationName, array $configuredVariations
      * Both variations configured in Ibexa and LiipImagineBundle are used.
      * Ibexa variations always have precedence.
      *
-     * @param string $variationName
-     * @param array $configuredVariations Variations set in eZ.
+     * @param array<string, array{post_processor: array<mixed>}> $configuredVariations Variations set in Ibexa.
      *
-     * @return array
+     * @return array<mixed>
      */
-    private function getVariationPostProcessors($variationName, array $configuredVariations)
+    private function getVariationPostProcessors(string $variationName, array $configuredVariations): array
     {
-        if (isset($configuredVariations[$variationName]['post_processors'])) {
-            return $configuredVariations[$variationName]['post_processors'];
-        } elseif (isset($this->filters[$variationName]['post_processors'])) {
-            return $this->filters[$variationName]['post_processors'];
-        }
-
-        return [];
+        return $configuredVariations[$variationName]['post_processors']
+            ?? $this->filters[$variationName]['post_processors']
+            ?? [];
     }
 }

src/bundle/Core/Imagine/VariationPurger/IOVariationPurger.php

@@ -4,36 +4,34 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\Imagine\VariationPurger;
 
 use Ibexa\Bundle\Core\Imagine\Cache\AliasGeneratorDecorator;
 use Ibexa\Contracts\Core\Variation\VariationPurger;
 use Ibexa\Core\IO\IOServiceInterface;
 use Ibexa\Core\Persistence\Cache\Identifier\CacheIdentifierGeneratorInterface;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
 use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
 
 /**
  * Purges image variations using the IOService.
  *
  * Depends on aliases being stored in their own folder, with each alias folder mirroring the original files structure.
  */
-class IOVariationPurger implements VariationPurger
+class IOVariationPurger implements VariationPurger, LoggerAwareInterface
 {
-    /** @var \Ibexa\Core\IO\IOServiceInterface */
-    private $io;
+    use LoggerAwareTrait;
 
-    /** @var \Symfony\Component\Cache\Adapter\TagAwareAdapterInterface */
-    private $cache;
+    private IOServiceInterface $io;
 
-    /** @var \Ibexa\Core\Persistence\Cache\Identifier\CacheIdentifierGeneratorInterface */
-    private $cacheIdentifierGenerator;
+    private TagAwareAdapterInterface $cache;
 
-    /** @var \Ibexa\Bundle\Core\Imagine\Cache\AliasGeneratorDecorator */
-    private $aliasGeneratorDecorator;
+    private CacheIdentifierGeneratorInterface $cacheIdentifierGenerator;
 
-    /** @var \Psr\Log\LoggerInterface */
-    private $logger;
+    private AliasGeneratorDecorator $aliasGeneratorDecorator;
 
     public function __construct(
         IOServiceInterface $io,
@@ -47,14 +45,6 @@ public function __construct(
         $this->aliasGeneratorDecorator = $aliasGeneratorDecorator;
     }
 
-    /**
-     * @param \Psr\Log\LoggerInterface $logger
-     */
-    public function setLogger($logger)
-    {
-        $this->logger = $logger;
-    }
-
     public function purge(array $aliasNames): void
     {
         $variationNameTag = $this->aliasGeneratorDecorator->getVariationNameTag();

src/bundle/Core/Imagine/VariationPurger/ImageFileList.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\Imagine\VariationPurger;
 
@@ -12,6 +13,8 @@
 
 /**
  * Iterates over BinaryFile id entries for original images.
+ *
+ * @extends \Iterator<array-key, string>
  */
 interface ImageFileList extends Countable, Iterator
 {

src/bundle/Core/Imagine/VariationPurger/ImageFileRowReader.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\Imagine\VariationPurger;
 
@@ -17,19 +18,17 @@ interface ImageFileRowReader
      *
      * Can for instance be used to create and execute a database query.
      */
-    public function init();
+    public function init(): void;
 
     /**
      * Returns the next row from the data source.
-     *
-     * @return mixed|null The row's value, or null if none.
      */
-    public function getRow();
+    public function getRow(): ?string;
 
     /**
      * Returns the total row count.
      *
-     * @return int
+     * @phpstan-return int<0, max>
      */
-    public function getCount();
+    public function getCount(): int;
 }

src/bundle/Core/Imagine/VariationPurger/ImageFileVariationPurger.php

@@ -4,39 +4,31 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\Imagine\VariationPurger;
 
 use Ibexa\Contracts\Core\Variation\VariationPathGenerator;
 use Ibexa\Contracts\Core\Variation\VariationPurger;
 use Ibexa\Core\IO\IOServiceInterface;
-use Iterator;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
 
 /**
  * Purges image aliases based on image files referenced by the Image FieldType.
  *
  * It uses an ImageFileList iterator that lists original images, and the variationPathGenerator + IOService to remove
  * aliases if they exist.
  */
-class ImageFileVariationPurger implements VariationPurger
+class ImageFileVariationPurger implements VariationPurger, LoggerAwareInterface
 {
-    /** @var ImageFileList */
-    private $imageFileList;
+    use LoggerAwareTrait;
 
-    /** @var \Ibexa\Core\IO\IOServiceInterface */
-    private $ioService;
-
-    /** @var \Ibexa\Contracts\Core\Variation\VariationPathGenerator */
-    private $variationPathGenerator;
-
-    /** @var \Psr\Log\LoggerInterface */
-    private $logger;
-
-    public function __construct(Iterator $imageFileList, IOServiceInterface $ioService, VariationPathGenerator $variationPathGenerator)
-    {
-        $this->imageFileList = $imageFileList;
-        $this->ioService = $ioService;
-        $this->variationPathGenerator = $variationPathGenerator;
+    public function __construct(
+        private readonly ImageFileList $imageFileList,
+        private readonly IOServiceInterface $ioService,
+        private readonly VariationPathGenerator $variationPathGenerator
+    ) {
     }
 
     public function purge(array $aliasNames): void
@@ -56,12 +48,4 @@ public function purge(array $aliasNames): void
             }
         }
     }
-
-    /**
-     * @param \Psr\Log\LoggerInterface $logger
-     */
-    public function setLogger($logger)
-    {
-        $this->logger = $logger;
-    }
 }

src/bundle/Core/Imagine/VariationPurger/LegacyStorageImageFileList.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Bundle\Core\Imagine\VariationPurger;
 
@@ -19,43 +20,25 @@ class LegacyStorageImageFileList implements ImageFileList
 {
     /**
      * Last fetched item.
-     *
-     * @var mixed
      */
-    private $item;
+    private ?string $item;
 
     /**
      * Iteration cursor on $statement.
      *
      * @var int
      */
-    private $cursor;
-
-    /**
-     * Used to get ezimagefile rows.
-     *
-     * @var \Ibexa\Bundle\Core\Imagine\VariationPurger\ImageFileRowReader
-     */
-    private $rowReader;
-
-    /** @var \Ibexa\Core\IO\IOConfigProvider */
-    private $ioConfigResolver;
-
-    /** @var \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface */
-    private $configResolver;
+    private int $cursor;
 
     public function __construct(
-        ImageFileRowReader $rowReader,
-        IOConfigProvider $ioConfigResolver,
-        ConfigResolverInterface $configResolver
+        private readonly ImageFileRowReader $rowReader,
+        private readonly IOConfigProvider $ioConfigResolver,
+        private readonly ConfigResolverInterface $configResolver
     ) {
-        $this->ioConfigResolver = $ioConfigResolver;
-        $this->rowReader = $rowReader;
-        $this->configResolver = $configResolver;
     }
 
     #[\ReturnTypeWillChange]
-    public function current(): mixed
+    public function current(): ?string
     {
         return $this->item;
     }
@@ -96,9 +79,13 @@ private function fetchRow(): void
         $storageDir = $this->ioConfigResolver->getLegacyUrlPrefix();
         $prefix = $storageDir . '/' . $this->configResolver->getParameter('image.published_images_dir');
         ++$this->cursor;
-        $imageId = $this->rowReader->getRow();
+        $this->item = $this->rowReader->getRow();
+        if ($this->item === null) {
+            return;
+        }
 
-        if (0 === strncmp((string)$imageId, $prefix, strlen($prefix))) {
+        $imageId = $this->item;
+        if (0 === strncmp($imageId, $prefix, strlen($prefix))) {
             $imageId = ltrim(substr($imageId, strlen($prefix)), '/');
         }