TODOBackendList()
cScrollList()
convert()
getCurrentPage()
getNumPages()
onRenderColumn()
onRenderRow()
render()
setCustom()
setData()
setHeader()
setHiddenData()
setListStart()
setResultsPerPage()
setSortable()
sort()
$data
$header
$listStart
$objHeaderItem
$objHeaderRow
$objItem
$objRow
$objTable
$resultsPerPage
$sortable
$sortlink
$statustypes
Class ScrollableList Class for scrollable backend lists
TODOBackendList()
cScrollList(\$defaultstyle $defaultstyle, $action)
| inherited_from | \cScrollList::cScrollList() |
|---|
\$defaultstyleboolean use the default style for object initializing?
convert($key, \$value $value, $hidden)
Needs to be overridden in the child class to work properbly.
\$valueField value
getCurrentPage()
| returns | Current page number |
|---|---|
| inherited_from | \cScrollList::getCurrentPage() |
getNumPages()
| returns | Amount of pages |
|---|---|
| inherited_from | \cScrollList::getNumPages() |
onRenderColumn(\$row $column)
\$rowThe current column which is being rendered
onRenderRow(\$row $row)
| inherited_from | \cScrollList::onRenderRow() |
|---|
\$rowThe current row which is being rendered
render(\$return $return)
| inherited_from | \cScrollList::render() |
|---|
\$returnIf true, returns the list
setCustom(\$key $key, \$custom $custom)
$obj->setCustom($key, $custom);
| inherited_from | \cScrollList::setCustom() |
|---|
\$keyCustom entry key
\$customCustom entry value
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. Also make sure that your index starts from 0 and ends with the actual number - 1.
| inherited_from | \cScrollList::setData() |
|---|
\$indexNumeric index
setHeader()
Note: This function eats as many parameters as you specify.
Example: $obj->setHeader("foo", "bar");
Make sure that the amount of parameters stays the same for all setData calls in a single object.
| inherited_from | \cScrollList::setHeader() |
|---|
setHiddenData(\$index $index)
Note: This function eats as many parameters as you specify.
Example: $obj->setHiddenData(0, "foo", "bar");
Make sure that the amount of parameters stays the same for all setData calls in a single object. Also make sure that your index starts from 0 and ends with the actual number - 1.
| inherited_from | \cScrollList::setHiddenData() |
|---|
\$indexNumeric index
setListStart(\$startpage $startpage)
| inherited_from | \cScrollList::setListStart() |
|---|
\$startpagePage number on which the list display starts
setResultsPerPage(\$numresults $numresults)
| inherited_from | \cScrollList::setResultsPerPage() |
|---|
\$numresultsAmount of records per page
setSortable(\$sortable $key, $sortable)
$obj->setSortable(true);
| inherited_from | \cScrollList::setSortable() |
|---|
\$sortableboolean true or false
sort(\$field $field, \$order $order)
| inherited_from | \cScrollList::sort() |
|---|
\$fieldField index
\$orderSort order (see php's sort documentation)
$data : array
| inherited_from | \cScrollList::$$data |
|---|
$header : array
| inherited_from | \cScrollList::$$header |
|---|
$listStart : string
| inherited_from | \cScrollList::$$listStart |
|---|
$objHeaderItem
| inherited_from | \cScrollList::$$objHeaderItem |
|---|
$objHeaderRow
| inherited_from | \cScrollList::$$objHeaderRow |
|---|
$objItem
| inherited_from | \cScrollList::$$objItem |
|---|
$objRow
| inherited_from | \cScrollList::$$objRow |
|---|
$objTable
| inherited_from | \cScrollList::$$objTable |
|---|
$resultsPerPage : string
| inherited_from | \cScrollList::$$resultsPerPage |
|---|
$sortable : string
| inherited_from | \cScrollList::$$sortable |
|---|
$sortlink : string
| inherited_from | \cScrollList::$$sortlink |
|---|
$statustypes