Wildfire/Plugin/FirePhp/TableMessage.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Wildfire
- Subpackage
- Plugin
- Version
- $Id: TableMessage.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Wildfire_Plugin_FirePhp_TableMessage
- Parent(s)
- \Zend_Wildfire_Plugin_FirePhp_Message
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


boolean $_buffered = false
false
Details- Type
- boolean
- Inherited_from
- \Zend_Wildfire_Plugin_FirePhp_Message::$$_buffered


boolean $_destroy = false
false
Details- Type
- boolean
- Inherited_from
- \Zend_Wildfire_Plugin_FirePhp_Message::$$_destroy


array $_header = null
null
Details- Type
- array


string $_label = null
null
Details- Type
- string
- Inherited_from
- \Zend_Wildfire_Plugin_FirePhp_Message::$$_label


mixed $_message = null
null
Details- Type
- mixed
- Inherited_from
- \Zend_Wildfire_Plugin_FirePhp_Message::$$_message


array $_options = array('traceOffset' => null, 'includeLineNumbers' => null)
array('traceOffset' => null, 'includeLineNumbers' => null)
Details- Type
- array
- Inherited_from
- \Zend_Wildfire_Plugin_FirePhp_Message::$$_options


string $_ruid = false
false
Details- Type
- string
- Inherited_from
- \Zend_Wildfire_Plugin_FirePhp_Message::$$_ruid


string $_style = null
null
Details- Type
- string
- Inherited_from
- \Zend_Wildfire_Plugin_FirePhp_Message::$$_style
Methods


__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
Name | Type | Description |
---|---|---|
$key | string | The name of the option |
Type | Description |
---|---|
mixed | The value of the option |


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
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 |