contenido\includes\api\functions.frontend.list.php
Description: Contenido Frontend list
Requirements:
- Author
- Timo A. Hummel
- Con_php_req
- 5.0
- Copyright
- four for business AG
- License
- http://www.contenido.org/license/LIZENZ.txt
- Link
- http://www.4fb.de
- Link
- http://www.contenido.org
- Package
- Contenido Backend includes
- Since
- file available since contenido release <= 4.6 {@internal created 2003-10-09 modified 2008-06-25, Frederic Schneider, add security fix $Id: functions.frontend.list.php 309 2008-06-26 10:06:56Z frederic.schneider $: }}
- Version
- 1.0.0
\FrontendList
- Children
- \UploadList
- \UploadList
- Author
- Timo A. Hummel
- Version
- 0.1
Properties
Methods


FrontendList( $startwrap, $endwrap, $itemwrap) : void
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 %%.
Name | Type | Description |
---|---|---|
$startwrap | Wrap for the list start | |
$endwrap | Wrap for the list end | |
$itemwrap | Wrap for a single item |


convert( $field, $value) : void
Field converting facility.
Needs to be overridden in the child class to work properbly.
Name | Type | Description |
---|---|---|
$field | Field index | |
$value | Field value |


output( $return = false) : void
Outputs or optionally returns
Name | Type | Description |
---|---|---|
$return | If true, returns the list |


setData( $index) : void
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.
Name | Type | Description |
---|---|---|
$index | Numeric index |


setListStart( $startpage) : void
Sets the starting page number.
Name | Type | Description |
---|---|---|
$startpage | Page number on which the list display starts |


setResultsPerPage( $numresults) : void
Sets the number of records per page.
Name | Type | Description |
---|---|---|
$numresults | Amount of records per page |