FrontendList()
convert()
getCurrentPage()
getNumPages()
output()
setData()
setListStart()
setResultsPerPage()
sort()
$dark
$data
$endwrap
$itemwrap
$listStart
$pathdata
$resultsPerPage
$size
$startwrap
Class FrontendList Class for scrollable frontend lists
| author | Timo A. Hummel <Timo.Hummel@4fb.de> |
|---|---|
| version | 0.1 |
FrontendList(\$startwrap $startwrap, \$endwrap $endwrap, \$itemwrap $itemwrap)
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 %%.
| inherited_from | \FrontendList::FrontendList() |
|---|
\$startwrapWrap for the list start
\$endwrapWrap for the list end
\$itemwrapWrap for a single item
convert(\$field $field, $data)
Needs to be overridden in the child class to work properbly.
\$fieldField index
getCurrentPage()
| returns | Current page number |
|---|---|
| inherited_from | \FrontendList::getCurrentPage() |
getNumPages()
| returns | Amount of pages |
|---|---|
| inherited_from | \FrontendList::getNumPages() |
output(\$return $return)
| inherited_from | \FrontendList::output() |
|---|
\$returnIf true, returns the list
setData(\$index $index)
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.
| inherited_from | \FrontendList::setData() |
|---|
\$indexNumeric index
setListStart(\$startpage $startpage)
| inherited_from | \FrontendList::setListStart() |
|---|
\$startpagePage number on which the list display starts
setResultsPerPage(\$numresults $numresults)
| inherited_from | \FrontendList::setResultsPerPage() |
|---|
\$numresultsAmount of records per page
sort(\$field $field, \$order $order)
| inherited_from | \FrontendList::sort() |
|---|
\$fieldField index
\$orderSort order (see php's sort documentation)
$dark
$data : array
| inherited_from | \FrontendList::$$data |
|---|
$endwrap : string
| inherited_from | \FrontendList::$$endwrap |
|---|
$itemwrap : string
| inherited_from | \FrontendList::$$itemwrap |
|---|
$listStart : string
| inherited_from | \FrontendList::$$listStart |
|---|
$pathdata
$resultsPerPage : string
| inherited_from | \FrontendList::$$resultsPerPage |
|---|
$size
$startwrap : string
| inherited_from | \FrontendList::$$startwrap |
|---|