Wildfire/Plugin/FirePhp/TableMessage.php

Show: PublicProtectedPrivateinherited
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 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
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

>VPropertyprotectedboolean $_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  
>VPropertyprotectedboolean $_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  
>VPropertyprotectedarray $_header = null
The header of the table containing all columns
Default valuenullDetails
Type
array
>VPropertyprotectedstring $_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  
>VPropertyprotectedmixed $_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  
>VPropertyprotectedarray $_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  
>VPropertyprotected$_rows = array()
The rows of the table $var array
Default valuearray()Details
Type
n/a
>VPropertyprotectedstring $_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  
>VPropertyprotectedstring $_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

methodpublic__construct(string $label) : void

Constructor

Parameters
NameTypeDescription
$labelstring

The label of the table

methodpublicaddRow(array $row) : void

Append a row to the end of the table.

Parameters
NameTypeDescription
$rowarray

An array of column values representing a row.

methodpublicgetBuffered() : boolean
inherited

Determine if buffering is enabled or disabled

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getBuffered()
Returns
TypeDescription
booleanReturns TRUE if buffering is enabled, FALSE otherwise.
methodpublicgetDestroy() : boolean
inherited

Determine if message should be destroyed

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getDestroy()
Returns
TypeDescription
booleanReturns TRUE if message should be destroyed, FALSE otherwise.
methodpublicgetLabel() : string
inherited

Get the label of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getLabel()
Returns
TypeDescription
stringThe label of the message
methodpublicgetLastRow() : array

Returns the last row of the table

Returns
TypeDescription
arrayReturns the last row
Throws
ExceptionDescription
\Zend_Wildfire_Exception
methodpublicgetMessage() : mixed

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

Returns
TypeDescription
mixedReturns the message to be sent.
methodpublicgetOption(string $key) : mixed
inherited

Retrieve a single option

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getOption()
Parameters
NameTypeDescription
$keystring

The name of the option

Returns
TypeDescription
mixedThe value of the option
methodpublicgetOptions() : array
inherited

Retrieve all options

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getOptions()
Returns
TypeDescription
arrayAll options
methodpublicgetRowAt(integer $index) : array

Returns the row at the given index

Parameters
NameTypeDescription
$indexinteger

The index of the row

Returns
TypeDescription
arrayReturns the row
Throws
ExceptionDescription
\Zend_Wildfire_Exception
methodpublicgetRowCount() : integer

Returns the number of rows

Returns
TypeDescription
integer
methodpublicgetStyle() : string
inherited

Get the style of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getStyle()
Returns
TypeDescription
stringThe style of the message
methodpublicsetBuffered(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
NameTypeDescription
$bufferedboolean

TRUE to enable buffering FALSE otherwise

Returns
TypeDescription
booleanReturns previous buffering value
methodpublicsetDestroy(boolean $destroy) : boolean
inherited

Destroy the message to prevent delivery

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setDestroy()
Parameters
NameTypeDescription
$destroyboolean

TRUE to destroy FALSE otherwise

Returns
TypeDescription
booleanReturns previous destroy value
methodpublicsetHeader(array $header) : void

Set the table header

Parameters
NameTypeDescription
$headerarray

The header columns

methodpublicsetLabel(string $label) : void
inherited

Set the label of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setLabel()
Parameters
NameTypeDescription
$labelstring

The label to be set

methodpublicsetMessage( $message) : void
inherited

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

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setMessage()
Parameters
NameTypeDescription
$message
methodpublicsetOption(string $key, mixed $value) : mixed
inherited

Set a single option

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setOption()
Parameters
NameTypeDescription
$keystring

The name of the option

$valuemixed

The value of the option

Returns
TypeDescription
mixedThe previous value of the option
methodpublicsetRowAt(integer $index, array $row) : void

Sets the row on the given index to a new row

Parameters
NameTypeDescription
$indexinteger

The index of the row

$rowarray

The new data for the row

Throws
ExceptionDescription
\Zend_Wildfire_Exception
methodpublicsetStyle( $style) : void
inherited

Set the style of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setStyle()
Parameters
NameTypeDescription
$style
Documentation was generated by phpDocumentor 2.0.0a12.