contenido\includes\include.mycontenido.tasks.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

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

Package: Default
Class ScrollableList Class for scrollable backend lists
Parent(s)
\cScrollList

Properties

>VPropertypublicarray $data = array()
inherited
Data container
Inherited from: \cScrollList::$$data
Default valuearray()Details
Type
array
Inherited_from
\cScrollList::$$data  
>VPropertypublicarray $header = array()
inherited
Header container
Inherited from: \cScrollList::$$header
Default valuearray()Details
Type
array
Inherited_from
\cScrollList::$$header  
>VPropertypublicstring $listStart
inherited
Start page
Inherited from: \cScrollList::$$listStart
Details
Type
string
Inherited_from
\cScrollList::$$listStart  
>VPropertypublic$objHeaderItem
inherited
Header item
Inherited from: \cScrollList::$$objHeaderItem
Details
Type
n/a
Inherited_from
\cScrollList::$$objHeaderItem  
>VPropertypublic$objHeaderRow
inherited
Header row
Inherited from: \cScrollList::$$objHeaderRow
Details
Type
n/a
Inherited_from
\cScrollList::$$objHeaderRow  
>VPropertypublic$objItem
inherited
Header item
Inherited from: \cScrollList::$$objItem
Details
Type
n/a
Inherited_from
\cScrollList::$$objItem  
>VPropertypublic$objRow
inherited
Header item
Inherited from: \cScrollList::$$objRow
Details
Type
n/a
Inherited_from
\cScrollList::$$objRow  
>VPropertypublic$objTable
inherited
Table item
Inherited from: \cScrollList::$$objTable
Details
Type
n/a
Inherited_from
\cScrollList::$$objTable  
>VPropertypublicstring $resultsPerPage
inherited
Number of records displayed per page
Inherited from: \cScrollList::$$resultsPerPage
Details
Type
string
Inherited_from
\cScrollList::$$resultsPerPage  
>VPropertypublicstring $sortable
inherited
sortable flag
Inherited from: \cScrollList::$$sortable
Details
Type
string
Inherited_from
\cScrollList::$$sortable  
>VPropertypublicstring $sortlink
inherited
sortlink
Inherited from: \cScrollList::$$sortlink
Details
Type
string
Inherited_from
\cScrollList::$$sortlink  
>VPropertypublic$statustypes
Details
Type
n/a

Methods

methodpublicTODOBackendList() : void

methodpubliccScrollList( $defaultstyle = true,  $action = "") : void
inherited

Creates a new FrontendList object.

Inherited from: \cScrollList::cScrollList()
Parameters
NameTypeDescription
$defaultstyle

boolean use the default style for object initializing?

$action
methodpublicconvert( $key,  $value,  $hidden) : void

Field converting facility.

Needs to be overridden in the child class to work properbly.

Parameters
NameTypeDescription
$key
$value

Field value

$hidden
methodpublicgetCurrentPage() : void
inherited

Returns the current page.

Inherited from: \cScrollList::getCurrentPage()
Details
Returns
Current page number  
methodpublicgetNumPages() : void
inherited

Returns the amount of pages.

Inherited from: \cScrollList::getNumPages()
Details
Returns
Amount of pages  
methodpubliconRenderColumn( $column) : void

Is called when a new column is rendered

Parameters
NameTypeDescription
$column
methodpubliconRenderRow( $row) : void
inherited

Is called when a new row is rendered

Inherited from: \cScrollList::onRenderRow()
Parameters
NameTypeDescription
$row

The current row which is being rendered

methodpublicrender( $return = true) : void
inherited

Outputs or optionally returns

Inherited from: \cScrollList::render()
Parameters
NameTypeDescription
$return

If true, returns the list

methodpublicsetCustom( $key,  $custom) : void
inherited

Sets the custom parameters for sortable links

Inherited from: \cScrollList::setCustom()

$obj->setCustom($key, $custom);

Parameters
NameTypeDescription
$key

Custom entry key

$custom

Custom entry value

methodpublicsetData( $index) : void
inherited

Sets data.

Inherited from: \cScrollList::setData()

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.

Parameters
NameTypeDescription
$index

Numeric index

methodpublicsetHeader() : void
inherited

Sets header data.

Inherited from: \cScrollList::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.

methodpublicsetHiddenData( $index) : void
inherited

Sets hidden data.

Inherited from: \cScrollList::setHiddenData()

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.

Parameters
NameTypeDescription
$index

Numeric index

methodpublicsetListStart( $startpage) : void
inherited

Sets the starting page number.

Inherited from: \cScrollList::setListStart()
Parameters
NameTypeDescription
$startpage

Page number on which the list display starts

methodpublicsetResultsPerPage( $numresults) : void
inherited

Sets the number of records per page.

Inherited from: \cScrollList::setResultsPerPage()
Parameters
NameTypeDescription
$numresults

Amount of records per page

methodpublicsetSortable( $key,  $sortable) : void
inherited

Sets the sortable flag for a specific row.

Inherited from: \cScrollList::setSortable()

$obj->setSortable(true);

Parameters
NameTypeDescription
$key
$sortable

boolean true or false

methodpublicsort( $field,  $order) : void
inherited

Sorts the list by a given field and a given order.

Inherited from: \cScrollList::sort()
Parameters
NameTypeDescription
$field

Field index

$order

Sort order (see php's sort documentation)

Documentation was generated by phpDocumentor 2.0.0a12.