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 updated for the duration of the requet before it gets flushed at the end of the request.

array
$_header= 'null'
The header of the table containing all columns
null
Details
__construct(
string $label
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$label | string | The label of the table |

addRow(
array $row
)
:
void
Append a row to the end of the table.
Name | Type | Description |
---|---|---|
$row | array | An array of column values representing a row. |

getBuffered(
)
:
boolean
Determine if buffering is enabled or disabled
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getBuffered()Type | Description |
---|---|
boolean | Returns TRUE if buffering is enabled, FALSE otherwise. |

getDestroy(
)
:
boolean
Determine if message should be destroyed
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getDestroy()Type | Description |
---|---|
boolean | Returns TRUE if message should be destroyed, FALSE otherwise. |

getLabel(
)
:
string
Get the label of the message
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getLabel()Type | Description |
---|---|
string | The label of the message |

getLastRow(
)
:
array
Returns the last row of the table
Type | Description |
---|---|
array | Returns the last row |
Exception | Description |
---|---|
\Zend_Wildfire_Exception |

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
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getOption()Name | Type | Description |
---|---|---|
$key | string | The name of the option |
Type | Description |
---|---|
mixed | The value of the option |

getOptions(
)
:
array
Retrieve all options
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getOptions()Type | Description |
---|---|
array | All options |

getRowAt(
integer $index
)
:
array
Returns the row at the given index
Name | Type | Description |
---|---|---|
$index | integer | The index of the row |
Type | Description |
---|---|
array | Returns the row |
Exception | Description |
---|---|
\Zend_Wildfire_Exception |

getStyle(
)
:
string
Get the style of the message
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getStyle()Type | Description |
---|---|
string | The style of the message |

setBuffered(
boolean $buffered
)
:
boolean
Enable or disable message buffering
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setBuffered()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
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setDestroy()Name | Type | Description |
---|---|---|
$destroy | boolean | TRUE to destroy FALSE otherwise |
Type | Description |
---|---|
boolean | Returns previous destroy value |

setHeader(
array $header
)
:
void
Set the table header
Name | Type | Description |
---|---|---|
$header | array | The header columns |

setLabel(
string $label
)
:
void
Set the label of the message
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setLabel()Name | Type | Description |
---|---|---|
$label | string | The label to be set |

setMessage(
$message
)
:
void
Set the actual message to be sent in its final format.
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setMessage()Name | Type | Description |
---|---|---|
$message |

setOption(
string $key, mixed $value
)
:
mixed
Set a single option
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setOption()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 |

setRowAt(
integer $index, array $row
)
:
void
Sets the row on the given index to a new row
Name | Type | Description |
---|---|---|
$index | integer | The index of the row |
$row | array | The new data for the row |
Exception | Description |
---|---|
\Zend_Wildfire_Exception |

setStyle(
$style
)
:
void
Set the style of the message
Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setStyle()Name | Type | Description |
---|---|---|
$style |