AbstractEvent
Implements EventInterface, ArrayAccess, Serializable, CountableImplementation of EventInterface.
since |
1.0 |
---|---|
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(string name, array arguments = []) : mixed
since |
1.0 |
---|
Arguments
- name
string
The event name.- arguments
array
The event arguments.
Response
mixed
__serialize
Serialize the event.
__serialize() : array
since |
2.0.0 |
---|
Response
array
The data to be serialized
__unserialize
Unserialize the event.
__unserialize(array data) : void
since |
2.0.0 |
---|
Arguments
- data
array
The serialized event.
count
Count the number of arguments.
count() : int
since |
1.0 |
---|
Response
int
The number of arguments.
getArgument
Get an event argument value.
getArgument(string name, mixed default = null) : mixed
since |
1.0 |
---|
Arguments
- name
string
The argument name.- default
mixed
The default value if not found.
Response
mixed
The argument value or the default value.
getArguments
Get all event arguments.
getArguments() : array
since |
1.0 |
---|
Response
array
An associative array of argument names as keys and their values as values.
getName
Get the event name.
getName() : string
since |
1.0 |
---|
Response
string
The event name.
hasArgument
Tell if the given event argument exists.
hasArgument(string name) : bool
since |
1.0 |
---|
Arguments
- name
string
The argument name.
Response
bool
True if it exists, false otherwise.
isStopped
Tell if the event propagation is stopped.
isStopped() : bool
since |
1.0 |
---|
Response
bool
True if stopped, false otherwise.
offsetExists
Tell if the given event argument exists.
offsetExists(string name) : bool
since |
1.0 |
---|
Arguments
- name
string
The argument name.
Response
bool
True if it exists, false otherwise.
offsetGet
Get an event argument value.
offsetGet(string name) : mixed
since |
1.0 |
---|
Arguments
- name
string
The argument name.
Response
mixed
The argument value or null if not existing.
serialize
Serialize the event.
serialize() : string
since |
1.0 |
---|
Response
string
The serialized event.
stopPropagation
Stops the propagation of the event to further event listeners.
stopPropagation() : void
since |
2.0.0 |
---|
unserialize
Unserialize the event.
unserialize(string serialized) : void
since |
1.0 |
---|
Arguments
- serialized
string
The serialized event.
Properties
name
The event name.
since |
1.0 |
---|
Type(s)
string
arguments
The event arguments.
since |
1.0 |
---|
Type(s)
array
stopped
A flag to see if the event propagation is stopped.
since |
1.0 |
---|
Type(s)
bool