Merged branch '4.6'

Author: alongosz

phpstan-baseline.neon

@@ -714,12 +714,6 @@ parameters:
 			count: 3
 			path: src/bundle/Core/DependencyInjection/Configuration/Parser/IO.php
 
-		-
-			message: '#^Method Ibexa\\Bundle\\Core\\DependencyInjection\\Configuration\\Parser\\Image\:\:mapConfig\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: src/bundle/Core/DependencyInjection/Configuration/Parser/Image.php
-
 		-
 			message: '#^Method Ibexa\\Bundle\\Core\\DependencyInjection\\Configuration\\Parser\\Image\:\:mapConfig\(\) has parameter \$scopeSettings with no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue
@@ -3210,18 +3204,6 @@ parameters:
 			count: 1
 			path: src/bundle/Core/Imagine/Filter/AbstractFilter.php
 
-		-
-			message: '#^Parameter \#2 \$configuredVariations of method Ibexa\\Bundle\\Core\\Imagine\\Filter\\FilterConfiguration\:\:getVariationFilters\(\) expects array\<string, array\{filters\: array\<mixed\>\}\>, non\-empty\-array given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/bundle/Core/Imagine/Filter/FilterConfiguration.php
-
-		-
-			message: '#^Parameter \#2 \$configuredVariations of method Ibexa\\Bundle\\Core\\Imagine\\Filter\\FilterConfiguration\:\:getVariationPostProcessors\(\) expects array\<string, array\{post_processor\: array\<mixed\>\}\>, non\-empty\-array given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/bundle/Core/Imagine/Filter/FilterConfiguration.php
-
 		-
 			message: '#^Method Ibexa\\Bundle\\Core\\Imagine\\Filter\\FilterInterface\:\:getOptions\(\) return type has no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue

src/bundle/Core/DependencyInjection/Configuration/Parser/Image.php

@@ -13,6 +13,16 @@
 
 /**
  * Configuration parser handling all basic configuration (aka "Image").
+ *
+ * @phpstan-type TVariationOptions array<string|int, mixed>
+ * @phpstan-type TFilters array<string, TVariationOptions>
+ * @phpstan-type TPostProcessors array<string, TVariationOptions>
+ * @phpstan-type TImageVariation array{
+ *     reference?: string|null,
+ *     filters?: TFilters,
+ *     post_processors?: TPostProcessors
+ * }
+ * @phpstan-type TImageVariations array<string, TImageVariation>
  */
 class Image extends AbstractParser
 {
@@ -107,7 +117,7 @@ public function preMap(array $config, ContextualizerInterface $contextualizer):
         $contextualizer->mapSetting('variation_handler_identifier', $config);
     }
 
-    public function mapConfig(array &$scopeSettings, $currentScope, ContextualizerInterface $contextualizer)
+    public function mapConfig(array &$scopeSettings, $currentScope, ContextualizerInterface $contextualizer): void
     {
     }
 }

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

@@ -7,9 +7,15 @@
 
 namespace Ibexa\Bundle\Core\Imagine\Filter;
 
+use Ibexa\Bundle\Core\DependencyInjection\Configuration\Parser\Image;
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use Liip\ImagineBundle\Imagine\Filter\FilterConfiguration as BaseFilterConfiguration;
 
+/**
+ * @phpstan-import-type TImageVariations from Image
+ * @phpstan-import-type TFilters from Image
+ * @phpstan-import-type TPostProcessors from Image
+ */
 class FilterConfiguration extends BaseFilterConfiguration
 {
     private ConfigResolverInterface $configResolver;
@@ -20,10 +26,24 @@ public function setConfigResolver(ConfigResolverInterface $configResolver): void
     }
 
     /**
-     * @return array<string, mixed>
+     * @phpstan-return array{
+     *     cache?: string|null,
+     *     data_loader?: string|null,
+     *     reference?: string|null,
+     *     filters?: TFilters,
+     *     post_processors?: TPostProcessors,
+     *     quality?: int|null,
+     *     jpeg_quality?: int|null,
+     *     png_compression_level?: int|null,
+     *     png_compression_filter?: int|null,
+     *     format?: string|null,
+     *     animated?: bool,
+     *     default_image?: string|null
+     * }
      */
     public function get($filter): array
     {
+        /** @phpstan-var TImageVariations $configuredVariations */
         $configuredVariations = $this->configResolver->getParameter('image_variations');
         if (!array_key_exists($filter, $configuredVariations)) {
             return parent::get($filter);
@@ -41,11 +61,14 @@ public function get($filter): array
     }
 
     /**
-     * @return array<string, mixed>
+     * @phpstan-return TImageVariations
      */
     public function all(): array
     {
-        return $this->configResolver->getParameter('image_variations') + parent::all();
+        /** @phpstan-var TImageVariations $configuredVariations */
+        $configuredVariations = $this->configResolver->getParameter('image_variations');
+
+        return $configuredVariations + parent::all();
     }
 
     /**
@@ -54,17 +77,17 @@ public function all(): array
      * Both variations configured in Ibexa (SiteAccess context) and LiipImagineBundle are used.
      * Ibexa variations always have precedence.
      *
-     * @param array<string, array{filters: array<mixed>}> $configuredVariations Variations set in eZ.
+     * @phpstan-param TImageVariations $configuredVariations Variations' set.
      *
-     * @return array<mixed>
+     * @phpstan-return TFilters
      */
     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.
+        // Prioritize variations configured in Ibexa config
         return $configuredVariations[$variationName]['filters'] ?? $this->filters[$variationName]['filters'];
     }
 
@@ -74,9 +97,9 @@ private function getVariationFilters(string $variationName, array $configuredVar
      * Both variations configured in Ibexa and LiipImagineBundle are used.
      * Ibexa variations always have precedence.
      *
-     * @param array<string, array{post_processor: array<mixed>}> $configuredVariations Variations set in Ibexa.
+     * @phpstan-param TImageVariations $configuredVariations Variations set in eZ.
      *
-     * @return array<mixed>
+     * @phpstan-return TPostProcessors
      */
     private function getVariationPostProcessors(string $variationName, array $configuredVariations): array
     {