Wildfire/Plugin/FirePhp/TableMessage.php

Show:

inherited

Classes
- \Zend_Wildfire_Plugin_FirePhp_TableMessage

Table of Contents

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 [email protected] 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
jump to top

Package: Zend\Wildfire\Plugin

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

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

inherited

Flag indicating if message buffering is enabled

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_buffered

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_buffered

boolean $_destroy = false

inherited

Flag indicating if message should be destroyed and not delivered

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_destroy

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_destroy

array $_header = null

The header of the table containing all columns

Default valuenullDetails

Type: array

string $_label = null

inherited

The label of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_label

Default valuenullDetails

Type: string
Inherited_from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_label

mixed $_message = null

inherited

The message value

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_message

Default valuenullDetails

Type: mixed
Inherited_from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_message

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

inherited

Options for the object

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_options

Default valuearray('traceOffset' => null, 'includeLineNumbers' => null)Details

Type: array
Inherited_from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_options

$_rows = array()

The rows of the table $var array

Default valuearray()Details

Type: n/a

string $_ruid = false

inherited

Random unique ID used to identify message in comparison operations

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_ruid

Default valuefalseDetails

Type: string
Inherited_from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_ruid

string $_style = null

inherited

The style of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_style

Default valuenullDetails

Type: string
Inherited_from: \Zend_Wildfire_Plugin_FirePhp_Message::$$_style

Methods

__construct(string $label) : void

Constructor

Parameters

Name	Type	Description
$label	string	The label of the table

addRow(array $row) : void

Append a row to the end of the table.

Parameters

Name	Type	Description
$row	array	An array of column values representing a row.

getBuffered() : boolean

inherited

Determine if buffering is enabled or disabled

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getBuffered()

Returns

Type	Description
boolean	Returns TRUE if buffering is enabled, FALSE otherwise.

getDestroy() : boolean

inherited

Determine if message should be destroyed

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getDestroy()

Returns

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

getLabel() : string

inherited

Get the label of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getLabel()

Returns

Type	Description
string	The label of the message

getLastRow() : array

Returns the last row of the table

Returns

Type	Description
array	Returns the last row

Throws

Exception	Description
\Zend_Wildfire_Exception

getMessage() : mixed

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

Returns

Type	Description
mixed	Returns the message to be sent.

getOption(string $key) : mixed

inherited

Retrieve a single option

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getOption()

Parameters

Name	Type	Description
$key	string	The name of the option

Returns

Type	Description
mixed	The value of the option

getOptions() : array

inherited

Retrieve all options

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getOptions()

Returns

Type	Description
array	All options

getRowAt(integer $index) : array

Returns the row at the given index

Parameters

Name	Type	Description
$index	integer	The index of the row

Returns

Type	Description
array	Returns the row

Throws

Exception	Description
\Zend_Wildfire_Exception

getRowCount() : integer

Returns the number of rows

Returns

Type	Description
integer

getStyle() : string

inherited

Get the style of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getStyle()

Returns

Type	Description
string	The style of the message

setBuffered(boolean $buffered) : boolean

inherited

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.

Parameters

Name	Type	Description
$buffered	boolean	TRUE to enable buffering FALSE otherwise

Returns

Type	Description
boolean	Returns previous buffering value

setDestroy(boolean $destroy) : boolean

inherited

Destroy the message to prevent delivery

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setDestroy()

Parameters

Name	Type	Description
$destroy	boolean	TRUE to destroy FALSE otherwise

Returns

Type	Description
boolean	Returns previous destroy value

setHeader(array $header) : void

Set the table header

Parameters

Name	Type	Description
$header	array	The header columns

setLabel(string $label) : void

inherited

Set the label of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setLabel()

Parameters

Name	Type	Description
$label	string	The label to be set

setMessage( $message) : void

inherited

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

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setMessage()

Parameters

Name	Type	Description
$message

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

inherited

Set a single option

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setOption()

Parameters

Name	Type	Description
$key	string	The name of the option
$value	mixed	The value of the option

Returns

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

Parameters

Name	Type	Description
$index	integer	The index of the row
$row	array	The new data for the row

Throws

Exception	Description
\Zend_Wildfire_Exception

setStyle( $style) : void

inherited

Set the style of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setStyle()

Parameters

Name	Type	Description
$style

Wildfire/Plugin/FirePhp/TableMessage.php

\Zend_Wildfire_Plugin_FirePhp_TableMessagejump to top

Properties

Methods

\Zend_Wildfire_Plugin_FirePhp_TableMessage
jump to top