Detailed Description
AbstractControllerMessage is the base class for request/response implementations.
Definition at line 27 of file AbstractControllerMessage.php.
Inheritance diagram for AbstractControllerMessage:Public Member Functions | |
| __construct (Formatter $formatter) | |
| setSender ($sender) | |
| getSender () | |
| setContext ($context) | |
| getContext () | |
| setAction ($action) | |
| getAction () | |
| setFormat ($format) | |
| getFormat () | |
| setHeader ($name, $value) | |
| setHeaders (array $headers) | |
| getHeader ($name, $default=null) | |
| getHeaders () | |
| clearHeader ($name) | |
| clearHeaders () | |
| hasHeader ($name) | |
| setValue ($name, $value) | |
| setValues (array $values) | |
| getValue ($name, $default=null, $validateDesc=null, $suppressException=false) | |
| getBooleanValue ($name, $default=false) | |
| getValues () | |
| clearValue ($name) | |
| clearValues () | |
| hasValue ($name) | |
| setProperty ($name, $value) | |
| getProperty ($name) | |
| addError (ApplicationError $error) | |
| setErrors (array $errors) | |
| getErrors () | |
| clearErrors () | |
| hasErrors () | |
| __toString () | |
Protected Member Functions | |
| getFormatter () | |
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | Formatter | $formatter | ) |
Constructor.
- Parameters
-
$formatter
Reimplemented in DefaultRequest, and DefaultResponse.
Definition at line 78 of file AbstractControllerMessage.php.
Member Function Documentation
◆ setSender()
| setSender | ( | $sender | ) |
- See also
- ControllerMessage::setSender()
Implements ControllerMessage.
Definition at line 85 of file AbstractControllerMessage.php.
◆ getSender()
| getSender | ( | ) |
- See also
- ControllerMessage::getSender()
Implements ControllerMessage.
Definition at line 92 of file AbstractControllerMessage.php.
◆ setContext()
| setContext | ( | $context | ) |
- See also
- ControllerMessage::setContext()
Implements ControllerMessage.
Definition at line 99 of file AbstractControllerMessage.php.
◆ getContext()
| getContext | ( | ) |
- See also
- ControllerMessage::getContext()
Implements ControllerMessage.
Definition at line 106 of file AbstractControllerMessage.php.
◆ setAction()
| setAction | ( | $action | ) |
- See also
- ControllerMessage::setAction()
Implements ControllerMessage.
Definition at line 113 of file AbstractControllerMessage.php.
◆ getAction()
| getAction | ( | ) |
- See also
- ControllerMessage::getAction()
Implements ControllerMessage.
Definition at line 120 of file AbstractControllerMessage.php.
◆ setFormat()
| setFormat | ( | $format | ) |
- See also
- ControllerMessage::setFormat()
Implements ControllerMessage.
Definition at line 127 of file AbstractControllerMessage.php.
◆ getFormat()
| getFormat | ( | ) |
- See also
- ControllerMessage::getFormat()
Implements ControllerMessage.
Definition at line 134 of file AbstractControllerMessage.php.
◆ setHeader()
| setHeader | ( | $name, | |
| $value | |||
| ) |
- See also
- ControllerMessage::setHeader()
Implements ControllerMessage.
Definition at line 144 of file AbstractControllerMessage.php.
◆ setHeaders()
| setHeaders | ( | array | $headers | ) |
- See also
- ControllerMessage::setHeaders()
Implements ControllerMessage.
Definition at line 151 of file AbstractControllerMessage.php.
◆ getHeader()
| getHeader | ( | $name, | |
$default = null |
|||
| ) |
- See also
- ControllerMessage::getHeader()
Implements ControllerMessage.
Definition at line 158 of file AbstractControllerMessage.php.
◆ getHeaders()
| getHeaders | ( | ) |
- See also
- ControllerMessage::getHeaders()
Implements ControllerMessage.
Definition at line 170 of file AbstractControllerMessage.php.
◆ clearHeader()
| clearHeader | ( | $name | ) |
- See also
- ControllerMessage::clearHeader()
Implements ControllerMessage.
Definition at line 177 of file AbstractControllerMessage.php.
◆ clearHeaders()
| clearHeaders | ( | ) |
Implements ControllerMessage.
Definition at line 184 of file AbstractControllerMessage.php.
◆ hasHeader()
| hasHeader | ( | $name | ) |
- See also
- ControllerMessage::hasHeader()
Implements ControllerMessage.
Definition at line 191 of file AbstractControllerMessage.php.
◆ setValue()
| setValue | ( | $name, | |
| $value | |||
| ) |
- See also
- ControllerMessage::setValue()
Implements ControllerMessage.
Definition at line 198 of file AbstractControllerMessage.php.
◆ setValues()
| setValues | ( | array | $values | ) |
- See also
- ControllerMessage::setValues()
Implements ControllerMessage.
Definition at line 205 of file AbstractControllerMessage.php.
◆ getValue()
| getValue | ( | $name, | |
$default = null, |
|||
$validateDesc = null, |
|||
$suppressException = false |
|||
| ) |
- See also
- ControllerMessage::getValue()
Implements ControllerMessage.
Definition at line 212 of file AbstractControllerMessage.php.
◆ getBooleanValue()
| getBooleanValue | ( | $name, | |
$default = false |
|||
| ) |
Implements ControllerMessage.
Definition at line 231 of file AbstractControllerMessage.php.
◆ getValues()
| getValues | ( | ) |
- See also
- ControllerMessage::getValues()
Implements ControllerMessage.
Definition at line 243 of file AbstractControllerMessage.php.
◆ clearValue()
| clearValue | ( | $name | ) |
- See also
- ControllerMessage::clearValue()
Implements ControllerMessage.
Definition at line 250 of file AbstractControllerMessage.php.
◆ clearValues()
| clearValues | ( | ) |
- See also
- ControllerMessage::clearValues()
Implements ControllerMessage.
Definition at line 257 of file AbstractControllerMessage.php.
◆ hasValue()
| hasValue | ( | $name | ) |
- See also
- ControllerMessage::hasValue()
Implements ControllerMessage.
Definition at line 264 of file AbstractControllerMessage.php.
◆ setProperty()
| setProperty | ( | $name, | |
| $value | |||
| ) |
- See also
- ControllerMessage::setProperty()
Implements ControllerMessage.
Definition at line 271 of file AbstractControllerMessage.php.
◆ getProperty()
| getProperty | ( | $name | ) |
- See also
- ControllerMessage::getProperty()
Implements ControllerMessage.
Definition at line 278 of file AbstractControllerMessage.php.
◆ addError()
| addError | ( | ApplicationError | $error | ) |
- See also
- ControllerMessage::addError()
Implements ControllerMessage.
Definition at line 288 of file AbstractControllerMessage.php.
◆ setErrors()
| setErrors | ( | array | $errors | ) |
- See also
- ControllerMessage::setErrors()
Implements ControllerMessage.
Definition at line 295 of file AbstractControllerMessage.php.
◆ getErrors()
| getErrors | ( | ) |
- See also
- ControllerMessage::getErrors()
Implements ControllerMessage.
Definition at line 302 of file AbstractControllerMessage.php.
◆ clearErrors()
| clearErrors | ( | ) |
- See also
- ControllerMessage::clearErrors()
Implements ControllerMessage.
Definition at line 309 of file AbstractControllerMessage.php.
◆ hasErrors()
| hasErrors | ( | ) |
- See also
- ControllerMessage::hasErrors()
Implements ControllerMessage.
Definition at line 316 of file AbstractControllerMessage.php.
◆ getFormatter()
|
protected |
Get the Formatter instance.
- Returns
- Formatter
Definition at line 324 of file AbstractControllerMessage.php.
◆ __toString()
| __toString | ( | ) |
Get a string representation of the message.
- Returns
- The string
Reimplemented in DefaultRequest.
Definition at line 332 of file AbstractControllerMessage.php.