Zend Framework
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.
A message envelope that can be passed to Zend_Wildfire_Plugin_FirePhp to be logged to Firebug instead of a variable.

boolean
$_buffered= 'false'
Flag indicating if message buffering is enabled
false
Details
boolean
$_destroy= 'false'
Flag indicating if message should be destroyed and not delivered
false
Details
array
$_options= 'array(
'traceOffset' => null'
Options for the object
array(
'traceOffset' => null
Details
string
$_ruid= 'false'
Random unique ID used to identify message in comparison operations
false
Details
__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. |

getLabel(
)
:
string
Get the label of the message
Type | Description |
---|---|
string | The label of the message |

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 |

getStyle(
)
:
string
Get the style of the message
Type | Description |
---|---|
string | The style of the message |

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 |