Event extends Event
Table of Contents
Methods
- __construct() : mixed
- addDebugInfo() : mixed
- addException() : mixed
- addResult() : mixed
- getDebugInfo() : mixed
- getEntity() : mixed
- Returns entity
- getErrors() : bool
- Checks the result of the event for errors, fills the Result object.
- getEventType() : mixed
- getExceptions() : mixed
- getFilter() : mixed
- getModuleId() : mixed
- getParameter() : mixed
- getParameters() : mixed
- getResults() : array<string|int, EventResult>
- getSender() : mixed
- isDebugOn() : mixed
- mergeFields() : array<string|int, mixed>
- Merges the data fields set in the event handlers with the source fields.
- mergeObjectFields() : mixed
- send() : mixed
- setFilter() : mixed
- setParameter() : mixed
- setParameters() : mixed
- turnDebugOn() : mixed
Methods
__construct()
public
__construct(Entity $entity, string $type[, array<string|int, mixed> $parameters = array() ][, bool $withNamespace = false ]) : mixed
Parameters
- $entity : Entity
- $type : string
- $parameters : array<string|int, mixed> = array()
- $withNamespace : bool = false
addDebugInfo()
public
addDebugInfo(mixed $ar) : mixed
Parameters
- $ar : mixed
addException()
public
addException(Exception $exception) : mixed
Parameters
- $exception : Exception
addResult()
public
addResult(EventResult $result) : mixed
Parameters
- $result : EventResult
getDebugInfo()
public
getDebugInfo() : mixed
getEntity()
Returns entity
public
getEntity() : mixed
getErrors()
Checks the result of the event for errors, fills the Result object.
public
getErrors(Result $result) : bool
Returns true on errors, false on no errors.
Parameters
- $result : Result
Return values
boolgetEventType()
public
getEventType() : mixed
getExceptions()
public
getExceptions() : mixed
getFilter()
public
getFilter() : mixed
getModuleId()
public
getModuleId() : mixed
getParameter()
public
getParameter(mixed $key) : mixed
Parameters
- $key : mixed
getParameters()
public
getParameters() : mixed
getResults()
public
getResults() : array<string|int, EventResult>
Return values
array<string|int, EventResult>getSender()
public
getSender() : mixed
isDebugOn()
public
isDebugOn() : mixed
mergeFields()
Merges the data fields set in the event handlers with the source fields.
public
mergeFields(array<string|int, mixed> $data) : array<string|int, mixed>
Returns a merged array of the data fields from the all event handlers.
Parameters
- $data : array<string|int, mixed>
Return values
array<string|int, mixed>mergeObjectFields()
public
mergeObjectFields(EntityObject $object) : mixed
Parameters
- $object : EntityObject
send()
public
send([mixed $sender = null ]) : mixed
Parameters
- $sender : mixed = null
setFilter()
public
setFilter(mixed $filter) : mixed
Parameters
- $filter : mixed
setParameter()
public
setParameter(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
setParameters()
public
setParameters(mixed $parameters) : mixed
Parameters
- $parameters : mixed
turnDebugOn()
public
turnDebugOn() : mixed