contenido\classes\class.ui.php
Description: Contenido UI Classes
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 classes
- Since
- file available since contenido release <= 4.6 {@internal created 2003-05-20 modified 2008-06-30, Dominik Ziegler, add security fix $Id: class.ui.php 710 2008-08-21 11:37:00Z timo.trautmann $: }}
- Version
- 1.5.2
\Link
Properties
Methods


setCLink( $targetarea, $targetframe, $targetaction) : void
Name | Type | Description |
---|---|---|
$targetarea | ||
$targetframe | ||
$targetaction |


setMultiLink( $righttoparea, $righttopaction, $rightbottomarea, $rightbottomaction) : void
Name | Type | Description |
---|---|---|
$righttoparea | ||
$righttopaction | ||
$rightbottomarea | ||
$rightbottomaction |
\UI_Form
Properties
Methods
\UI_Left_Top
Properties
Methods
\UI_List
Properties
Methods
\UI_Menu
\UI_Page
\UI_Table_Form
Properties
Methods


UI_Table_Form( $name, $action = "", $method = "post") : void
Name | Type | Description |
---|---|---|
$name | ||
$action | ||
$method |


add( $caption, $field, $rowname = "", $style = "") : void
Name | Type | Description |
---|---|---|
$caption | ||
$field | ||
$rowname | ||
$style |


setActionButton( $id, $image, $description = "", $accesskey = false, $action = false) : void
Name | Type | Description |
---|---|---|
$id | ||
$image | ||
$description | ||
$accesskey | ||
$action |
\cScrollList
- Children
- \TODOBackendList
Properties
Methods


cScrollList( $defaultstyle = true, $action = "") : void
Creates a new FrontendList object.
Name | Type | Description |
---|---|---|
$defaultstyle | boolean use the default style for object initializing? | |
$action |


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


onRenderColumn( $column) : void
Is called when a new column is rendered
Name | Type | Description |
---|---|---|
$column |


onRenderRow( $row) : void
Is called when a new row is rendered
Name | Type | Description |
---|---|---|
$row | The current row which is being rendered |


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


setCustom( $key, $custom) : void
Sets the custom parameters for sortable links
$obj->setCustom($key, $custom);
Name | Type | Description |
---|---|---|
$key | Custom entry key | |
$custom | Custom entry value |


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. Also make sure that your index starts from 0 and ends with the actual number - 1.
Name | Type | Description |
---|---|---|
$index | Numeric index |


setHeader() : void
Sets header data.
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.


setHiddenData( $index) : void
Sets hidden data.
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.
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 |


setSortable( $key, $sortable) : void
Sets the sortable flag for a specific row.
$obj->setSortable(true);
Name | Type | Description |
---|---|---|
$key | ||
$sortable | boolean true or false |