class OnClearEventArgs extends EventArgs (View source)

Provides event arguments for the onClear event.

Methods

static EventArgs
getEmptyInstance()

Gets the single, empty and immutable EventArgs instance.

from EventArgs
__construct(ObjectManager $objectManager, string|null $entityClass = null)

Constructor.

getObjectManager()

Retrieves the associated ObjectManager.

string|null
getEntityClass()

Returns the name of the entity class that is cleared, or null if all are cleared.

bool
clearsAllEntities()

Returns whether this event clears all entities.

Details

static EventArgs getEmptyInstance()

Gets the single, empty and immutable EventArgs instance.

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).

Return Value

EventArgs

See also

EventManager::dispatchEvent

__construct(ObjectManager $objectManager, string|null $entityClass = null)

Constructor.

Parameters

ObjectManager $objectManager The object manager.
string|null $entityClass The optional entity class.

ObjectManager getObjectManager()

Retrieves the associated ObjectManager.

Return Value

ObjectManager

string|null getEntityClass()

Returns the name of the entity class that is cleared, or null if all are cleared.

Return Value

string|null

bool clearsAllEntities()

Returns whether this event clears all entities.

Return Value

bool