CSStagingRecordEventHandler
in package
Handler class for staging record events. This class is used to handle the events that are triggered by the staging queue.
Tags
Table of Contents
- __construct() : mixed
- getEventData() : array<string|int, mixed>
- Retrieves the event data as an array.
- getEventType() : string
- Returns the event type for the event.
- getReturnMessage() : string
- Returns the message associated with the event handler.
- getState() : CSStagingRecordEventState
- Get the exeuction state of the event.
- handleEvent() : void
- Handles the event. Entry class for every event and does "magic" forwarding to handle it to the responsible method.
- setEventData() : void
- Sets the event data.
- setEventType() : void
- Sets the event type for the staging record event handler.
Methods
__construct()
public
__construct(string $sEventType[, array<string|int, mixed> $aEventData = [] ]) : mixed
Parameters
- $sEventType : string
- $aEventData : array<string|int, mixed> = []
Tags
Return values
mixed —getEventData()
Retrieves the event data as an array.
public
getEventData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —The event data.
getEventType()
Returns the event type for the event.
public
getEventType() : string
Tags
Return values
string —The event type.
getReturnMessage()
Returns the message associated with the event handler.
public
getReturnMessage() : string
Tags
Return values
string —The return message.
getState()
Get the exeuction state of the event.
public
getState() : CSStagingRecordEventState
Tags
Return values
CSStagingRecordEventState —The state.
handleEvent()
Handles the event. Entry class for every event and does "magic" forwarding to handle it to the responsible method.
public
handleEvent() : void
Tags
Return values
void —setEventData()
Sets the event data.
public
setEventData(array<string|int, mixed> $aEventData) : void
Parameters
- $aEventData : array<string|int, mixed>
-
The event data.
Tags
Return values
void —setEventType()
Sets the event type for the staging record event handler.
public
setEventType(string $sEventType) : void
Parameters
- $sEventType : string
-
The event type to set.