Using tagged_iterators for the markup listener

UPGRADE.md

@@ -1,5 +1,10 @@
 # Upgrade
 
+### Replacing compiler passes with `tagged_iterator`s
+We have replaced the manual logic of getting a list of tagged services to the Symfony `tagged_iterator` argument. This
+means that the following classes have been deprecated:
+- src/Sulu/Bundle/MarkupBundle/DependencyInjection/CompilerPass/ParserCompilerPass.php
+
 ## 2.6.0
 
 ### PHP 8.2 upgrade

phpstan-baseline.neon

@@ -12660,16 +12660,6 @@ parameters:
 			count: 1
 			path: src/Sulu/Bundle/MarkupBundle/Listener/MarkupListener.php
 
-		-
-			message: "#^Parameter \\#2 \\$array of function array_key_exists expects array, Sulu\\\\Bundle\\\\MarkupBundle\\\\Markup\\\\MarkupParserInterface given\\.$#"
-			count: 1
-			path: src/Sulu/Bundle/MarkupBundle/Listener/MarkupListener.php
-
-		-
-			message: "#^Property Sulu\\\\Bundle\\\\MarkupBundle\\\\Listener\\\\MarkupListener\\:\\:\\$markupParser \\(Sulu\\\\Bundle\\\\MarkupBundle\\\\Markup\\\\MarkupParserInterface\\) does not accept array\\<Sulu\\\\Bundle\\\\MarkupBundle\\\\Markup\\\\MarkupParserInterface\\>\\.$#"
-			count: 1
-			path: src/Sulu/Bundle/MarkupBundle/Listener/MarkupListener.php
-
 		-
 			message: "#^Method Sulu\\\\Bundle\\\\MarkupBundle\\\\Markup\\\\HtmlTagExtractor\\:\\:count\\(\\) should return int but returns int\\<0, max\\>\\|false\\.$#"
 			count: 1
@@ -12835,11 +12825,6 @@ parameters:
 			count: 1
 			path: src/Sulu/Bundle/MarkupBundle/Tag/TagRegistry.php
 
-		-
-			message: "#^Class Sulu\\\\Bundle\\\\MarkupBundle\\\\Listener\\\\MarkupListener constructor invoked with 2 parameters, 1 required\\.$#"
-			count: 1
-			path: src/Sulu/Bundle/MarkupBundle/Tests/Unit/Listener/MarkupListenerTest.php
-
 		-
 			message: "#^Method Sulu\\\\Bundle\\\\MarkupBundle\\\\Tests\\\\Unit\\\\Markup\\\\HtmlTagExtractorTest\\:\\:provideMultipleTags\\(\\) has no return type specified\\.$#"
 			count: 1

src/Sulu/Bundle/MarkupBundle/DependencyInjection/CompilerPass/ParserCompilerPass.php

@@ -13,36 +13,33 @@
 
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Reference;
 
 /**
  * Collects all parsers for markup.
+ *
+ * @internal
+ *
+ * @deprecated
  */
 class ParserCompilerPass implements CompilerPassInterface
 {
+    /**
+     * @deprecated Don't use this constant anymore use tagged_iterator
+     */
     public const SERVICE_ID = 'sulu_markup.response_listener';
 
+    /**
+     * @deprecated Use the value instead
+     */
     public const TAG_NAME = 'sulu_markup.parser';
 
+    /**
+     * @deprecated don't use this constant anymore
+     */
     public const TYPE_ATTRIBUTE = 'type';
 
     public function process(ContainerBuilder $container)
     {
-        if (!$container->hasDefinition(self::SERVICE_ID)) {
-            return;
-        }
-
-        $references = [];
-        foreach ($container->findTaggedServiceIds(self::TAG_NAME) as $id => $tags) {
-            foreach ($tags as $attributes) {
-                $references[$attributes[self::TYPE_ATTRIBUTE]] = new Reference($id);
-            }
-        }
-
-        if (0 === \count($references)) {
-            return;
-        }
-
-        $container->getDefinition(self::SERVICE_ID)->replaceArgument(0, $references);
+        trigger_deprecation('sulu/sulu', '2.5', 'Using this CompilerPass is deprecated. Use the tagged_iterator instead');
     }
 }

src/Sulu/Bundle/MarkupBundle/Listener/MarkupListener.php

@@ -22,16 +22,16 @@
 class MarkupListener implements EventSubscriberInterface
 {
     /**
-     * @var MarkupParserInterface
+     * @var array<string, MarkupParserInterface>
      */
-    private $markupParser;
+    private array $markupParser;
 
     /**
-     * @param MarkupParserInterface[] $markupParser
+     * @param iterable<MarkupParserInterface> $markupParser
      */
-    public function __construct(array $markupParser)
+    public function __construct(iterable $markupParser)
     {
-        $this->markupParser = $markupParser;
+        $this->markupParser = \iterator_to_array($markupParser);
     }
 
     public static function getSubscribedEvents(): array

src/Sulu/Bundle/MarkupBundle/Resources/config/services.xml

@@ -25,7 +25,7 @@
         </service>
 
         <service id="sulu_markup.response_listener" class="Sulu\Bundle\MarkupBundle\Listener\MarkupListener">
-            <argument type="collection"/>
+            <argument type="tagged_iterator" tag="sulu_markup.parser" index-by="type" />
 
             <tag name="kernel.event_subscriber"/>
         </service>

src/Sulu/Bundle/MarkupBundle/SuluMarkupBundle.php

@@ -11,7 +11,6 @@
 
 namespace Sulu\Bundle\MarkupBundle;
 
-use Sulu\Bundle\MarkupBundle\DependencyInjection\CompilerPass\ParserCompilerPass;
 use Sulu\Bundle\MarkupBundle\DependencyInjection\CompilerPass\TagCompilerPass;
 use Sulu\Component\Symfony\CompilerPass\TaggedServiceCollectorCompilerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -31,7 +30,6 @@ public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 
-        $container->addCompilerPass(new ParserCompilerPass());
         $container->addCompilerPass(new TagCompilerPass());
         $container->addCompilerPass(
             new TaggedServiceCollectorCompilerPass(

src/Sulu/Bundle/MarkupBundle/Tests/Unit/Listener/MarkupListenerTest.php

@@ -72,7 +72,7 @@ protected function setUp(): void
             $this->response->reveal()
         );
 
-        $this->listener = new MarkupListener(['html' => $this->markupParser->reveal()], ['text/html' => 'html']);
+        $this->listener = new MarkupListener(['html' => $this->markupParser->reveal()]);
     }
 
     public function testReplaceMarkup(): void