vendor/doctrine/orm/lib/Doctrine/ORM/Internal/HydrationCompleteHandler.php line 58

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM\Internal;
  7. use Doctrine\ORM\EntityManagerInterface;
  8. use Doctrine\ORM\Event\ListenersInvoker;
  9. use Doctrine\ORM\Event\PostLoadEventArgs;
  10. use Doctrine\ORM\Events;
  11. use Doctrine\ORM\Mapping\ClassMetadata;
  13. /**
  14.  * Class, which can handle completion of hydration cycle and produce some of tasks.
  15.  * In current implementation triggers deferred postLoad event.
  16.  */
  17. final class HydrationCompleteHandler
  18. {
  19.     /** @var ListenersInvoker */
  20.     private $listenersInvoker;
  22.     /** @var EntityManagerInterface */
  23.     private $em;
  25.     /** @var mixed[][] */
  26.     private $deferredPostLoadInvocations = [];
  28.     /**
  29.      * Constructor for this object
  30.      */
  31.     public function __construct(ListenersInvoker $listenersInvoker, EntityManagerInterface $em)
  32.     {
  33.         $this->listenersInvoker = $listenersInvoker;
  34.         $this->em               = $em;
  35.     }
  37.     /**
  38.      * Method schedules invoking of postLoad entity to the very end of current hydration cycle.
  39.      *
  40.      * @param object $entity
  41.      */
  42.     public function deferPostLoadInvoking(ClassMetadata $class, $entity): void
  43.     {
  44.         $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::postLoad);
  46.         if ($invoke === ListenersInvoker::INVOKE_NONE) {
  47.             return;
  48.         }
  50.         $this->deferredPostLoadInvocations[] = [$class, $invoke, $entity];
  51.     }
  53.     /**
  54.      * This method should me called after any hydration cycle completed.
  55.      *
  56.      * Method fires all deferred invocations of postLoad events
  57.      */
  58.     public function hydrationComplete(): void
  59.     {
  60.         $toInvoke                          = $this->deferredPostLoadInvocations;
  61.         $this->deferredPostLoadInvocations = [];
  63.         foreach ($toInvoke as $classAndEntity) {
  64.             [$class, $invoke, $entity] = $classAndEntity;
  66.             $this->listenersInvoker->invoke(
  67.                 $class,
  68.                 Events::postLoad,
  69.                 $entity,
  70.                 new PostLoadEventArgs($entity, $this->em),
  71.                 $invoke
  72.             );
  73.         }
  74.     }
  75. }