vendor/symfony/ux-live-component/src/EventListener/AddLiveAttributesSubscriber.php line 30

Open in your IDE?
  1. <?php
  3. namespace Symfony\UX\LiveComponent\EventListener;
  5. use Psr\Container\ContainerInterface;
  6. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  7. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  8. use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
  9. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  10. use Symfony\UX\LiveComponent\LiveComponentHydrator;
  11. use Symfony\UX\TwigComponent\ComponentAttributes;
  12. use Symfony\UX\TwigComponent\ComponentMetadata;
  13. use Symfony\UX\TwigComponent\EventListener\PreRenderEvent;
  14. use Symfony\UX\TwigComponent\MountedComponent;
  15. use Twig\Environment;
  17. /**
  18.  * @author Kevin Bond <kevinbond@gmail.com>
  19.  *
  20.  * @experimental
  21.  *
  22.  * @internal
  23.  */
  24. final class AddLiveAttributesSubscriber implements EventSubscriberInterface, ServiceSubscriberInterface
  25. {
  26.     public function __construct(private ContainerInterface $container)
  27.     {
  28.     }
  30.     public function onPreRender(PreRenderEvent $event): void
  31.     {
  32.         if (!$event->getMetadata()->get('live', false)) {
  33.             // not a live component, skip
  34.             return;
  35.         }
  37.         if (method_exists($event, 'isEmbedded') && $event->isEmbedded()) {
  38.             // TODO: remove method_exists once min ux-twig-component version has this method
  39.             throw new \LogicException('Embedded components cannot be live.');
  40.         }
  42.         $metadata = $event->getMetadata();
  43.         $attributes = $this->getLiveAttributes($event->getMountedComponent(), $metadata);
  44.         $variables = $event->getVariables();
  45.         $attributesKey = $metadata->getAttributesVar();
  47.         if (isset($variables[$attributesKey]) && $variables[$attributesKey] instanceof ComponentAttributes) {
  48.             // merge with existing attributes if available
  49.             $attributes = $attributes->defaults($variables[$attributesKey]->all());
  50.         }
  52.         $variables[$attributesKey] = $attributes;
  54.         $event->setVariables($variables);
  55.     }
  57.     public static function getSubscribedEvents(): array
  58.     {
  59.         return [PreRenderEvent::class => 'onPreRender'];
  60.     }
  62.     public static function getSubscribedServices(): array
  63.     {
  64.         return [
  65.             LiveComponentHydrator::class,
  66.             UrlGeneratorInterface::class,
  67.             Environment::class,
  68.             '?'.CsrfTokenManagerInterface::class,
  69.         ];
  70.     }
  72.     private function getLiveAttributes(MountedComponent $mounted, ComponentMetadata $metadata): ComponentAttributes
  73.     {
  74.         $name = $mounted->getName();
  75.         $url = $this->container->get(UrlGeneratorInterface::class)->generate('live_component', ['component' => $name]);
  76.         $data = $this->container->get(LiveComponentHydrator::class)->dehydrate($mounted);
  77.         $twig = $this->container->get(Environment::class);
  79.         $attributes = [
  80.             'data-controller' => 'live',
  81.             'data-live-url-value' => twig_escape_filter($twig, $url, 'html_attr'),
  82.             'data-live-data-value' => twig_escape_filter($twig, json_encode($data, \JSON_THROW_ON_ERROR), 'html_attr'),
  83.         ];
  85.         if ($this->container->has(CsrfTokenManagerInterface::class) && $metadata->get('csrf')) {
  86.             $attributes['data-live-csrf-value'] = $this->container->get(CsrfTokenManagerInterface::class)
  87.                 ->getToken($name)->getValue()
  88.             ;
  89.         }
  91.         return new ComponentAttributes($attributes);
  92.     }
  93. }