www.aleph1.co.uk Git - yaffs-website/blob - vendor/doctrine/common/lib/Doctrine/Common/Persistence/Event/OnClearEventArgs.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  * Provides event arguments for the onClear event.
  27  *
  28  * @link   www.doctrine-project.org
  29  * @since  2.2
  30  * @author Roman Borschel <roman@code-factory.de>
  31  * @author Benjamin Eberlei <kontakt@beberlei.de>
  32  */
  33 class OnClearEventArgs extends EventArgs
  34 {
  35     /**
  36      * @var \Doctrine\Common\Persistence\ObjectManager
  37      */
  38     private $objectManager;
  39
  40     /**
  41      * @var string|null
  42      */
  43     private $entityClass;
  44
  45     /**
  46      * Constructor.
  47      *
  48      * @param ObjectManager $objectManager The object manager.
  49      * @param string|null   $entityClass   The optional entity class.
  50      */
  51     public function __construct($objectManager, $entityClass = null)
  52     {
  53         $this->objectManager = $objectManager;
  54         $this->entityClass = $entityClass;
  55     }
  56
  57     /**
  58      * Retrieves the associated ObjectManager.
  59      *
  60      * @return \Doctrine\Common\Persistence\ObjectManager
  61      */
  62     public function getObjectManager()
  63     {
  64         return $this->objectManager;
  65     }
  66
  67     /**
  68      * Returns the name of the entity class that is cleared, or null if all are cleared.
  69      *
  70      * @return string|null
  71      */
  72     public function getEntityClass()
  73     {
  74         return $this->entityClass;
  75     }
  76
  77     /**
  78      * Returns whether this event clears all entities.
  79      *
  80      * @return bool
  81      */
  82     public function clearsAllEntities()
  83     {
  84         return ($this->entityClass === null);
  85     }
  86 }