Zend_Wildfire_Plugin_FirePhp_Message Class Reference

Public Member Functions
	__construct ($style, $message)
	Creates a new message with the given style and message.
	setLabel ($label)
	Set the label of the message.
	getLabel ()
	Get the label of the message.
	setBuffered ($buffered)
	Enable or disable message buffering.
	getBuffered ()
	Determine if buffering is enabled or disabled.
	setDestroy ($destroy)
	Destroy the message to prevent delivery.
	getDestroy ()
	Determine if message should be destroyed.
	setStyle ($style)
	Set the style of the message.
	getStyle ()
	Get the style of the message.
	setMessage ($message)
	Set the actual message to be sent in its final format.
	getMessage ()
	Get the actual message to be sent in its final format.
	setOption ($key, $value)
	Set a single option.
	getOption ($key)
	Retrieve a single option.
	getOptions ()
	Retrieve all options.

Protected Attributes
	$_style = null
	$_label = null
	$_message = null
	$_buffered = false
	$_destroy = false
	$_ruid = false
	$_options

Constructor & Destructor Documentation

__construct	(		$style,
			$message
	)

Creates a new message with the given style and message.

Parameters

string	$style	Style of the message.
mixed	$message	The message

Returns

void

Member Function Documentation

getBuffered

(

)

Determine if buffering is enabled or disabled.

Returns

boolean Returns TRUE if buffering is enabled, FALSE otherwise.

getDestroy

(

)

Determine if message should be destroyed.

Returns

boolean Returns TRUE if message should be destroyed, FALSE otherwise.

getLabel

(

)

Get the label of the message.

Returns

string The label of the message

getMessage

(

)

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

Returns

mixed Returns the message to be sent.

getOption

(

$key

)

Retrieve a single option.

Parameters

string

$key

The name of the option

Returns

mixed The value of the option

getOptions

(

)

Retrieve all options.

Returns

array All options

getStyle

(

)

Get the style of the message.

Returns

string The style of the message

setBuffered

(

$buffered

)

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.

Parameters

boolean

$buffered

TRUE to enable buffering FALSE otherwise

Returns

boolean Returns previous buffering value

setDestroy

(

$destroy

)

Destroy the message to prevent delivery.

Parameters

boolean

$destroy

TRUE to destroy FALSE otherwise

Returns

boolean Returns previous destroy value

setLabel

(

$label

)

Set the label of the message.

Parameters

string

$label

The label to be set

Returns

void

setMessage

(

$message

)

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

Returns

void

setOption	(		$key,
			$value
	)

Set a single option.

Parameters

string	$key	The name of the option
mixed	$value	The value of the option

Returns

mixed The previous value of the option

setStyle

(

$style

)

Set the style of the message.

Returns

void

Member Data Documentation

$_buffered = false

protected

$_destroy = false

protected

$_label = null

protected

$_message = null

protected

$_options

protected

Initial value:

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

$_ruid = false

protected

$_style = null

protected