class OnClearEventArgs

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>

Hierarchy

Expanded class hierarchy of OnClearEventArgs

File

drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Persistence/Event/OnClearEventArgs.php, line 31

Namespace

Doctrine\Common\Persistence\Event
View source
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;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EventArgs::$_emptyEventArgsInstance private static property
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 Check if event clears all entities.
OnClearEventArgs::getEntityClass public function Name of the entity class that is cleared, or empty if all are cleared.
OnClearEventArgs::getObjectManager public function Retrieve associated ObjectManager.
OnClearEventArgs::__construct public function Constructor.