Class FrontendList

Class FrontendList for scrollable frontend lists.

Direct known subclasses

Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Timo Hummel
Located at includes/api/functions.frontend.list.php

Methods summary
`public`	# `FrontendList( string $startwrap, string $endwrap, string $itemwrap )` Creates a new FrontendList object. Creates a new FrontendList object. The placeholder for item wraps are the same as for sprintf. See the documentation for sprintf. Caution: Make sure that percentage signs are written as %%. Parameters `$startwrap` `string` $startwrap Wrap for the list start `$endwrap` `string` $endwrap Wrap for the list end `$itemwrap` `string` $itemwrap Wrap for a single item
`public`	# `setData( integer $index )` Sets data. Sets data. Note: This function eats as many parameters as you specify. Example: $obj->setData(0, "foo", "bar"); Make sure that the amount of parameters stays the same for all setData calls in a single object. Parameters `$index` `integer` $index Numeric index SuppressWarnings docBlocks
`public`	# `setResultsPerPage( integer $resultsPerPage )` Sets the number of records per page. Sets the number of records per page. Parameters `$resultsPerPage` `integer` $resultsPerPage Amount of records per page
`public`	# `setListStart( integer $listStart )` Sets the starting page number. Sets the starting page number. Parameters `$listStart` `integer` $listStart Page number on which the list display starts
`public integer`	# `getCurrentPage( )` Returns the current page. Returns the current page. Returns `integer` Current page number
`public integer`	# `getNumPages( )` Returns the amount of pages. Returns the amount of pages. Returns `integer` Amount of pages
`public`	# `sort( string $field, integer $order )` Sorts the list by a given field and a given order. Sorts the list by a given field and a given order. Parameters `$field` `string` $field name of field to sort for `$order` `integer` $order Sort order (see php's sort documentation) one of SORT_ASC, SORT_DESC, SORT_REGULAR, SORT_NUMERIC, SORT_STRING
`public mixed`	# `convert( integer $field, mixed $value )` Field converting facility. Needs to be overridden in the child class to work properbly. Field converting facility. Needs to be overridden in the child class to work properbly. Parameters `$field` `integer` $field Field index `$value` `mixed` $value Field value Returns `mixed`
`public string`	# `output( boolean $return = false )` Outputs or optionally returns Outputs or optionally returns Parameters `$return` `boolean` $return if true, returns the list Returns `string`

Properties summary
`public string`	`$itemwrap`		# Wrap for a single item. Wrap for a single item.
`public string`	`$startwrap`		# Wrap for table start. Wrap for table start.
`public string`	`$endwrap`		# Wrap for table end. Wrap for table end.
`public array`	`$data`	`Array()`	# Data container. Data container.
`public integer`	`$resultsPerPage`		# Number of records displayed per page. Number of records displayed per page.
`public integer`	`$listStart`		# Start page. Start page.

Packages

Classes

Functions

Class FrontendList

Direct known subclasses

Parameters

Parameters

SuppressWarnings

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns