EventInterface
in
Representation of an event
Table of Contents
- getName() : string
- Get event name
- getParam() : mixed
- Get a single parameter by name
- getParams() : array<string|int, mixed>|ArrayAccess
- Get parameters passed to the event
- getTarget() : null|string|object
- Get target/context from which event was triggered
- propagationIsStopped() : bool
- Has this event indicated event propagation should stop?
- setName() : void
- Set the event name
- setParam() : void
- Set a single parameter by key
- setParams() : void
- Set event parameters
- setTarget() : void
- Set the event target/context
- stopPropagation() : void
- Indicate whether or not the parent EventManagerInterface should stop propagating events
Methods
getName()
Get event name
public
getName() : string
Return values
string —getParam()
Get a single parameter by name
public
getParam(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
- $default : mixed = null
-
Default value to return if parameter does not exist
Return values
mixed —getParams()
Get parameters passed to the event
public
getParams() : array<string|int, mixed>|ArrayAccess
Return values
array<string|int, mixed>|ArrayAccess —getTarget()
Get target/context from which event was triggered
public
getTarget() : null|string|object
Return values
null|string|object —propagationIsStopped()
Has this event indicated event propagation should stop?
public
propagationIsStopped() : bool
Return values
bool —setName()
Set the event name
public
setName(string $name) : void
Parameters
- $name : string
Return values
void —setParam()
Set a single parameter by key
public
setParam(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
Return values
void —setParams()
Set event parameters
public
setParams(array<string|int, mixed>|ArrayAccess $params) : void
Parameters
- $params : array<string|int, mixed>|ArrayAccess
Return values
void —setTarget()
Set the event target/context
public
setTarget(null|string|object $target) : void
Parameters
- $target : null|string|object
Return values
void —stopPropagation()
Indicate whether or not the parent EventManagerInterface should stop propagating events
public
stopPropagation([bool $flag = true ]) : void
Parameters
- $flag : bool = true