vendor/doctrine/orm/lib/Doctrine/ORM/Event/ListenersInvoker.php line 115

Open in your IDE?
  1. <?php
  3. /*
  4.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  5.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  6.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  7.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  8.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  9.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  10.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  11.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  12.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  13.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  14.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  15.  *
  16.  * This software consists of voluntary contributions made by many individuals
  17.  * and is licensed under the MIT license. For more information, see
  18.  * <http://www.doctrine-project.org>.
  19.  */
  21. namespace Doctrine\ORM\Event;
  23. use Doctrine\Common\EventArgs;
  24. use Doctrine\Common\EventManager;
  25. use Doctrine\ORM\EntityManagerInterface;
  26. use Doctrine\ORM\Mapping\ClassMetadata;
  27. use Doctrine\ORM\Mapping\EntityListenerResolver;
  29. /**
  30.  * A method invoker based on entity lifecycle.
  31.  */
  32. class ListenersInvoker
  33. {
  34.     public const INVOKE_NONE      = 0;
  35.     public const INVOKE_LISTENERS = 1;
  36.     public const INVOKE_CALLBACKS = 2;
  37.     public const INVOKE_MANAGER   = 4;
  39.     /** @var EntityListenerResolver The Entity listener resolver. */
  40.     private $resolver;
  42.     /**
  43.      * The EventManager used for dispatching events.
  44.      *
  45.      * @var EventManager
  46.      */
  47.     private $eventManager;
  49.     /**
  50.      * Initializes a new ListenersInvoker instance.
  51.      */
  52.     public function __construct(EntityManagerInterface $em)
  53.     {
  54.         $this->eventManager = $em->getEventManager();
  55.         $this->resolver     = $em->getConfiguration()->getEntityListenerResolver();
  56.     }
  58.     /**
  59.      * Get the subscribed event systems
  60.      *
  61.      * @param ClassMetadata $metadata  The entity metadata.
  62.      * @param string        $eventName The entity lifecycle event.
  63.      *
  64.      * @return int Bitmask of subscribed event systems.
  65.      */
  66.     public function getSubscribedSystems(ClassMetadata $metadata, $eventName)
  67.     {
  68.         $invoke = self::INVOKE_NONE;
  70.         if (isset($metadata->lifecycleCallbacks[$eventName])) {
  71.             $invoke |= self::INVOKE_CALLBACKS;
  72.         }
  74.         if (isset($metadata->entityListeners[$eventName])) {
  75.             $invoke |= self::INVOKE_LISTENERS;
  76.         }
  78.         if ($this->eventManager->hasListeners($eventName)) {
  79.             $invoke |= self::INVOKE_MANAGER;
  80.         }
  82.         return $invoke;
  83.     }
  85.     /**
  86.      * Dispatches the lifecycle event of the given entity.
  87.      *
  88.      * @param ClassMetadata $metadata  The entity metadata.
  89.      * @param string        $eventName The entity lifecycle event.
  90.      * @param object        $entity    The Entity on which the event occurred.
  91.      * @param EventArgs     $event     The Event args.
  92.      * @param int           $invoke    Bitmask to invoke listeners.
  93.      *
  94.      * @return void
  95.      */
  96.     public function invoke(ClassMetadata $metadata, $eventName, $entity, EventArgs $event, $invoke)
  97.     {
  98.         if ($invoke & self::INVOKE_CALLBACKS) {
  99.             foreach ($metadata->lifecycleCallbacks[$eventName] as $callback) {
  100.                 $entity->$callback($event);
  101.             }
  102.         }
  104.         if ($invoke & self::INVOKE_LISTENERS) {
  105.             foreach ($metadata->entityListeners[$eventName] as $listener) {
  106.                 $class    = $listener['class'];
  107.                 $method   = $listener['method'];
  108.                 $instance = $this->resolver->resolve($class);
  110.                 $instance->$method($entity, $event);
  111.             }
  112.         }
  114.         if ($invoke & self::INVOKE_MANAGER) {
  115.             $this->eventManager->dispatchEvent($eventName, $event);
  116.         }
  117.     }
  118. }