OnClearEventArgs
extends EventArgs
in package
Provides event arguments for the onClear event.
Table of Contents
- $_emptyEventArgsInstance : EventArgs
- Single instance of EventArgs.
- $entityClass : string|null
- $objectManager : ObjectManager
- __construct() : mixed
- clearsAllEntities() : bool
- Returns whether this event clears all entities.
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- getEntityClass() : string|null
- Returns the name of the entity class that is cleared, or null if all are cleared.
- getObjectManager() : ObjectManager
- Retrieves the associated ObjectManager.
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs
$_emptyEventArgsInstance
$entityClass
private
string|null
$entityClass
$objectManager
private
ObjectManager
$objectManager
Methods
__construct()
public
__construct(ObjectManager $objectManager[, string|null $entityClass = null ]) : mixed
Parameters
- $objectManager : ObjectManager
-
The object manager.
- $entityClass : string|null = null
-
The optional entity class.
Return values
mixed —clearsAllEntities()
Returns whether this 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()
Returns the name of the entity class that is cleared, or null if all are cleared.
public
getEntityClass() : string|null
Return values
string|null —getObjectManager()
Retrieves the associated ObjectManager.
public
getObjectManager() : ObjectManager