SchemaEventArgs
extends EventArgs
in package
Base class for schema related events.
Tags
Table of Contents
Properties
- $_emptyEventArgsInstance : EventArgs|null
- Single instance of EventArgs.
- $preventDefault : bool
Methods
- getEmptyInstance() : EventArgs
- Gets the single, empty and immutable EventArgs instance.
- isDefaultPrevented() : bool
- preventDefault() : SchemaEventArgs
Properties
$_emptyEventArgsInstance
Single instance of EventArgs.
private
static EventArgs|null
$_emptyEventArgsInstance
$preventDefault
private
bool
$preventDefault
= false
Methods
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
EventArgsisDefaultPrevented()
public
isDefaultPrevented() : bool
Return values
boolpreventDefault()
public
preventDefault() : SchemaEventArgs