Detailed Description
AbstractControllerMessage is the base class for request/response implementations.
Definition at line 24 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, $filter=null, $options=null) | |
| 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 | ( | Formatter | $formatter | ) |
Member Function Documentation
| setSender | ( | $sender | ) |
- See also
- ControllerMessage::setSender()
Implements ControllerMessage.
Definition at line 82 of file AbstractControllerMessage.php.
| getSender | ( | ) |
- See also
- ControllerMessage::getSender()
Implements ControllerMessage.
Definition at line 89 of file AbstractControllerMessage.php.
| setContext | ( | $context | ) |
- See also
- ControllerMessage::setContext()
Implements ControllerMessage.
Definition at line 96 of file AbstractControllerMessage.php.
| getContext | ( | ) |
- See also
- ControllerMessage::getContext()
Implements ControllerMessage.
Definition at line 103 of file AbstractControllerMessage.php.
| setAction | ( | $action | ) |
- See also
- ControllerMessage::setAction()
Implements ControllerMessage.
Definition at line 110 of file AbstractControllerMessage.php.
| getAction | ( | ) |
- See also
- ControllerMessage::getAction()
Implements ControllerMessage.
Definition at line 117 of file AbstractControllerMessage.php.
| setFormat | ( | $format | ) |
- See also
- ControllerMessage::setFormat()
Implements ControllerMessage.
Definition at line 124 of file AbstractControllerMessage.php.
| getFormat | ( | ) |
- See also
- ControllerMessage::getFormat()
Implements ControllerMessage.
Definition at line 131 of file AbstractControllerMessage.php.
| setHeader | ( | $name, | |
| $value | |||
| ) |
- See also
- ControllerMessage::setHeader()
Implements ControllerMessage.
Definition at line 141 of file AbstractControllerMessage.php.
| setHeaders | ( | array | $headers | ) |
- See also
- ControllerMessage::setHeaders()
Implements ControllerMessage.
Definition at line 148 of file AbstractControllerMessage.php.
| getHeader | ( | $name, | |
$default = null |
|||
| ) |
- See also
- ControllerMessage::getHeader()
Implements ControllerMessage.
Definition at line 155 of file AbstractControllerMessage.php.
| getHeaders | ( | ) |
- See also
- ControllerMessage::getHeaders()
Implements ControllerMessage.
Definition at line 167 of file AbstractControllerMessage.php.
| clearHeader | ( | $name | ) |
- See also
- ControllerMessage::clearHeader()
Implements ControllerMessage.
Definition at line 174 of file AbstractControllerMessage.php.
| clearHeaders | ( | ) |
Implements ControllerMessage.
Definition at line 181 of file AbstractControllerMessage.php.
| hasHeader | ( | $name | ) |
- See also
- ControllerMessage::hasHeader()
Implements ControllerMessage.
Definition at line 188 of file AbstractControllerMessage.php.
| setValue | ( | $name, | |
| $value | |||
| ) |
- See also
- ControllerMessage::setValue()
Implements ControllerMessage.
Definition at line 195 of file AbstractControllerMessage.php.
| setValues | ( | array | $values | ) |
- See also
- ControllerMessage::setValues()
Implements ControllerMessage.
Definition at line 202 of file AbstractControllerMessage.php.
| getValue | ( | $name, | |
$default = null, |
|||
$filter = null, |
|||
$options = null |
|||
| ) |
- See also
- ControllerMessage::getValue()
Implements ControllerMessage.
Definition at line 209 of file AbstractControllerMessage.php.
| getBooleanValue | ( | $name, | |
$default = false |
|||
| ) |
Implements ControllerMessage.
Definition at line 222 of file AbstractControllerMessage.php.
| getValues | ( | ) |
- See also
- ControllerMessage::getValues()
Implements ControllerMessage.
Definition at line 234 of file AbstractControllerMessage.php.
| clearValue | ( | $name | ) |
- See also
- ControllerMessage::clearValue()
Implements ControllerMessage.
Definition at line 241 of file AbstractControllerMessage.php.
| clearValues | ( | ) |
- See also
- ControllerMessage::clearValues()
Implements ControllerMessage.
Definition at line 248 of file AbstractControllerMessage.php.
| hasValue | ( | $name | ) |
- See also
- ControllerMessage::hasValue()
Implements ControllerMessage.
Definition at line 255 of file AbstractControllerMessage.php.
| setProperty | ( | $name, | |
| $value | |||
| ) |
- See also
- ControllerMessage::setProperty()
Implements ControllerMessage.
Definition at line 262 of file AbstractControllerMessage.php.
| getProperty | ( | $name | ) |
- See also
- ControllerMessage::getProperty()
Implements ControllerMessage.
Definition at line 269 of file AbstractControllerMessage.php.
| addError | ( | ApplicationError | $error | ) |
- See also
- ControllerMessage::addError()
Implements ControllerMessage.
Definition at line 279 of file AbstractControllerMessage.php.
| setErrors | ( | array | $errors | ) |
- See also
- ControllerMessage::setErrors()
Implements ControllerMessage.
Definition at line 286 of file AbstractControllerMessage.php.
| getErrors | ( | ) |
- See also
- ControllerMessage::getErrors()
Implements ControllerMessage.
Definition at line 293 of file AbstractControllerMessage.php.
| clearErrors | ( | ) |
- See also
- ControllerMessage::clearErrors()
Implements ControllerMessage.
Definition at line 300 of file AbstractControllerMessage.php.
| hasErrors | ( | ) |
- See also
- ControllerMessage::hasErrors()
Implements ControllerMessage.
Definition at line 307 of file AbstractControllerMessage.php.
|
protected |
Get the Formatter instance.
- Returns
- Formatter
Definition at line 315 of file AbstractControllerMessage.php.
| __toString | ( | ) |
Get a string representation of the message.
- Returns
- The string
Definition at line 323 of file AbstractControllerMessage.php.