vendor/symfony/ux-live-component/src/EventListener/InterceptChildComponentRenderSubscriber.php line 42

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\Twig\DeterministicTwigIdCalculator;
  18. use Symfony\UX\LiveComponent\Util\ChildComponentPartialRenderer;
  19. use Symfony\UX\LiveComponent\Util\LiveControllerAttributesCreator;
  20. use Symfony\UX\TwigComponent\ComponentStack;
  21. use Symfony\UX\TwigComponent\Event\PreCreateForRenderEvent;
  23. /**
  24.  * Responsible for rendering children as empty elements during a re-render.
  25.  *
  26.  * @author Ryan Weaver <ryan@symfonycasts.com>
  27.  *
  28.  * @experimental
  29.  *
  30.  * @internal
  31.  */
  32. class InterceptChildComponentRenderSubscriber implements EventSubscriberInterface, ServiceSubscriberInterface
  33. {
  34.     public const CHILDREN_FINGERPRINTS_METADATA_KEY = 'children_fingerprints';
  36.     public function __construct(
  37.         private ComponentStack $componentStack,
  38.         private ContainerInterface $container,
  39.     ) {
  40.     }
  42.     public function preComponentCreated(PreCreateForRenderEvent $event): void
  43.     {
  44.         // if there is already a component, that's a parent. Else, this is not a child.
  45.         if (null === $parentComponent = $this->componentStack->getCurrentComponent()) {
  46.             return;
  47.         }
  49.         if (!$parentComponent->hasExtraMetadata(self::CHILDREN_FINGERPRINTS_METADATA_KEY)) {
  50.             return;
  51.         }
  53.         $childFingerprints = $parentComponent->getExtraMetadata(self::CHILDREN_FINGERPRINTS_METADATA_KEY);
  55.         // get the deterministic id for this child, but without incrementing the counter yet
  56.         if (isset($event->getInputProps()['data-live-id'])) {
  57.             $deterministicId = $event->getInputProps()['data-live-id'];
  58.         } else {
  59.             $key = $event->getInputProps()[LiveControllerAttributesCreator::KEY_PROP_NAME] ?? null;
  60.             $deterministicId = $this->getDeterministicIdCalculator()->calculateDeterministicId(increment: false, key: $key);
  61.         }
  63.         if (!isset($childFingerprints[$deterministicId])) {
  64.             // child fingerprint wasn't set, it is likely a new child, allow it to render fully
  65.             return;
  66.         }
  68.         // increment the internal counter now to keep "counter" consistency if we're
  69.         // in a loop of children being rendered on the same line
  70.         // we need to do this because this component will *not* ever hit
  71.         // AddLiveAttributesSubscriber where the counter is normally incremented
  72.         $this->getDeterministicIdCalculator()->calculateDeterministicId(increment: true);
  74.         $childPartialRenderer = $this->container->get(ChildComponentPartialRenderer::class);
  75.         \assert($childPartialRenderer instanceof ChildComponentPartialRenderer);
  77.         $rendered = $childPartialRenderer->renderChildComponent(
  78.             $deterministicId,
  79.             $childFingerprints[$deterministicId]['fingerprint'],
  80.             $childFingerprints[$deterministicId]['tag'],
  81.             $event->getName(),
  82.             $event->getInputProps(),
  83.         );
  84.         $event->setRenderedString($rendered);
  85.     }
  87.     public static function getSubscribedServices(): array
  88.     {
  89.         return [
  90.             DeterministicTwigIdCalculator::class,
  91.             ChildComponentPartialRenderer::class,
  92.         ];
  93.     }
  95.     public static function getSubscribedEvents(): array
  96.     {
  97.         return [
  98.             PreCreateForRenderEvent::class => 'preComponentCreated',
  99.         ];
  100.     }
  102.     private function getDeterministicIdCalculator(): DeterministicTwigIdCalculator
  103.     {
  104.         return $this->container->get(DeterministicTwigIdCalculator::class);
  105.     }
  107.     private function getAttributesCreator(): LiveControllerAttributesCreator
  108.     {
  109.         return $this->container->get(LiveControllerAttributesCreator::class);
  110.     }
  111. }