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

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

 Methods

Constructor

__construct(string $label) 
inherited_from \Zend_Wildfire_Plugin_FirePhp_Message::__construct()

Parameters

$label

string

The label of the table

Creates a new message with the given style and message

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

Parameters

$style

string

Style of the message.

$message

mixed

The message

Append a row to the end of the table.

addRow(array $row) : void

Parameters

$row

array

An array of column values representing a row.

Determine if buffering is enabled or disabled

getBuffered() : boolean
Inherited

Returns

booleanReturns TRUE if buffering is enabled, FALSE otherwise.

Determine if message should be destroyed

getDestroy() : boolean
Inherited

Returns

booleanReturns TRUE if message should be destroyed, FALSE otherwise.

Get the label of the message

getLabel() : string
Inherited

Returns

stringThe label of the message

Returns the last row of the table

getLastRow() : array

Exceptions

\Zend_Wildfire_Exception

Returns

arrayReturns the last row

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

getMessage() : mixed
inherited_from \Zend_Wildfire_Plugin_FirePhp_Message::getMessage()

Returns

mixedReturns the message to be sent.

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

getMessage() : mixed
Inherited

Returns

mixedReturns the message to be sent.

Retrieve a single option

getOption(string $key) : mixed
Inherited

Parameters

$key

string

The name of the option

Returns

mixedThe value of the option

Retrieve all options

getOptions() : array
Inherited

Returns

arrayAll options

Returns the row at the given index

getRowAt(integer $index) : array

Parameters

$index

integer

The index of the row

Exceptions

\Zend_Wildfire_Exception

Returns

arrayReturns the row

Returns the number of rows

getRowCount() : integer

Returns

integer

Get the style of the message

getStyle() : string
Inherited

Returns

stringThe style of the message

Enable or disable message buffering

setBuffered(boolean $buffered) : boolean
Inherited

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
Inherited

Parameters

$destroy

boolean

TRUE to destroy FALSE otherwise

Returns

booleanReturns previous destroy value

Set the table header

setHeader(array $header) : void

Parameters

$header

array

The header columns

Set the label of the message

setLabel(string $label) : void
Inherited

Parameters

$label

string

The label to be set

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

setMessage($message) : void
Inherited

Parameters

$message

Set a single option

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

Parameters

$key

string

The name of the option

$value

mixed

The value of the option

Returns

mixedThe previous value of the option

Sets the row on the given index to a new row

setRowAt(integer $index, array $row) 

Parameters

$index

integer

The index of the row

$row

array

The new data for the row

Exceptions

\Zend_Wildfire_Exception

Set the style of the message

setStyle($style) : void
Inherited

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 header of the table containing all columns

$_header : array

Default

null
 

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)
 

The rows of the table $var array

$_rows 

Default

array()
 

Random unique ID used to identify message in comparison operations

$_ruid : string

Default

false
 

The style of the message

$_style : string

Default

null