contenido\includes\include.mycontenido.tasks.php
inherited
Classes
Description: MyContenido tasks overview
Requirements:
- Author
- unknown
- 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 unknown modified 2008-06-27, Frederic Schneider, add security fix $Id: include.mycontenido.tasks.php 504 2008-07-02 11:59:49Z timo.trautmann $: }}
- Version
- 1.0.1
\TODOBackendList
- Parent(s)
- \cScrollList
Properties
$statustypes- Type
- n/a
Methods
TODOBackendList() : voidcScrollList( $defaultstyle = true, $action = "") : void| Name | Type | Description |
|---|---|---|
| $defaultstyle | boolean use the default style for object initializing? | |
| $action |
convert( $key, $value, $hidden) : voidField converting facility.
Needs to be overridden in the child class to work properbly.
| Name | Type | Description |
|---|---|---|
| $key | ||
| $value | Field value | |
| $hidden |
getCurrentPage() : void- Returns
- Current page number
getNumPages() : void- Returns
- Amount of pages
onRenderColumn( $column) : voidIs called when a new column is rendered
| Name | Type | Description |
|---|---|---|
| $column |
onRenderRow( $row) : void| Name | Type | Description |
|---|---|---|
| $row | The current row which is being rendered |
render( $return = true) : void| Name | Type | Description |
|---|---|---|
| $return | If true, returns the list |
setCustom( $key, $custom) : void$obj->setCustom($key, $custom);
| Name | Type | Description |
|---|---|---|
| $key | Custom entry key | |
| $custom | Custom entry value |
setData( $index) : voidNote: 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.
| Name | Type | Description |
|---|---|---|
| $index | Numeric index |
setHeader() : voidNote: 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.
setHiddenData( $index) : voidNote: 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.
| Name | Type | Description |
|---|---|---|
| $index | Numeric index |
setListStart( $startpage) : void| Name | Type | Description |
|---|---|---|
| $startpage | Page number on which the list display starts |
setResultsPerPage( $numresults) : void| Name | Type | Description |
|---|---|---|
| $numresults | Amount of records per page |
setSortable( $key, $sortable) : void$obj->setSortable(true);
| Name | Type | Description |
|---|---|---|
| $key | ||
| $sortable | boolean true or false |
sort( $field, $order) : void| Name | Type | Description |
|---|---|---|
| $field | Field index | |
| $order | Sort order (see php's sort documentation) |