class OnClearEventArgs in Plug 7

Provides event arguments for the onClear event.

@link www.doctrine-project.org @since 2.2 @author Roman Borschel <[e-mail]> @author Benjamin Eberlei <[e-mail]>

Hierarchy

• class \Doctrine\Common\EventArgs
  • class \Doctrine\Common\Persistence\Event\OnClearEventArgs

File

lib/doctrine/common/lib/Doctrine/Common/Persistence/Event/OnClearEventArgs.php, line 33

Namespace

Doctrine\Common\Persistence\Event

class OnClearEventArgs extends EventArgs {

  /**
   * @var \Doctrine\Common\Persistence\ObjectManager
   */
  private $objectManager;

  /**
   * @var string|null
   */
  private $entityClass;

  /**
   * Constructor.
   *
   * @param ObjectManager $objectManager The object manager.
   * @param string|null   $entityClass   The optional entity class.
   */
  public function __construct($objectManager, $entityClass = null) {
    $this->objectManager = $objectManager;
    $this->entityClass = $entityClass;
  }

  /**
   * Retrieves the associated ObjectManager.
   *
   * @return \Doctrine\Common\Persistence\ObjectManager
   */
  public function getObjectManager() {
    return $this->objectManager;
  }

  /**
   * Returns the name of the entity class that is cleared, or null if all are cleared.
   *
   * @return string|null
   */
  public function getEntityClass() {
    return $this->entityClass;
  }

  /**
   * Returns whether this event clears all entities.
   *
   * @return bool
   */
  public function clearsAllEntities() {
    return $this->entityClass === null;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EventArgs::$_emptyEventArgsInstance	private static	property	Single instance of EventArgs.
EventArgs::getEmptyInstance	public static	function	Gets the single, empty and immutable EventArgs instance.
OnClearEventArgs::$entityClass	private	property
OnClearEventArgs::$objectManager	private	property
OnClearEventArgs::clearsAllEntities	public	function	Returns whether this event clears all entities.
OnClearEventArgs::getEntityClass	public	function	Returns the name of the entity class that is cleared, or null if all are cleared.
OnClearEventArgs::getObjectManager	public	function	Retrieves the associated ObjectManager.
OnClearEventArgs::__construct	public	function	Constructor.