www.aleph1.co.uk Git - yaffs-website/blob - vendor/doctrine/common/lib/Doctrine/Common/Persistence/Event/LifecycleEventArgs.php

   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  */
  19
  20 namespace Doctrine\Common\Persistence\Event;
  21
  22 use Doctrine\Common\EventArgs;
  23 use Doctrine\Common\Persistence\ObjectManager;
  24
  25 /**
  26  * Lifecycle Events are triggered by the UnitOfWork during lifecycle transitions
  27  * of entities.
  28  *
  29  * @link   www.doctrine-project.org
  30  * @since  2.2
  31  * @author Roman Borschel <roman@code-factory.de>
  32  * @author Benjamin Eberlei <kontakt@beberlei.de>
  33  */
  34 class LifecycleEventArgs extends EventArgs
  35 {
  36     /**
  37      * @var ObjectManager
  38      */
  39     private $objectManager;
  40
  41     /**
  42      * @var object
  43      */
  44     private $object;
  45
  46     /**
  47      * Constructor.
  48      *
  49      * @param object        $object
  50      * @param ObjectManager $objectManager
  51      */
  52     public function __construct($object, ObjectManager $objectManager)
  53     {
  54         $this->object = $object;
  55         $this->objectManager = $objectManager;
  56     }
  57
  58     /**
  59      * Retrieves the associated entity.
  60      *
  61      * @deprecated
  62      *
  63      * @return object
  64      */
  65     public function getEntity()
  66     {
  67         return $this->object;
  68     }
  69
  70     /**
  71      * Retrieves the associated object.
  72      *
  73      * @return object
  74      */
  75     public function getObject()
  76     {
  77         return $this->object;
  78     }
  79
  80     /**
  81      * Retrieves the associated ObjectManager.
  82      *
  83      * @return ObjectManager
  84      */
  85     public function getObjectManager()
  86     {
  87         return $this->objectManager;
  88     }
  89 }