CSProcessedMessage
in package
Tags
Table of Contents
- acknowledge() : void
- Acknowledges the message and forwards this information to the current message proxy.
- create() : CSProcessedMessage
- Creates a processed message based on the provided message object and message proxy.
- decline() : void
- Declines the message and forwards this information to the current message proxy.
- fail() : void
- Fails the message and forwards this information to the current message proxy.
- getArguments() : array<string|int, mixed>
- Returns the message arguments.
- getName() : string
- Returns the name of the message.
- logMessage() : void
- Logs a message and forwards it to the current message proxy.
Methods
acknowledge()
Acknowledges the message and forwards this information to the current message proxy.
public
acknowledge() : void
Tags
Return values
void —create()
Creates a processed message based on the provided message object and message proxy.
public
static create(Message $oMessage, IMessageProxy $oMessageProxy) : CSProcessedMessage
Parameters
- $oMessage : Message
-
The database message object.
- $oMessageProxy : IMessageProxy
-
The message proxy that will receive updates about message status.
Tags
Return values
CSProcessedMessage —The processed message object
decline()
Declines the message and forwards this information to the current message proxy.
public
decline() : void
Tags
Return values
void —fail()
Fails the message and forwards this information to the current message proxy.
public
fail() : void
Tags
Return values
void —getArguments()
Returns the message arguments.
public
getArguments() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —The arguments of the message.
getName()
Returns the name of the message.
public
getName() : string
Tags
Return values
string —The message name.
logMessage()
Logs a message and forwards it to the current message proxy.
public
logMessage(mixed $sMessage[, mixed $iType = CSMessageConst::LOG_TYPE_INFO ]) : void
Parameters
- $sMessage : mixed
- $iType : mixed = CSMessageConst::LOG_TYPE_INFO