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

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\UX\LiveComponent\EventListener;
  14. use Psr\Container\ContainerInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  17. use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
  18. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  19. use Symfony\UX\LiveComponent\DehydratedComponent;
  20. use Symfony\UX\LiveComponent\LiveComponentHydrator;
  21. use Symfony\UX\LiveComponent\Twig\DeterministicTwigIdCalculator;
  22. use Symfony\UX\LiveComponent\Util\FingerprintCalculator;
  23. use Symfony\UX\LiveComponent\Util\JsonUtil;
  24. use Symfony\UX\LiveComponent\Util\TwigAttributeHelper;
  25. use Symfony\UX\TwigComponent\ComponentAttributes;
  26. use Symfony\UX\TwigComponent\ComponentMetadata;
  27. use Symfony\UX\TwigComponent\ComponentStack;
  28. use Symfony\UX\TwigComponent\Event\PreRenderEvent;
  29. use Symfony\UX\TwigComponent\MountedComponent;
  31. /**
  32.  * @author Kevin Bond <kevinbond@gmail.com>
  33.  *
  34.  * @experimental
  35.  *
  36.  * @internal
  37.  */
  38. final class AddLiveAttributesSubscriber implements EventSubscriberInterface, ServiceSubscriberInterface
  39. {
  40.     public function __construct(private ContainerInterface $container)
  41.     {
  42.     }
  44.     public function onPreRender(PreRenderEvent $event): void
  45.     {
  46.         if (!$event->getMetadata()->get('live', false)) {
  47.             // not a live component, skip
  48.             return;
  49.         }
  51.         if (method_exists($event, 'isEmbedded') && $event->isEmbedded()) {
  52.             // TODO: remove method_exists once min ux-twig-component version has this method
  53.             throw new \LogicException('Embedded components cannot be live.');
  54.         }
  56.         $metadata = $event->getMetadata();
  57.         $attributes = $this->getLiveAttributes($event->getMountedComponent(), $metadata);
  58.         $variables = $event->getVariables();
  59.         $attributesKey = $metadata->getAttributesVar();
  61.         // the original ComponentAttributes have already been processed and set
  62.         // onto the variables. So, we manually merge our new attributes in and
  63.         // override that variable.
  64.         if (isset($variables[$attributesKey]) && $variables[$attributesKey] instanceof ComponentAttributes) {
  65.             // merge with existing attributes if available
  66.             $attributes = $attributes->defaults($variables[$attributesKey]->all());
  67.         }
  69.         $variables[$attributesKey] = $attributes;
  71.         $event->setVariables($variables);
  72.     }
  74.     public static function getSubscribedEvents(): array
  75.     {
  76.         return [PreRenderEvent::class => 'onPreRender'];
  77.     }
  79.     public static function getSubscribedServices(): array
  80.     {
  81.         return [
  82.             LiveComponentHydrator::class,
  83.             UrlGeneratorInterface::class,
  84.             TwigAttributeHelper::class,
  85.             ComponentStack::class,
  86.             DeterministicTwigIdCalculator::class,
  87.             FingerprintCalculator::class,
  88.             '?'.CsrfTokenManagerInterface::class,
  89.         ];
  90.     }
  92.     private function getLiveAttributes(MountedComponent $mounted, ComponentMetadata $metadata): ComponentAttributes
  93.     {
  94.         $name = $mounted->getName();
  95.         $url = $this->container->get(UrlGeneratorInterface::class)->generate('ux_live_component', ['component' => $name]);
  96.         /** @var DehydratedComponent $dehydratedComponent */
  97.         $dehydratedComponent = $this->container->get(LiveComponentHydrator::class)->dehydrate($mounted);
  98.         /** @var TwigAttributeHelper $helper */
  99.         $helper = $this->container->get(TwigAttributeHelper::class);
  101.         $attributes = [
  102.             'data-controller' => 'live',
  103.             'data-live-url-value' => $helper->escapeAttribute($url),
  104.             'data-live-data-value' => $helper->escapeAttribute(JsonUtil::encodeObject($dehydratedComponent->getData())),
  105.             'data-live-props-value' => $helper->escapeAttribute(JsonUtil::encodeObject($dehydratedComponent->getProps())),
  106.         ];
  108.         if ($this->container->has(CsrfTokenManagerInterface::class) && $metadata->get('csrf')) {
  109.             $attributes['data-live-csrf-value'] = $this->container->get(CsrfTokenManagerInterface::class)
  110.                 ->getToken($name)->getValue()
  111.             ;
  112.         }
  114.         if ($this->container->get(ComponentStack::class)->hasParentComponent()) {
  115.             $id = $this->container->get(DeterministicTwigIdCalculator::class)->calculateDeterministicId();
  116.             $attributes['data-live-id'] = $helper->escapeAttribute($id);
  118.             $fingerprint = $this->container->get(FingerprintCalculator::class)->calculateFingerprint($mounted->getInputProps());
  119.             $attributes['data-live-value-fingerprint'] = $helper->escapeAttribute($fingerprint);
  120.         }
  122.         return new ComponentAttributes($attributes);
  123.     }
  124. }