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

Open in your IDE?
  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\Contracts\Service\ServiceSubscriberInterface;
  17. use Symfony\UX\LiveComponent\Util\LiveControllerAttributesCreator;
  18. use Symfony\UX\TwigComponent\ComponentAttributes;
  19. use Symfony\UX\TwigComponent\ComponentMetadata;
  20. use Symfony\UX\TwigComponent\ComponentStack;
  21. use Symfony\UX\TwigComponent\Event\PreRenderEvent;
  22. use Symfony\UX\TwigComponent\MountedComponent;
  24. /**
  25.  * Adds the extra attributes needed to activate a live controller.
  26.  *
  27.  * Used during initial render and a re-render of a component.
  28.  *
  29.  * @author Kevin Bond <kevinbond@gmail.com>
  30.  *
  31.  * @experimental
  32.  *
  33.  * @internal
  34.  */
  35. final class AddLiveAttributesSubscriber implements EventSubscriberInterface, ServiceSubscriberInterface
  36. {
  37.     public function __construct(
  38.         private ComponentStack $componentStack,
  39.         private ContainerInterface $container
  40.     ) {
  41.     }
  43.     public function onPreRender(PreRenderEvent $event): void
  44.     {
  45.         if (!$event->getMetadata()->get('live', false)) {
  46.             // not a live component, skip
  47.             return;
  48.         }
  50.         if ($event->isEmbedded()) {
  51.             throw new \LogicException('Embedded components cannot be live.');
  52.         }
  54.         $metadata = $event->getMetadata();
  55.         $attributes = $this->getLiveAttributes($event->getMountedComponent(), $metadata);
  56.         $variables = $event->getVariables();
  57.         $attributesKey = $metadata->getAttributesVar();
  59.         // the original ComponentAttributes have already been processed and set
  60.         // onto the variables. So, we manually merge our new attributes in and
  61.         // override that variable.
  62.         if (isset($variables[$attributesKey]) && $variables[$attributesKey] instanceof ComponentAttributes) {
  63.             // merge with existing attributes if available
  64.             $attributes = $attributes->defaults($variables[$attributesKey]->all());
  65.         }
  67.         // "key" is a special attribute: don't actually render it
  68.         // this is used inside LiveControllerAttributesCreator
  69.         $attributes = $attributes->without(LiveControllerAttributesCreator::KEY_PROP_NAME);
  71.         $variables[$attributesKey] = $attributes;
  73.         $event->setVariables($variables);
  74.     }
  76.     public static function getSubscribedEvents(): array
  77.     {
  78.         return [PreRenderEvent::class => 'onPreRender'];
  79.     }
  81.     public static function getSubscribedServices(): array
  82.     {
  83.         return [
  84.             LiveControllerAttributesCreator::class,
  85.         ];
  86.     }
  88.     private function getLiveAttributes(MountedComponent $mounted, ComponentMetadata $metadata): ComponentAttributes
  89.     {
  90.         $attributesCreator = $this->container->get(LiveControllerAttributesCreator::class);
  91.         \assert($attributesCreator instanceof LiveControllerAttributesCreator);
  93.         $attributesCollection = $attributesCreator->attributesForRendering(
  94.             $mounted,
  95.             $metadata,
  96.             $this->componentStack->hasParentComponent()
  97.         );
  99.         return new ComponentAttributes($attributesCollection->toEscapedArray());
  100.     }
  101. }