Docs For Class Turba

Description

The Turba_ListView:: class provides an interface for objects that visualize Turba_lists.

$Horde: turba/lib/ListView.php,v 1.17.10.24 2009/10/26 17:34:16 jan Exp $

author: Chuck Hagenbuch <chuck@horde.org>
author: Jon Parise <jon@csh.rit.edu>

Located in /lib/ListView.php (line 12)

Variable Summary

array $columns

Horde_Form $form

Turba_List $list

Horde_UI_VarRenderer_html $renderer

boolean $showEdit

boolean $showGroup

boolean $showMark

boolean $showSort

boolean $showVcard

string $type

array $variables

Variables $vars

Method Summary

Turba_ListView Turba_ListView ( &$list, [array $controls = null], [array $columns = null], Turba_List $list)

integer count ()

void display ()

void getAddSources ()

string getAlpha ( &$numDisplayed, string $alpha, integer $numDisplayed)

string getColumnName (integer $i)

void getColumnSortDirection (integer $i)

void getColumnSortImage ( $i, [ $title = null])

string getPage ( &$numDisplayed, [integer $min = 0], [integer $max = null], integer $numDisplayed)

void getSortInfoForColumn (integer $i)

string getSortOrderDescription ()

void getType ()

boolean isPrimarySortColumn (integer $i)

boolean isSortColumn (integer $i)

void setControls (array $controls)

void setType ( $type)

void _get ( &$numDisplayed, $filter)

Variables

array $columns (line 96)

Which columns to render

Horde_Form $form = null (line 89)

A dummy form object.

Turba_List $list (line 19)

The Turba_List object that we are visualizing.

Horde_UI_VarRenderer_html $renderer (line 68)

The HTML renderer.

boolean $showEdit = false (line 33)

Show/hide "edit" column in the display.

boolean $showGroup = false (line 47)

Show/hide "group" column in the display.

boolean $showMark = false (line 26)

Show/hide "mark" column in the display.

boolean $showSort = false (line 54)

Show/hide "sort" column in the display.

boolean $showVcard = false (line 40)

Show/hide "vcard" column in the display.

string $type (line 61)

Type of list.

array $variables = array() (line 82)

A list of Horde_Form_Variable objects.

Variables $vars (line 75)

A Variables object.

Methods

Constructor Turba_ListView (line 105)

Constructs a new Turba_ListView object.

Turba_ListView Turba_ListView ( &$list, [array $controls = null], [array $columns = null], Turba_List $list)

Turba_List $list: List of contacts to display.
array $controls: Which icons to display
array $columns: The list of columns to display
&$list

count (line 155)

Returns the number of Turba_Objects that are in the list. Use this to hide internal implementation details from client objects.

return: The number of objects in the list.

integer count ()

display (line 160)

void display ()

getAddSources (line 411)

void getAddSources ()

getAlpha (line 286)

Renders the list contents that match $alpha into an HTML view.

return: HTML of the list.

string getAlpha ( &$numDisplayed, string $alpha, integer $numDisplayed)

integer $numDisplayed: This will be set to the number of contacts in the view.
string $alpha: The letter to display.
&$numDisplayed

getColumnName (line 298)

Retrieves a column's name

string getColumnName (integer $i)

integer $i: The zero-basd index of the column

getColumnSortDirection (line 354)

void getColumnSortDirection (integer $i)

integer $i: The zero-based index of the column

getColumnSortImage (line 320)

void getColumnSortImage ( $i, [ $title = null])

$i
$title

getPage (line 268)

Renders the list contents into an HTML view.

return: HTML to echo.

string getPage ( &$numDisplayed, [integer $min = 0], [integer $max = null], integer $numDisplayed)

integer $numDisplayed: Ouptut parameter - the number of rows rendered.
integer $min: Minimum number of rows to display.
integer $max: Maximum number of rows to display.
&$numDisplayed

getSortInfoForColumn (line 306)

void getSortInfoForColumn (integer $i)

integer $i: The zero-based index of the column

getSortOrderDescription (line 337)

Retrieves a natural language description of the sort order

string getSortOrderDescription ()

getType (line 144)

void getType ()

isPrimarySortColumn (line 379)

Determines whether this is the first column to sort by

boolean isPrimarySortColumn (integer $i)

integer $i: The zero-based column index

isSortColumn (line 369)

Determines whether we are sorting on the specified column

boolean isSortColumn (integer $i)

integer $i: The zero-based column index

setControls (line 131)

Set which controls are shown by the display templates.

void setControls (array $controls)

array $controls

setType (line 139)

void setType ( $type)

$type

_get (line 388)

void _get ( &$numDisplayed, $filter)

&$numDisplayed
$filter