vendor/symfony/ux-live-component/src/EventListener/ResetDeterministicIdSubscriber.php line 51

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 Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\UX\LiveComponent\Twig\DeterministicTwigIdCalculator;
  16. use Symfony\UX\TwigComponent\ComponentStack;
  17. use Symfony\UX\TwigComponent\Event\PostRenderEvent;
  19. /**
  20.  * Resets the "deterministic id calculator" after each full "parent" component has finished rendering.
  21.  *
  22.  * When a component (and all of its children) have finished rendering, this resets
  23.  * the internal "counter" on the id calculator. Suppose this situation:
  24.  *
  25.  *      Parent Component A
  26.  *          Child Component 1
  27.  *
  28.  *      Parent Component B
  29.  *          Child Component 1
  30.  *
  31.  * If we didn't reset, the deterministic id of the two "Child Component 1" objects
  32.  * would be *different*: the first would end with "-0" and the second with "-1".
  33.  * This is a problem because when "Parent Component B" renders later via Ajax,
  34.  * its child will generate an id ending in "-0", since there wasn't a previous
  35.  * Child Component 1 that rendered during that request.
  36.  *
  37.  * @author Ryan Weaver <ryan@symfonycasts.com>
  38.  *
  39.  * @experimental
  40.  *
  41.  * @internal
  42.  */
  43. final class ResetDeterministicIdSubscriber implements EventSubscriberInterface
  44. {
  45.     public function __construct(
  46.         private DeterministicTwigIdCalculator $idCalculator,
  47.         private ComponentStack $componentStack
  48.     ) {
  49.     }
  51.     public function onPostRender(): void
  52.     {
  53.         if (!$this->componentStack->getCurrentComponent()) {
  54.             $this->idCalculator->reset();
  55.         }
  56.     }
  58.     public static function getSubscribedEvents(): array
  59.     {
  60.         return [PostRenderEvent::class => 'onPostRender'];
  61.     }
  62. }