Provides event arguments for the onClear event.
@license http://www.opensource.org/licenses/lgpl-license.php LGPL @link www.doctrine-project.org @since 2.2 @author Roman Borschel <roman@code-factory.de> @author Benjamin Eberlei <kontakt@beberlei.de>
Expanded class hierarchy of OnClearEventArgs
class OnClearEventArgs extends \Doctrine\Common\EventArgs {
/**
* @var \Doctrine\Common\Persistence\ObjectManager
*/
private $objectManager;
/**
* @var string
*/
private $entityClass;
/**
* Constructor.
*
* @param \Doctrine\Common\Persistence\ObjectManager $objectManager
* @param string $entityClass Optional entity class
*/
public function __construct($objectManager, $entityClass = null) {
$this->objectManager = $objectManager;
$this->entityClass = $entityClass;
}
/**
* Retrieve associated ObjectManager.
*
* @return \Doctrine\Common\Persistence\ObjectManager
*/
public function getObjectManager() {
return $this->objectManager;
}
/**
* Name of the entity class that is cleared, or empty if all are cleared.
*
* @return string
*/
public function getEntityClass() {
return $this->entityClass;
}
/**
* Check if event clears all entities.
*
* @return bool
*/
public function clearsAllEntities() {
return $this->entityClass === null;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
EventArgs:: |
private static | property | ||
EventArgs:: |
public static | function | Gets the single, empty and immutable EventArgs instance. | |
OnClearEventArgs:: |
private | property | ||
OnClearEventArgs:: |
private | property | ||
OnClearEventArgs:: |
public | function | Check if event clears all entities. | |
OnClearEventArgs:: |
public | function | Name of the entity class that is cleared, or empty if all are cleared. | |
OnClearEventArgs:: |
public | function | Retrieve associated ObjectManager. | |
OnClearEventArgs:: |
public | function | Constructor. |