Wildfire/Plugin/FirePhp/Message.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Wildfire
- Subpackage
- Plugin
- Version
- $Id: Message.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Wildfire_Plugin_FirePhp_Message
- Children
- \Zend_Wildfire_Plugin_FirePhp_TableMessage
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


boolean $_buffered = false
false
Details- Type
- boolean


boolean $_destroy = false
false
Details- Type
- boolean


array $_options = array('traceOffset' => null, 'includeLineNumbers' => null)
array('traceOffset' => null, 'includeLineNumbers' => null)
Details- Type
- array


string $_ruid = false
false
Details- Type
- string
Methods


__construct(string $style, mixed $message) : void
Creates a new message with the given style and message
Name | Type | Description |
---|---|---|
$style | string | Style of the message. |
$message | mixed | The message |


getBuffered() : boolean
Determine if buffering is enabled or disabled
Type | Description |
---|---|
boolean | Returns TRUE if buffering is enabled, FALSE otherwise. |


getDestroy() : boolean
Determine if message should be destroyed
Type | Description |
---|---|
boolean | Returns TRUE if message should be destroyed, FALSE otherwise. |


getMessage() : mixed
Get the actual message to be sent in its final format.
Type | Description |
---|---|
mixed | Returns the message to be sent. |


getOption(string $key) : mixed
Retrieve a single option
Name | Type | Description |
---|---|---|
$key | string | The name of the option |
Type | Description |
---|---|
mixed | The value of the option |


setBuffered(boolean $buffered) : boolean
Enable or disable message buffering
If a message is buffered it can be updated for the duration of the request and is only flushed at the end of the request.
Name | Type | Description |
---|---|---|
$buffered | boolean | TRUE to enable buffering FALSE otherwise |
Type | Description |
---|---|
boolean | Returns previous buffering value |


setDestroy(boolean $destroy) : boolean
Destroy the message to prevent delivery
Name | Type | Description |
---|---|---|
$destroy | boolean | TRUE to destroy FALSE otherwise |
Type | Description |
---|---|
boolean | Returns previous destroy value |


setLabel(string $label) : void
Set the label of the message
Name | Type | Description |
---|---|---|
$label | string | The label to be set |


setMessage( $message) : void
Set the actual message to be sent in its final format.
Name | Type | Description |
---|---|---|
$message |


setOption(string $key, mixed $value) : mixed
Set a single option
Name | Type | Description |
---|---|---|
$key | string | The name of the option |
$value | mixed | The value of the option |
Type | Description |
---|---|
mixed | The previous value of the option |