Documentation

Hermes_Table extends Horde_Core_Ui_Widget
in package

The Horde_UI_Table:: class displays and allows manipulation of tabular data.

Copyright 2001 Robert E. Coyle robertecoyle@hotmail.com

See the enclosed file LICENSE for license information (BSD). If you did not receive this file, see http://www.horde.org/licenses/bsdl.php.

Table of Contents

$_formVars  : array<string|int, mixed>
The form variables.
$_metaData  : array<string|int, mixed>
Data loaded from the getTableMetaData API.
getColumnCount()  : int
Count the number of columns in this table.
getMetaData()  : array<string|int, mixed>
Return the metadata for the table.
render()  : mixed
Render the table.
_getData()  : array<string|int, mixed>
Return the data for the table.

Properties

$_formVars

The form variables.

protected array<string|int, mixed> $_formVars = array()

$_metaData

Data loaded from the getTableMetaData API.

private array<string|int, mixed> $_metaData

Methods

getColumnCount()

Count the number of columns in this table.

public getColumnCount() : int

Returns the largest column count of any section, taking into account 'colspan' attributes.

Return values
int

The number of columns.

getMetaData()

Return the metadata for the table.

public getMetaData() : array<string|int, mixed>
Tags
throws
Hermes_Exception
Return values
array<string|int, mixed>

An array of the table metadata.

render()

Render the table.

public render([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

The data to render (unused).

Return values
mixed

The HTML needed to render the table or false if failed.

_getData()

Return the data for the table.

protected _getData([array<string|int, mixed> $range = null ]) : array<string|int, mixed>
Parameters
$range : array<string|int, mixed> = null

The range of data to return.

Return values
array<string|int, mixed>

The table data.

Search results