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 /**
  23  * Provides event arguments for the onClear event.
  24  *
  25  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  26  * @link        www.doctrine-project.org
  27  * @since       2.2
  28  * @author      Roman Borschel <roman@code-factory.de>
  29  * @author      Benjamin Eberlei <kontakt@beberlei.de>
  30  */
  31 class OnClearEventArgs extends \Doctrine\Common\EventArgs
  32 {
  33     /**
  34      * @var \Doctrine\Common\Persistence\ObjectManager
  35      */
  36     private $objectManager;
  37
  38     /**
  39      * @var string
  40      */
  41     private $entityClass;
  42
  43     /**
  44      * Constructor.
  45      *
  46      * @param \Doctrine\Common\Persistence\ObjectManager $objectManager
  47      * @param string $entityClass Optional entity class
  48      */
  49     public function __construct($objectManager, $entityClass = null)
  50     {
  51         $this->objectManager = $objectManager;
  52         $this->entityClass = $entityClass;
  53     }
  54
  55     /**
  56      * Retrieve associated ObjectManager.
  57      *
  58      * @return \Doctrine\Common\Persistence\ObjectManager
  59      */
  60     public function getObjectManager()
  61     {
  62         return $this->objectManager;
  63     }
  64
  65     /**
  66      * Name of the entity class that is cleared, or empty if all are cleared.
  67      *
  68      * @return string
  69      */
  70     public function getEntityClass()
  71     {
  72         return $this->entityClass;
  73     }
  74
  75     /**
  76      * Check if event clears all entities.
  77      *
  78      * @return bool
  79      */
  80     public function clearsAllEntities()
  81     {
  82         return ($this->entityClass === null);
  83     }
  84 }