contenido\classes\class.ui.php
Classes
Project:
Contenido Content Management System
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
Package: Default
Properties
$attributesDetails
- Type
- n/a
$captionDetails
- Type
- n/a
$contentDetails
- Type
- n/a
$customDetails
- Type
- n/a
$img_attrDetails
- Type
- n/a
$img_heightDetails
- Type
- n/a
$img_typeDetails
- Type
- n/a
$img_widthDetails
- Type
- n/a
$javascriptsDetails
- Type
- n/a
$linkDetails
- Type
- n/a
$targetactionDetails
- Type
- n/a
$targetaction2Details
- Type
- n/a
$targetareaDetails
- Type
- n/a
$targetarea2Details
- Type
- n/a
$targetframeDetails
- Type
- n/a
$targetframe2Details
- Type
- n/a
$titleDetails
- Type
- n/a
$typeDetails
- Type
- n/a
Methods
render() : voidsetAlt( $alt) : voidParameters
| Name | Type | Description |
|---|---|---|
| $alt |
setCLink( $targetarea, $targetframe, $targetaction) : voidParameters
| Name | Type | Description |
|---|---|---|
| $targetarea | ||
| $targetframe | ||
| $targetaction |
setContent( $content) : voidParameters
| Name | Type | Description |
|---|---|---|
| $content |
setCustom( $key, $value) : voidParameters
| Name | Type | Description |
|---|---|---|
| $key | ||
| $value |
setImage( $image) : voidParameters
| Name | Type | Description |
|---|---|---|
| $image |
setJavascript( $js) : voidParameters
| Name | Type | Description |
|---|---|---|
| $js |
setLink( $link) : voidParameters
| Name | Type | Description |
|---|---|---|
| $link |
setMultiLink( $righttoparea, $righttopaction, $rightbottomarea, $rightbottomaction) : voidParameters
| Name | Type | Description |
|---|---|---|
| $righttoparea | ||
| $righttopaction | ||
| $rightbottomarea | ||
| $rightbottomaction |
updateAttributes( $attributes) : voidParameters
| Name | Type | Description |
|---|---|---|
| $attributes |
\UI_Form
Package: Default
Properties
$contentDetails
- Type
- n/a
$formactionDetails
- Type
- n/a
$formeventDetails
- Type
- n/a
$formmethodDetails
- Type
- n/a
$formnameDetails
- Type
- n/a
$formtargetDetails
- Type
- n/a
$formvarsDetails
- Type
- n/a
$headerDetails
- Type
- n/a
$idDetails
- Type
- n/a
$itemsDetails
- Type
- n/a
$rownamesDetails
- Type
- n/a
$tablebordercolorDetails
- Type
- n/a
$tableidDetails
- Type
- n/a
Methods
UI_Form( $name, $action = "", $method = "post", $target = "") : voidParameters
| Name | Type | Description |
|---|---|---|
| $name | ||
| $action | ||
| $method | ||
| $target |
add( $field, $content = "") : voidParameters
| Name | Type | Description |
|---|---|---|
| $field | ||
| $content |
render( $return = true) : voidParameters
| Name | Type | Description |
|---|---|---|
| $return |
setEvent( $event, $jsCall) : voidParameters
| Name | Type | Description |
|---|---|---|
| $event | ||
| $jsCall |
setVar( $name, $value) : voidParameters
| Name | Type | Description |
|---|---|---|
| $name | ||
| $value |
\UI_Left_Top
Package: Default
Properties
Methods
\UI_List
Package: Default
Properties
$actionsDetails
- Type
- n/a
$altDetails
- Type
- n/a
$bgcolorDetails
- Type
- n/a
$borderDetails
- Type
- n/a
$captionDetails
- Type
- n/a
$extraDetails
- Type
- n/a
$imageDetails
- Type
- n/a
$imagewidthDetails
- Type
- n/a
$javascriptsDetails
- Type
- n/a
$linkDetails
- Type
- n/a
$paddingDetails
- Type
- n/a
$solidDetails
- Type
- n/a
$titleDetails
- Type
- n/a
$typeDetails
- Type
- n/a
$widthDetails
- Type
- n/a
Methods
UI_List() : voidrender( $print = false) : voidParameters
| Name | Type | Description |
|---|---|---|
setBgColor( $item, $color) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $color |
setBorder( $border) : voidParameters
| Name | Type | Description |
|---|---|---|
| $border |
setCell( $item, $cell, $value) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $cell | ||
| $value |
setCellAlignment( $item, $cell, $alignment) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $cell | ||
| $alignment |
setCellExtra( $item, $cell, $extra) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $cell | ||
| $extra |
setCellVAlignment( $item, $cell, $alignment) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $cell | ||
| $alignment |
setExtra( $item, $extra) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $extra |
setPadding( $padding) : voidParameters
| Name | Type | Description |
|---|---|---|
| $padding |
setSolidBorder( $solid) : voidParameters
| Name | Type | Description |
|---|---|---|
| $solid |
setWidth( $width) : voidParameters
| Name | Type | Description |
|---|---|---|
| $width |
\UI_Menu
Package: Default
Properties
$actionsDetails
- Type
- n/a
$altDetails
- Type
- n/a
$bgColorDetails
- Type
- n/a
$borderDetails
- Type
- n/a
$captionDetails
- Type
- n/a
$extraDetails
- Type
- n/a
$imageDetails
- Type
- n/a
$imagewidthDetails
- Type
- n/a
$javascriptsDetails
- Type
- n/a
$linkDetails
- Type
- n/a
$paddingDetails
- Type
- n/a
$showDetails
- Type
- n/a
$titleDetails
- Type
- n/a
$typeDetails
- Type
- n/a
Methods
UI_Menu() : voidrender( $print = true) : voidParameters
| Name | Type | Description |
|---|---|---|
setActions( $item, $key, $action) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $key | ||
| $action |
setBgColor( $item, $bgColor) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $bgColor |
setBorder( $border) : voidParameters
| Name | Type | Description |
|---|---|---|
| $border |
setExtra( $item, $extra) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $extra |
setImage( $item, $image, $maxwidth = 0) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $image | ||
| $maxwidth |
setLink( $item, $link) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $link |
setPadding( $padding) : voidParameters
| Name | Type | Description |
|---|---|---|
| $padding |
setRowmark( $rowmark = true) : voidParameters
| Name | Type | Description |
|---|---|---|
| $rowmark |
setTitle( $item, $title) : voidParameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $title |
\UI_Page
Package: Default
Properties
Methods
UI_Page() : voidaddScript( $name, $script) : voidParameters
| Name | Type | Description |
|---|---|---|
| $name | ||
| $script |
render( $print = true) : voidParameters
| Name | Type | Description |
|---|---|---|
setContent( $content) : voidParameters
| Name | Type | Description |
|---|---|---|
| $content |
setMargin( $margin) : voidParameters
| Name | Type | Description |
|---|---|---|
| $margin |
setMessageBox() : voidsetReload() : void\UI_Table_Form
Package: Default
Properties
$accesskeyDetails
- Type
- n/a
$cancelLinkDetails
- Type
- n/a
$captionsDetails
- Type
- n/a
$formactionDetails
- Type
- n/a
$formmethodDetails
- Type
- n/a
$formnameDetails
- Type
- n/a
$formvarsDetails
- Type
- n/a
$headerDetails
- Type
- n/a
$idDetails
- Type
- n/a
$itemTypeDetails
- Type
- n/a
$itemsDetails
- Type
- n/a
$rownamesDetails
- Type
- n/a
$submitjsDetails
- Type
- n/a
$tablebordercolorDetails
- Type
- n/a
$tableidDetails
- Type
- n/a
$widthDetails
- Type
- n/a
Methods
UI_Table_Form( $name, $action = "", $method = "post") : voidParameters
| Name | Type | Description |
|---|---|---|
| $name | ||
| $action | ||
| $method |
add( $caption, $field, $rowname = "", $style = "") : voidParameters
| Name | Type | Description |
|---|---|---|
| $caption | ||
| $field | ||
| $rowname | ||
| $style |
addCancel( $link) : voidParameters
| Name | Type | Description |
|---|---|---|
| $link |
addHeader( $header) : voidParameters
| Name | Type | Description |
|---|---|---|
| $header |
addSubHeader( $header) : voidParameters
| Name | Type | Description |
|---|---|---|
| $header |
render( $return = true) : voidParameters
| Name | Type | Description |
|---|---|---|
| $return |
setAccessKey( $key) : voidParameters
| Name | Type | Description |
|---|---|---|
| $key |
setActionButton( $id, $image, $description = "", $accesskey = false, $action = false) : voidParameters
| Name | Type | Description |
|---|---|---|
| $id | ||
| $image | ||
| $description | ||
| $accesskey | ||
| $action |
setActionEvent( $id, $event) : voidParameters
| Name | Type | Description |
|---|---|---|
| $id | ||
| $event |
setConfirm( $id, $title, $description) : voidParameters
| Name | Type | Description |
|---|---|---|
| $id | ||
| $title | ||
| $description |
setSubmitJS( $js) : voidParameters
| Name | Type | Description |
|---|---|---|
| $js |
setVar( $name, $value) : voidParameters
| Name | Type | Description |
|---|---|---|
| $name | ||
| $value |
setWidth( $width) : voidParameters
| Name | Type | Description |
|---|---|---|
| $width |
unsetActionButton( $id) : voidParameters
| Name | Type | Description |
|---|---|---|
| $id |
\cScrollList
Package: DefaultParameters
Parameters
Parameters
Parameters
Parameters
Class ScrollableList
Class for scrollable backend lists
- Children
- \TODOBackendList
Properties
array $data = array()Data container
Default value
array()Details- Type
- array
array $header = array()Header container
Default value
array()Details- Type
- array
string $listStartStart page
Details
- Type
- string
$objHeaderItemHeader item
Details
- Type
- n/a
$objHeaderRowHeader row
Details
- Type
- n/a
$objItemHeader item
Details
- Type
- n/a
$objRowHeader item
Details
- Type
- n/a
$objTableTable item
Details
- Type
- n/a
string $resultsPerPageNumber of records displayed per page
Details
- Type
- string
string $sortablesortable flag
Details
- Type
- string
string $sortlinksortlink
Details
- Type
- string
Methods
cScrollList( $defaultstyle = true, $action = "") : voidCreates a new FrontendList object.
Parameters
| Name | Type | Description |
|---|---|---|
| $defaultstyle | boolean use the default style for object initializing? | |
| $action |
convert( $field, $value, $hiddendata) : voidField converting facility.
Needs to be overridden in the child class to work properbly.
| Name | Type | Description |
|---|---|---|
| $field | Field index | |
| $value | Field value | |
| $hiddendata |
getCurrentPage() : voidReturns the current page.
Details
- Returns
- Current page number
getNumPages() : voidReturns the amount of pages.
Details
- Returns
- Amount of pages
onRenderColumn( $column) : voidIs called when a new column is rendered
Parameters
| Name | Type | Description |
|---|---|---|
| $column |
onRenderRow( $row) : voidIs called when a new row is rendered
Parameters
| Name | Type | Description |
|---|---|---|
| $row | The current row which is being rendered |
render( $return = true) : voidOutputs or optionally returns
Parameters
| Name | Type | Description |
|---|---|---|
| $return | If true, returns the list |
setCustom( $key, $custom) : voidSets the custom parameters for sortable links
$obj->setCustom($key, $custom);
| Name | Type | Description |
|---|---|---|
| $key | Custom entry key | |
| $custom | Custom entry value |
setData( $index) : voidSets 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() : voidSets 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) : voidSets 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) : voidSets the starting page number.
Parameters
| Name | Type | Description |
|---|---|---|
| $startpage | Page number on which the list display starts |
setResultsPerPage( $numresults) : voidSets the number of records per page.
Parameters
| Name | Type | Description |
|---|---|---|
| $numresults | Amount of records per page |
setSortable( $key, $sortable) : voidSets the sortable flag for a specific row.
$obj->setSortable(true);
| Name | Type | Description |
|---|---|---|
| $key | ||
| $sortable | boolean true or false |
sort( $field, $order) : voidSorts the list by a given field and a given order.
Parameters
| Name | Type | Description |
|---|---|---|
| $field | Field index | |
| $order | Sort order (see php's sort documentation) |