EventInterface
Event interface
Table of Contents
Methods
| getName() | Retrieves the name of the event |
| getParams() | Retrieves the parameters set for this event, if any |
| getReturnValue() | Returns the return value set for this event |
| setParams() | Sets parameters for this event |
| setReturnValue() | Sets the return value for this event |
Methods
getName()
Retrieves the name of the event
public
getName() : string
Return values
string —The name of the event
getParams()
Retrieves the parameters set for this event, if any
public
getParams() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —An array of set parameters, otherwise null
getReturnValue()
Returns the return value set for this event
public
getReturnValue() : mixed
Return values
mixed —The return value for the event
setParams()
Sets parameters for this event
public
setParams([array<string|int, mixed> $params = null ]) : mixed
Parameters
- $params : array<string|int, mixed> = null
-
An array of parameters to be held by this event
setReturnValue()
Sets the return value for this event
public
setReturnValue(mixed $value) : mixed
Parameters
- $value : mixed
-
The return value for the event