OnClearEventArgs
extends OnClearEventArgs
in package
Provides event arguments for the onClear event.
Tags
Table of Contents
Properties
- $_emptyEventArgsInstance : EventArgs|null
- Single instance of EventArgs.
- $entityClass : string|null
- $objectManager : ObjectManager
Methods
- __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.
- getObjectManager() : ObjectManager
- Retrieves the associated ObjectManager.
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs|null
$_emptyEventArgsInstance
$entityClass
private
string|null
$entityClass
$objectManager
private
ObjectManager
$objectManager
Tags
Methods
__construct()
public
__construct(EntityManagerInterface $em[, string|null $entityClass = null ]) : mixed
Parameters
- $em : EntityManagerInterface
- $entityClass : string|null = null
-
Optional entity class.
clearsAllEntities()
Checks if event clears all entities.
public
clearsAllEntities() : bool
Tags
Return values
boolgetEmptyInstance()
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
EventArgsgetEntityClass()
Name of the entity class that is cleared, or empty if all are cleared.
public
getEntityClass() : string|null
Tags
Return values
string|nullgetEntityManager()
Retrieves associated EntityManager.
public
getEntityManager() : EntityManagerInterface
Tags
Return values
EntityManagerInterfacegetObjectManager()
Retrieves the associated ObjectManager.
public
getObjectManager() : ObjectManager