Class Turba_View_List

The Turba_View_List:: class provides an interface for objects that visualize Turba_List objects.

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

Turba_View_List implements Countable

Package: Turba
Category: Horde
License: ASL
Author: Chuck Hagenbuch chuck@horde.org
Author: Jon Parise jon@csh.rit.edu
Located at View/List.php

Methods summary
`public Turba_View_List`	# `__construct( Turba_List $list, array $controls = null, array $columns = null )` Constructs a new Turba_View_List object. Constructs a new Turba_View_List object. Parameters `$list` List of contacts to display. `$controls` Which icons to display `$columns` The list of columns to display Returns `Turba_View_List`
`public`	# `setControls( array $controls )` Set which controls are shown by the display templates. Set which controls are shown by the display templates. Parameters `$controls`
`public`	# `setType( string $type )` Parameters `$type`
`public string`	# `getType( )` Returns `string`
`public`	# `display( )` Todo: these should be injected when we refactor to Horde_View
`public string`	# `getPage( integer & $numDisplayed, integer $min = 0, integer $max = null )` Renders the list contents into an HTML view. Renders the list contents into an HTML view. Parameters `$numDisplayed` <p>Ouptut parameter - the number of rows rendered.</p> `$min` Minimum number of rows to display. `$max` Maximum number of rows to display. Returns `string` HTML to echo.
`public string`	# `getAlpha( integer & $numDisplayed, string $alpha )` Renders the list contents that match $alpha into an HTML view. Renders the list contents that match $alpha into an HTML view. Parameters `$numDisplayed` <p>This will be set to the number of contacts in the view.</p> `$alpha` The letter to display. Returns `string` HTML of the list.
`public string`	# `getColumnName( integer $i )` Retrieves a column's name Retrieves a column's name Parameters `$i` The zero-basd index of the column Returns `string`
`public`	# `getSortInfoForColumn( integer $i )` Parameters `$i` The zero-based index of the column
`public string`	# `getColumnSortImage( integer $i, string $title = null )` Parameters `$i` `$title` Returns `string`
`public string`	# `getSortOrderDescription( )` Retrieves a natural language description of the sort order Retrieves a natural language description of the sort order Returns `string`
`public`	# `getColumnSortDirection( integer $i )` Parameters `$i` The zero-based index of the column
`public boolean`	# `isSortColumn( integer $i )` Determines whether we are sorting on the specified column Determines whether we are sorting on the specified column Parameters `$i` The zero-based column index Returns `boolean`
`public boolean`	# `isPrimarySortColumn( integer $i )` Determines whether this is the first column to sort by Determines whether this is the first column to sort by Parameters `$i` The zero-based column index Returns `boolean`
`public`	# `getAddSources( )`
`public integer`	# `count( )` Returns the number of Turba_Objects that are in the list. Use this to hide internal implementation details from client objects. Returns the number of Turba_Objects that are in the list. Use this to hide internal implementation details from client objects. Returns `integer` The number of objects in the list. Implementation of `Countable::count()`

Properties summary
`public Turba_List`	`$list` The Turba_List object that we are visualizing. The Turba_List object that we are visualizing.	#
`public boolean`	`$showMark` Show/hide "mark" column in the display. Show/hide "mark" column in the display.	# `false`
`public boolean`	`$showEdit` Show/hide "edit" column in the display. Show/hide "edit" column in the display.	# `false`
`public boolean`	`$showVcard` Show/hide "vcard" column in the display. Show/hide "vcard" column in the display.	# `false`
`public boolean`	`$showGroup` Show/hide "group" column in the display. Show/hide "group" column in the display.	# `false`
`public boolean`	`$showSort` Show/hide "sort" column in the display. Show/hide "sort" column in the display.	# `false`
`public string`	`$type` Type of list. Type of list.	#
`public Horde_Core_Ui_VarRenderer_Html`	`$renderer` The HTML renderer. The HTML renderer.	#
`public Horde_Variables`	`$vars` A Horde_Variables object. A Horde_Variables object.	#
`public array`	`$variables` A list of Horde_Form_Variable objects. A list of Horde_Form_Variable objects.	# `array()`
`public Horde_Form`	`$form` A dummy form object. A dummy form object.	# `null`
`public array`	`$columns` Which columns to render Which columns to render	#

Packages

Classes

Class Turba_View_List

Parameters

Returns

Parameters

Parameters

Returns

Todo:

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Implementation of