Made CriteriaConverter capable of using lazy constructors

Steveb-p · Steveb-p · commit b330f5713c91 · 2025-08-28T16:49:55.000+02:00
diff --git a/src/lib/Base/Container/Compiler/Search/Legacy/CriteriaConverterPass.php b/src/lib/Base/Container/Compiler/Search/Legacy/CriteriaConverterPass.php
diff --git a/src/lib/Persistence/Legacy/URL/Query/CriteriaConverter.php b/src/lib/Persistence/Legacy/URL/Query/CriteriaConverter.php
@@ -9,33 +9,46 @@
 use Doctrine\DBAL\Query\QueryBuilder;
 use Ibexa\Contracts\Core\Repository\Exceptions\NotImplementedException;
 use Ibexa\Contracts\Core\Repository\Values\URL\Query\Criterion;
+use Traversable;
 
 class CriteriaConverter
 {
     /**
      * Criterion handlers.
      *
-     * @var \Ibexa\Core\Persistence\Legacy\URL\Query\CriterionHandler[]
+     * @var iterable<\Ibexa\Core\Persistence\Legacy\URL\Query\CriterionHandler>
      */
-    protected $handlers;
+    protected iterable $handlers;
 
     /**
      * Construct from an optional array of Criterion handlers.
      *
-     * @param \Ibexa\Core\Persistence\Legacy\URL\Query\CriterionHandler[] $handlers
+     * @param iterable<\Ibexa\Core\Persistence\Legacy\URL\Query\CriterionHandler> $handlers
      */
-    public function __construct(array $handlers = [])
+    public function __construct(iterable $handlers = [])
     {
         $this->handlers = $handlers;
     }
 
     /**
-     * Adds handler.
-     *
-     * @param \Ibexa\Core\Persistence\Legacy\URL\Query\CriterionHandler $handler
+     * @deprecated The "%s" method is deprecated. Use a service definition tag "ibexa.storage.legacy.url.criterion.handler" instead.
      */
     public function addHandler(CriterionHandler $handler)
     {
+        trigger_deprecation(
+            'ibexa/core',
+            '4.6.24',
+            'The "%s" method is deprecated. Use a service definition tag ("%s") instead.',
+            __METHOD__,
+            implode('", "', [
+                'ibexa.storage.legacy.url.criterion.handler',
+            ]),
+        );
+
+        if ($this->handlers instanceof Traversable) {
+            $this->handlers = iterator_to_array($this->handlers);
+        }
+
         $this->handlers[] = $handler;
     }
 
diff --git a/src/lib/Resources/settings/search_engines/legacy/criterion_handlers_content.yml b/src/lib/Resources/settings/search_engines/legacy/criterion_handlers_content.yml
@@ -1,10 +1,9 @@
 services:
-    # Note: services tagged with:
-    #  - ibexa.search.legacy.gateway.criterion_handler.content
-    # are registered to this one using compilation pass
     ibexa.search.legacy.gateway.criteria_converter.content:
         class: Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter
         lazy: true
+        arguments:
+            $handlers: !tagged_iterator ibexa.search.legacy.gateway.criterion_handler.content
 
     Ibexa\Core\Search\Legacy\Content\Gateway\CriterionHandler\Ancestor:
         parent: Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler
diff --git a/src/lib/Resources/settings/search_engines/legacy/criterion_handlers_location.yml b/src/lib/Resources/settings/search_engines/legacy/criterion_handlers_location.yml
@@ -1,10 +1,9 @@
 services:
-    # Note: services tagged with:
-    #  - ibexa.search.legacy.gateway.criterion_handler.location
-    # are registered to this one using compilation pass
     ibexa.search.legacy.gateway.criteria_converter.location:
         class: Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter
         lazy: true
+        arguments:
+            $handlers: !tagged_iterator ibexa.search.legacy.gateway.criterion_handler.location
 
     Ibexa\Core\Search\Legacy\Content\Location\Gateway\CriterionHandler\Ancestor:
         parent: Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler
diff --git a/src/lib/Resources/settings/storage_engines/legacy/trash.yml b/src/lib/Resources/settings/storage_engines/legacy/trash.yml
@@ -12,6 +12,8 @@ services:
     ibexa.core.trash.search.legacy.gateway.criteria_converter:
         class: Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriteriaConverter
         lazy: true
+        arguments:
+            $handlers: !tagged_iterator ibexa.search.legacy.trash.gateway.criterion.handler
 
     ibexa.core.trash.search.legacy.gateway.sort_clause_converter:
         class: Ibexa\Core\Search\Legacy\Content\Common\Gateway\SortClauseConverter
diff --git a/src/lib/Resources/settings/storage_engines/legacy/url.yml b/src/lib/Resources/settings/storage_engines/legacy/url.yml
@@ -27,3 +27,5 @@ services:
     Ibexa\Core\Persistence\Legacy\URL\Query\CriteriaConverter:
         class: Ibexa\Core\Persistence\Legacy\URL\Query\CriteriaConverter
         lazy: true
+        arguments:
+            $handlers: !tagged_iterator ibexa.storage.legacy.url.criterion.handler
diff --git a/src/lib/Search/Legacy/Content/Common/Gateway/CriteriaConverter.php b/src/lib/Search/Legacy/Content/Common/Gateway/CriteriaConverter.php
@@ -9,6 +9,7 @@
 use Doctrine\DBAL\Query\QueryBuilder;
 use Ibexa\Contracts\Core\Repository\Exceptions\NotImplementedException;
 use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion;
+use Traversable;
 
 /**
  * Content locator gateway implementation using the DoctrineDatabase.
@@ -20,25 +21,41 @@ class CriteriaConverter
      *
      * @var \Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler[]
      */
-    protected $handlers;
+    protected iterable $handlers;
 
     /**
      * Construct from an optional array of Criterion handlers.
      *
      * @param \Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler[] $handlers
      */
-    public function __construct(array $handlers = [])
+    public function __construct(iterable $handlers = [])
     {
         $this->handlers = $handlers;
     }
 
     /**
-     * Adds handler.
-     *
-     * @param \Ibexa\Core\Search\Legacy\Content\Common\Gateway\CriterionHandler $handler
+     * @deprecated The "%s" method is deprecated. Use a service definition tag instead (one of
+     *      "ibexa.search.legacy.gateway.criterion_handler.content",
+     *      "ibexa.search.legacy.gateway.criterion_handler.location",
+     *      "ibexa.search.legacy.trash.gateway.criterion.handler").
      */
     public function addHandler(CriterionHandler $handler)
     {
+        trigger_deprecation(
+            'ibexa/core',
+            '4.6.24',
+            'The "%s" method is deprecated. Use a service definition tag instead (one of "%s").',
+            __METHOD__,
+            implode('", "', [
+                'ibexa.search.legacy.gateway.criterion_handler.content',
+                'ibexa.search.legacy.gateway.criterion_handler.location',
+                'ibexa.search.legacy.trash.gateway.criterion.handler',
+            ]),
+        );
+
+        if ($this->handlers instanceof Traversable) {
+            $this->handlers = iterator_to_array($this->handlers);
+        }
         $this->handlers[] = $handler;
     }
 
diff --git a/tests/integration/Core/LegacyTestContainerBuilder.php b/tests/integration/Core/LegacyTestContainerBuilder.php
@@ -124,7 +124,6 @@ private function registerCompilerPasses(): void
         $this->addCompilerPass(new Compiler\Storage\Legacy\FieldValueConverterRegistryPass());
         $this->addCompilerPass(new Compiler\Storage\Legacy\RoleLimitationConverterPass());
 
-        $this->addCompilerPass(new Compiler\Search\Legacy\CriteriaConverterPass());
         $this->addCompilerPass(new Compiler\Search\Legacy\CriterionFieldValueHandlerRegistryPass());
         $this->addCompilerPass(new Compiler\Search\Legacy\SortClauseConverterPass());
 
diff --git a/tests/lib/Base/Container/Compiler/Search/Legacy/CriteriaConverterPassTest.php b/tests/lib/Base/Container/Compiler/Search/Legacy/CriteriaConverterPassTest.php
diff --git a/tests/lib/Persistence/Legacy/HandlerTest.php b/tests/lib/Persistence/Legacy/HandlerTest.php
@@ -227,13 +227,7 @@ public function testTransactionHandlerTwice(): void
 
     protected function getHandlerFixture(): Handler
     {
-        if (!isset(self::$legacyHandler)) {
-            $container = $this->getContainer();
-
-            self::$legacyHandler = $container->get(Handler::class);
-        }
-
-        return self::$legacyHandler;
+        return self::$legacyHandler ??= $this->getContainer()->get(Handler::class);
     }
 
     protected static Container $container;

Original file line number	Diff line number	Diff line change
`@@ -227,13 +227,7 @@ public function testTransactionHandlerTwice(): void`
`227`	`227`
`228`	`228`	`protected function getHandlerFixture(): Handler`
`229`	`229`	`{`
`230`		`- if (!isset(self::$legacyHandler)) {`
`231`		`- $container = $this->getContainer();`
`232`		`-`
`233`		`- self::$legacyHandler = $container->get(Handler::class);`
`234`		`- }`
`235`		`-`
`236`		`- return self::$legacyHandler;`
	`230`	`+ return self::$legacyHandler ??= $this->getContainer()->get(Handler::class);`
`237`	`231`	`}`
`238`	`232`
`239`	`233`	`protected static Container $container;`