A message envelope that can be passed to Zend_Wildfire_Plugin_FirePhp to be logged to Firebug instead of a variable.

category Zend
package Zend_Wildfire
subpackage Plugin
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Creates a new message with the given style and message

__construct(string $style, mixed $message) : void

Parameters

$style

string

Style of the message.

$message

mixed

The message

Determine if buffering is enabled or disabled

getBuffered() : boolean

Returns

booleanReturns TRUE if buffering is enabled, FALSE otherwise.

Determine if message should be destroyed

getDestroy() : boolean

Returns

booleanReturns TRUE if message should be destroyed, FALSE otherwise.

Get the label of the message

getLabel() : string

Returns

stringThe label of the message

Get the actual message to be sent in its final format.

getMessage() : mixed

Returns

mixedReturns the message to be sent.

Retrieve a single option

getOption(string $key) : mixed

Parameters

$key

string

The name of the option

Returns

mixedThe value of the option

Retrieve all options

getOptions() : array

Returns

arrayAll options

Get the style of the message

getStyle() : string

Returns

stringThe style of the message

Enable or disable message buffering

setBuffered(boolean $buffered) : boolean

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.

Parameters

$buffered

boolean

TRUE to enable buffering FALSE otherwise

Returns

booleanReturns previous buffering value

Destroy the message to prevent delivery

setDestroy(boolean $destroy) : boolean

Parameters

$destroy

boolean

TRUE to destroy FALSE otherwise

Returns

booleanReturns previous destroy value

Set the label of the message

setLabel(string $label) : void

Parameters

$label

string

The label to be set

Set the actual message to be sent in its final format.

setMessage($message) : void

Parameters

$message

Set a single option

setOption(string $key, mixed $value) : mixed

Parameters

$key

string

The name of the option

$value

mixed

The value of the option

Returns

mixedThe previous value of the option

Set the style of the message

setStyle($style) : void

Parameters

$style

 Properties

 

Flag indicating if message buffering is enabled

$_buffered : boolean

Default

false
 

Flag indicating if message should be destroyed and not delivered

$_destroy : boolean

Default

false
 

The label of the message

$_label : string

Default

null
 

The message value

$_message : mixed

Default

null
 

Options for the object

$_options : array

Default

array('traceOffset' => null, 'includeLineNumbers' => null)
 

Random unique ID used to identify message in comparison operations

$_ruid : string

Default

false
 

The style of the message

$_style : string

Default

null