Docs For Class Zend_Wildfire_Plugin_FirePhp

Description

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

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Wildfire/Plugin/FirePhp/Message.php (line 34)

Direct descendents

Class	Description
Zend_Wildfire_Plugin_FirePhp_TableMessage	A message envelope that can be updated for the duration of the requet before it gets flushed at the end of the request.

Variable Summary

boolean $_buffered

boolean $_destroy

string $_label

mixed $_message

array $_options

string $_ruid

string $_style

Method Summary

void __construct (string $style, mixed $message)

boolean getBuffered ()

boolean getDestroy ()

string getLabel ()

mixed getMessage ()

mixed getOption (string $key)

array getOptions ()

string getStyle ()

boolean setBuffered (boolean $buffered)

boolean setDestroy (boolean $destroy)

void setLabel (string $label)

void setMessage ( $message)

mixed setOption (string $key, mixed $value)

void setStyle ( $style)

Variables

boolean $_buffered = false (line 58)

Flag indicating if message buffering is enabled

access: protected

boolean $_destroy = false (line 64)

Flag indicating if message should be destroyed and not delivered

access: protected

string $_label = null (line 46)

The label of the message

access: protected

mixed $_message = null (line 52)

The message value

access: protected

array $_options = array(
'traceOffset' => null, /* The offset in the trace which identifies the source of the message */
'includeLineNumbers' => null /* Whether to include line and file info for this message */
) (line 76)

Options for the object

access: protected

string $_ruid = false (line 70)

Random unique ID used to identify message in comparison operations

access: protected

string $_style = null (line 40)

The style of the message

access: protected

Methods

Constructor __construct (line 88)

Creates a new message with the given style and message

void __construct (string $style, mixed $message)

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

Redefined in descendants as:

Zend_Wildfire_Plugin_FirePhp_TableMessage::__construct() : Constructor

getBuffered (line 137)

Determine if buffering is enabled or disabled

return: Returns TRUE if buffering is enabled, FALSE otherwise.
access: public

boolean getBuffered ()

getDestroy (line 160)

Determine if message should be destroyed

return: Returns TRUE if message should be destroyed, FALSE otherwise.
access: public

boolean getDestroy ()

getLabel (line 111)

Get the label of the message

return: The label of the message
access: public

string getLabel ()

getMessage (line 200)

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

return: Returns the message to be sent.
access: public

mixed getMessage ()

Redefined in descendants as:

Zend_Wildfire_Plugin_FirePhp_TableMessage::getMessage() : Get the actual message to be sent in its final format.

getOption (line 228)

Retrieve a single option

return: The value of the option
access: public

mixed getOption (string $key)

string $key: The name of the option

getOptions (line 241)

Retrieve all options

return: All options
access: public

array getOptions ()

getStyle (line 180)

Get the style of the message

return: The style of the message
access: public

string getStyle ()

setBuffered (line 125)

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.

return: Returns previous buffering value
access: public

boolean setBuffered (boolean $buffered)

boolean $buffered: TRUE to enable buffering FALSE otherwise

setDestroy (line 148)

Destroy the message to prevent delivery

return: Returns previous destroy value
access: public

boolean setDestroy (boolean $destroy)

boolean $destroy: TRUE to destroy FALSE otherwise

setLabel (line 101)

Set the label of the message

access: public

void setLabel (string $label)

string $label: The label to be set

setMessage (line 190)

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

access: public

void setMessage ( $message)

$message

setOption (line 212)

Set a single option

return: The previous value of the option
access: public

mixed setOption (string $key, mixed $value)

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

setStyle (line 170)

Set the style of the message

access: public

void setStyle ( $style)

$style

Zend_Wildfire_Plugin_FirePhp_Message