OnClearEventArgs
extends EventArgs
in package
Provides event arguments for the onClear event.
Tags
Table of Contents
- $_emptyEventArgsInstance : EventArgs
- Single instance of EventArgs.
- $em : EntityManagerInterface
- $entityClass : string|null
- __construct() : mixed
- clearsAllEntities() : bool
- Checks if event clears all entities.
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getEntityClass() : string|null
- Name of the entity class that is cleared, or empty if all are cleared.
- getEntityManager() : EntityManagerInterface
- Retrieves associated EntityManager.
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs
$_emptyEventArgsInstance
$em
private
EntityManagerInterface
$em
$entityClass
private
string|null
$entityClass
Methods
__construct()
public
__construct(EntityManagerInterface $em[, string|null $entityClass = null ]) : mixed
Parameters
- $em : EntityManagerInterface
- $entityClass : string|null = null
-
Optional entity class.
Return values
mixed —clearsAllEntities()
Checks if event clears all entities.
public
clearsAllEntities() : bool
Return values
bool —getEmptyInstance()
Gets the single, empty and immutable EventArgs instance.
public
static getEmptyInstance() : EventArgs
This instance will be used when events are dispatched without any parameter, like this: EventManager::dispatchEvent('eventname');
The benefit from this is that only one empty instance is instantiated and shared (otherwise there would be instances for every dispatched in the abovementioned form).
Tags
Return values
EventArgs —getEntityClass()
Name of the entity class that is cleared, or empty if all are cleared.
public
getEntityClass() : string|null
Return values
string|null —getEntityManager()
Retrieves associated EntityManager.
public
getEntityManager() : EntityManagerInterface