API Documentation

Wildfire/Plugin/FirePhp/TableMessage.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Wildfire  
subpackage
Plugin  
version
$Id: TableMessage.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Wildfire_Plugin_FirePhp_TableMessage

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

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

Properties

Propertyprotectedarray  $_header= 'null'

The header of the table containing all columns

Default valuenullDetails
Type
array
Propertyprotected  $_rows= 'array'

The rows of the table $var array

Default valuearrayDetails
Type

Methods

methodpublic__construct( string $label ) : void

Constructor

Parameters
Name Type Description
$label string The label of the table
methodpublicaddRow( 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.
methodpublicgetBuffered( ) : boolean

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.
methodpublicgetDestroy( ) : boolean

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.
methodpublicgetLabel( ) : string

Get the label of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getLabel()
Returns
Type Description
string The label of the message
methodpublicgetLastRow( ) : array

Returns the last row of the table

Returns
Type Description
array Returns the last row
Throws
Exception Description
\Zend_Wildfire_Exception
methodpublicgetMessage( ) : mixed

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

Returns
Type Description
mixed Returns the message to be sent.
methodpublicgetOption( string $key ) : mixed

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
methodpublicgetOptions( ) : array

Retrieve all options

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getOptions()
Returns
Type Description
array All options
methodpublicgetRowAt( 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
methodpublicgetRowCount( ) : integer

Returns the number of rows

Returns
Type Description
integer
methodpublicgetStyle( ) : string

Get the style of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::getStyle()
Returns
Type Description
string The style of the message
methodpublicsetBuffered( 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.

Parameters
Name Type Description
$buffered boolean TRUE to enable buffering FALSE otherwise
Returns
Type Description
boolean Returns previous buffering value
methodpublicsetDestroy( boolean $destroy ) : boolean

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
methodpublicsetHeader( array $header ) : void

Set the table header

Parameters
Name Type Description
$header array The header columns
methodpublicsetLabel( string $label ) : void

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
methodpublicsetMessage(  $message ) : void

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

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setMessage()
Parameters
Name Type Description
$message
methodpublicsetOption( string $key, mixed $value ) : mixed

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
methodpublicsetRowAt( 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
methodpublicsetStyle(  $style ) : void

Set the style of the message

Inherited from: \Zend_Wildfire_Plugin_FirePhp_Message::setStyle()
Parameters
Name Type Description
$style
Documentation was generated by DocBlox 0.13.3.