add PreRender event

Author: kbond

src/TwigComponent/CHANGELOG.md

@@ -11,6 +11,8 @@
 -   Add `HasAttributesTrait` to help with adding html attributes (ie class, style)
     to your component's root node.
 
+-   Add `PreRender` event.
+
 ## 2.0.0
 
 -   Support for `stimulus` version 2 was removed and support for `@hotwired/stimulus`

src/TwigComponent/composer.json

@@ -29,7 +29,8 @@
         "php": ">=8.0",
         "twig/twig": "^2.0|^3.0",
         "symfony/property-access": "^4.4|^5.0|^6.0",
-        "symfony/dependency-injection": "^4.4|^5.0|^6.0"
+        "symfony/dependency-injection": "^4.4|^5.0|^6.0",
+        "symfony/event-dispatcher": "^4.4|^5.0|^6.0"
     },
     "require-dev": {
         "symfony/framework-bundle": "^4.4|^5.0|^6.0",

src/TwigComponent/src/ComponentRenderer.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\UX\TwigComponent;
 
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+use Symfony\UX\TwigComponent\EventListener\PreRenderEvent;
 use Twig\Environment;
 
 /**
@@ -20,18 +22,21 @@
  */
 final class ComponentRenderer
 {
-    private Environment $twig;
-
-    public function __construct(Environment $twig)
+    public function __construct(private Environment $twig, private EventDispatcherInterface $dispatcher)
     {
-        $this->twig = $twig;
     }
 
     public function render(object $component, array $config): string
     {
-        return $this->twig->render($config['template'], array_merge(
-            ['this' => $component, '_component_config' => $config],
-            get_object_vars($component)
-        ));
+        $event = new PreRenderEvent(
+            $component,
+            $config['template'],
+            array_merge(['this' => $component, '_component_config' => $config], get_object_vars($component)),
+            $config
+        );
+
+        $this->dispatcher->dispatch($event);
+
+        return $this->twig->render($event->template, $event->context);
     }
 }

src/TwigComponent/src/DependencyInjection/TwigComponentExtension.php

@@ -57,6 +57,7 @@ class_exists(AbstractArgument::class) ? new AbstractArgument(sprintf('Added in %
         $container->register('ux.twig_component.component_renderer', ComponentRenderer::class)
             ->setArguments([
                 new Reference('twig'),
+                new Reference('event_dispatcher'),
             ])
         ;
 

src/TwigComponent/src/EventListener/PreRenderEvent.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\TwigComponent\EventListener;
+
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * @author Kevin Bond <[email protected]>
+ */
+final class PreRenderEvent extends Event
+{
+    public function __construct(
+        public object $component,
+        public string $template,
+        public array $context,
+        public array $config
+    ) {
+    }
+}