Added missing void return types and minor refactoring (#547)

Author: tbialcz

phpstan-baseline.neon

@@ -288,18 +288,6 @@ parameters:
 			count: 1
 			path: src/bundle/Core/Command/VirtualFieldDuplicateFixCommand.php
 
-		-
-			message: '#^Method Ibexa\\Bundle\\Core\\DependencyInjection\\Compiler\\BinaryContentDownloadPass\:\:addCall\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: src/bundle/Core/DependencyInjection/Compiler/BinaryContentDownloadPass.php
-
-		-
-			message: '#^Method Ibexa\\Bundle\\Core\\DependencyInjection\\Compiler\\BinaryContentDownloadPass\:\:addCall\(\) has parameter \$targetServiceName with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/bundle/Core/DependencyInjection/Compiler/BinaryContentDownloadPass.php
-
 		-
 			message: '#^Argument of an invalid type array\|bool\|float\|int\|string\|null supplied for foreach, only iterables are supported\.$#'
 			identifier: foreach.nonIterable
@@ -312,30 +300,6 @@ parameters:
 			count: 1
 			path: src/bundle/Core/DependencyInjection/Compiler/EntityManagerFactoryServiceLocatorPass.php
 
-		-
-			message: '#^Method Ibexa\\Bundle\\Core\\DependencyInjection\\Compiler\\ImaginePass\:\:processReduceNoiseFilter\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: src/bundle/Core/DependencyInjection/Compiler/ImaginePass.php
-
-		-
-			message: '#^Method Ibexa\\Bundle\\Core\\DependencyInjection\\Compiler\\ImaginePass\:\:processReduceNoiseFilter\(\) has parameter \$driver with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/bundle/Core/DependencyInjection/Compiler/ImaginePass.php
-
-		-
-			message: '#^Method Ibexa\\Bundle\\Core\\DependencyInjection\\Compiler\\ImaginePass\:\:processSwirlFilter\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: src/bundle/Core/DependencyInjection/Compiler/ImaginePass.php
-
-		-
-			message: '#^Method Ibexa\\Bundle\\Core\\DependencyInjection\\Compiler\\ImaginePass\:\:processSwirlFilter\(\) has parameter \$driver with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/bundle/Core/DependencyInjection/Compiler/ImaginePass.php
-
 		-
 			message: '#^Argument of an invalid type array\|bool\|float\|int\|string\|null supplied for foreach, only iterables are supported\.$#'
 			identifier: foreach.nonIterable
@@ -426,12 +390,6 @@ parameters:
 			count: 1
 			path: src/bundle/Core/DependencyInjection/Compiler/SessionConfigurationPass.php
 
-		-
-			message: '#^Constant Ibexa\\Bundle\\Core\\DependencyInjection\\Compiler\\TranslationCollectorPass\:\:LOCALES_MAP type has no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/bundle/Core/DependencyInjection/Compiler/TranslationCollectorPass.php
-
 		-
 			message: '#^Parameter \#1 \$kernelRootDir of class Ibexa\\Bundle\\Core\\Translation\\GlobCollector constructor expects string, array\|bool\|float\|int\|string\|null given\.$#'
 			identifier: argument.type
@@ -8028,30 +7986,6 @@ parameters:
 			count: 1
 			path: src/lib/Base/Container/Compiler/GenericFieldTypeConverterPass.php
 
-		-
-			message: '#^Method Ibexa\\Core\\Base\\Container\\Compiler\\Search\\Legacy\\CriteriaConverterPass\:\:addHandlers\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: src/lib/Base/Container/Compiler/Search/Legacy/CriteriaConverterPass.php
-
-		-
-			message: '#^Method Ibexa\\Core\\Base\\Container\\Compiler\\Search\\Legacy\\CriteriaConverterPass\:\:addHandlers\(\) has parameter \$handlers with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/lib/Base/Container/Compiler/Search/Legacy/CriteriaConverterPass.php
-
-		-
-			message: '#^Method Ibexa\\Core\\Base\\Container\\Compiler\\Search\\Legacy\\SortClauseConverterPass\:\:addHandlers\(\) has no return type specified\.$#'
-			identifier: missingType.return
-			count: 1
-			path: src/lib/Base/Container/Compiler/Search/Legacy/SortClauseConverterPass.php
-
-		-
-			message: '#^Method Ibexa\\Core\\Base\\Container\\Compiler\\Search\\Legacy\\SortClauseConverterPass\:\:addHandlers\(\) has parameter \$handlers with no type specified\.$#'
-			identifier: missingType.parameter
-			count: 1
-			path: src/lib/Base/Container/Compiler/Search/Legacy/SortClauseConverterPass.php
-
 		-
 			message: '#^Class Ibexa\\Core\\Base\\Container\\Compiler\\TaggedServiceIdsIterator\\BackwardCompatibleIterator implements generic interface IteratorAggregate but does not specify its types\: TKey, TValue$#'
 			identifier: missingType.generics

src/bundle/Core/DependencyInjection/Compiler/BinaryContentDownloadPass.php

@@ -14,12 +14,9 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-/**
- * Injects the downloadUrlGenerator into the binary fieldtype external storage services.
- */
 class BinaryContentDownloadPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has(ContentDownloadUrlGenerator::class)) {
             return;
@@ -31,7 +28,7 @@ public function process(ContainerBuilder $container)
         $this->addCall($container, $downloadUrlReference, BinaryFileStorage::class);
     }
 
-    private function addCall(ContainerBuilder $container, Reference $reference, $targetServiceName)
+    private function addCall(ContainerBuilder $container, Reference $reference, string $targetServiceName): void
     {
         if (!$container->has($targetServiceName)) {
             return;

src/bundle/Core/DependencyInjection/Compiler/ChainConfigResolverPass.php

@@ -12,16 +12,9 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-/**
- * The ChainConfigResolverPass will register all services tagged as "ibexa.site.config.resolver"
- * to the chain config resolver.
- */
 class ChainConfigResolverPass implements CompilerPassInterface
 {
-    /**
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition(ChainConfigResolver::class)) {
             return;
@@ -31,7 +24,6 @@ public function process(ContainerBuilder $container)
 
         foreach ($container->findTaggedServiceIds('ibexa.site.config.resolver') as $id => $attributes) {
             $priority = isset($attributes[0]['priority']) ? (int)$attributes[0]['priority'] : 0;
-            // Priority range is between -255 (the lowest) and 255 (the highest)
             if ($priority > 255) {
                 $priority = 255;
             }

src/bundle/Core/DependencyInjection/Compiler/ChainRoutingPass.php

@@ -14,15 +14,9 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-/**
- * The ChainRoutingPass will register all services tagged as "router" to the chain router.
- */
 class ChainRoutingPass implements CompilerPassInterface
 {
-    /**
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition(ChainRouter::class)) {
             return;
@@ -54,7 +48,6 @@ public function process(ContainerBuilder $container)
 
         foreach ($container->findTaggedServiceIds('router') as $id => $attributes) {
             $priority = isset($attributes[0]['priority']) ? (int)$attributes[0]['priority'] : 0;
-            // Priority range is between -255 (the lowest) and 255 (the highest)
             if ($priority > 255) {
                 $priority = 255;
             }

src/bundle/Core/DependencyInjection/Compiler/ConsoleCacheWarmupPass.php

@@ -7,21 +7,16 @@
 
 namespace Ibexa\Bundle\Core\DependencyInjection\Compiler;
 
+use const PHP_SAPI;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-/**
- * Cache related compiler pass.
- *
- * Ensures class cache warmup is disabled in console mode.
- */
 class ConsoleCacheWarmupPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
-        // This pass is CLI only as CLI class cache warmup conflicts with web access, see EZP-29034
-        if (\PHP_SAPI !== 'cli' ||
+        if (PHP_SAPI !== 'cli' ||
             !$container->hasDefinition('kernel.class_cache.cache_warmer')) {
             return;
         }
@@ -32,17 +27,16 @@ public function process(ContainerBuilder $container)
                 continue;
             }
 
-            $priority = isset($attributes[0]['priority']) ? $attributes[0]['priority'] : 0;
+            $priority = $attributes[0]['priority'] ?? 0;
             $warmers[$priority][] = new Reference($id);
         }
 
         if (empty($warmers)) {
             return;
         }
 
-        // sort by priority and flatten
         krsort($warmers);
-        $warmers = \call_user_func_array('array_merge', $warmers);
+        $warmers = array_merge(...$warmers);
 
         $container->getDefinition('cache_warmer')->replaceArgument(0, $warmers);
     }

src/bundle/Core/DependencyInjection/Compiler/ConsoleCommandPass.php

@@ -14,7 +14,7 @@
 
 final class ConsoleCommandPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         foreach ($container->findTaggedServiceIds('console.command') as $id => $attributes) {
             $definition = $container->getDefinition($id);

src/bundle/Core/DependencyInjection/Compiler/FieldTypeParameterProviderRegistryPass.php

@@ -8,23 +8,16 @@
 namespace Ibexa\Bundle\Core\DependencyInjection\Compiler;
 
 use Ibexa\Core\MVC\Symfony\FieldType\View\ParameterProviderRegistry;
+use LogicException;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 
-/**
- * This compiler pass will register Ibexa field type parameter providers.
- */
 class FieldTypeParameterProviderRegistryPass implements CompilerPassInterface
 {
-    public const FIELD_TYPE_PARAMETER_PROVIDER_SERVICE_TAG = 'ibexa.field_type.view.parameter.provider';
-
-    /**
-     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
-     *
-     * @throws \LogicException
-     */
-    public function process(ContainerBuilder $container)
+    public const string FIELD_TYPE_PARAMETER_PROVIDER_SERVICE_TAG = 'ibexa.field_type.view.parameter.provider';
+
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition(ParameterProviderRegistry::class)) {
             return;
@@ -38,7 +31,7 @@ public function process(ContainerBuilder $container)
         foreach ($serviceTags as $serviceId => $attributes) {
             foreach ($attributes as $attribute) {
                 if (!isset($attribute['alias'])) {
-                    throw new \LogicException(
+                    throw new LogicException(
                         sprintf(
                             'Service "%s" tagged with "%s" service tag needs an "alias" attribute to identify the Field Type.',
                             $serviceId,

src/bundle/Core/DependencyInjection/Compiler/ImaginePass.php

@@ -19,7 +19,7 @@
 
 class ImaginePass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('liip_imagine.filter.configuration')) {
             return;
@@ -38,7 +38,7 @@ public function process(ContainerBuilder $container)
         }
     }
 
-    private function processReduceNoiseFilter(ContainerBuilder $container, $driver)
+    private function processReduceNoiseFilter(ContainerBuilder $container, string $driver): void
     {
         if ($driver === 'imagick') {
             $container->setAlias('ibexa.image_alias.imagine.filter.reduce_noise', new Alias(ImagickReduceNoiseFilter::class));
@@ -47,7 +47,7 @@ private function processReduceNoiseFilter(ContainerBuilder $container, $driver)
         }
     }
 
-    private function processSwirlFilter(ContainerBuilder $container, $driver)
+    private function processSwirlFilter(ContainerBuilder $container, string $driver): void
     {
         if ($driver === 'imagick') {
             $container->setAlias('ibexa.image_alias.imagine.filter.swirl', new Alias(ImagickSwirlFilter::class));

src/bundle/Core/DependencyInjection/Compiler/NotificationRendererPass.php

@@ -15,10 +15,10 @@
 
 class NotificationRendererPass implements CompilerPassInterface
 {
-    public const TAG_NAME = 'ibexa.notification.renderer';
-    public const REGISTRY_DEFINITION_ID = 'notification.renderer.registry';
+    public const string TAG_NAME = 'ibexa.notification.renderer';
+    public const string REGISTRY_DEFINITION_ID = 'notification.renderer.registry';
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->has(self::REGISTRY_DEFINITION_ID)) {
             return;

src/bundle/Core/DependencyInjection/Compiler/PlaceholderProviderPass.php

@@ -15,10 +15,10 @@
 
 class PlaceholderProviderPass implements CompilerPassInterface
 {
-    public const TAG_NAME = 'ibexa.media.images.placeholder.provider';
-    public const REGISTRY_DEFINITION_ID = PlaceholderProviderRegistry::class;
+    public const string TAG_NAME = 'ibexa.media.images.placeholder.provider';
+    public const string REGISTRY_DEFINITION_ID = PlaceholderProviderRegistry::class;
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition(self::REGISTRY_DEFINITION_ID)) {
             return;