Chris@0: <?php
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Persistence\Event;
Chris@0: 
Chris@0: use Doctrine\Common\EventArgs;
Chris@0: use Doctrine\Common\Persistence\ObjectManager;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides event arguments for the onClear event.
Chris@0:  *
Chris@0:  * @link   www.doctrine-project.org
Chris@0:  * @since  2.2
Chris@0:  * @author Roman Borschel <roman@code-factory.de>
Chris@0:  * @author Benjamin Eberlei <kontakt@beberlei.de>
Chris@0:  */
Chris@0: class OnClearEventArgs extends EventArgs
Chris@0: {
Chris@0:     /**
Chris@0:      * @var \Doctrine\Common\Persistence\ObjectManager
Chris@0:      */
Chris@0:     private $objectManager;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var string|null
Chris@0:      */
Chris@0:     private $entityClass;
Chris@0: 
Chris@0:     /**
Chris@0:      * Constructor.
Chris@0:      *
Chris@0:      * @param ObjectManager $objectManager The object manager.
Chris@0:      * @param string|null   $entityClass   The optional entity class.
Chris@0:      */
Chris@0:     public function __construct($objectManager, $entityClass = null)
Chris@0:     {
Chris@0:         $this->objectManager = $objectManager;
Chris@0:         $this->entityClass = $entityClass;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Retrieves the associated ObjectManager.
Chris@0:      *
Chris@0:      * @return \Doctrine\Common\Persistence\ObjectManager
Chris@0:      */
Chris@0:     public function getObjectManager()
Chris@0:     {
Chris@0:         return $this->objectManager;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the name of the entity class that is cleared, or null if all are cleared.
Chris@0:      *
Chris@0:      * @return string|null
Chris@0:      */
Chris@0:     public function getEntityClass()
Chris@0:     {
Chris@0:         return $this->entityClass;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns whether this event clears all entities.
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     public function clearsAllEntities()
Chris@0:     {
Chris@0:         return ($this->entityClass === null);
Chris@0:     }
Chris@0: }