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

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