contenido\classes\class.ui.php

Show: PublicProtectedPrivateinherited
Table of Contents
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

>VPropertypublic$attributes
Details
Type
n/a
>VPropertypublic$caption
Details
Type
n/a
>VPropertypublic$content
Details
Type
n/a
>VPropertypublic$custom
Details
Type
n/a
>VPropertypublic$img_attr
Details
Type
n/a
>VPropertypublic$img_height
Details
Type
n/a
>VPropertypublic$img_type
Details
Type
n/a
>VPropertypublic$img_width
Details
Type
n/a
>VPropertypublic$javascripts
Details
Type
n/a
>VPropertypublic$link
Details
Type
n/a
>VPropertypublic$targetaction
Details
Type
n/a
>VPropertypublic$targetaction2
Details
Type
n/a
>VPropertypublic$targetarea
Details
Type
n/a
>VPropertypublic$targetarea2
Details
Type
n/a
>VPropertypublic$targetframe
Details
Type
n/a
>VPropertypublic$targetframe2
Details
Type
n/a
>VPropertypublic$title
Details
Type
n/a
>VPropertypublic$type
Details
Type
n/a

Methods

methodpublicrender() : void

methodpublicsetAlt( $alt) : void

Parameters
NameTypeDescription
$alt
methodpublicsetCLink( $targetarea,  $targetframe,  $targetaction) : void

Parameters
NameTypeDescription
$targetarea
$targetframe
$targetaction
methodpublicsetContent( $content) : void

Parameters
NameTypeDescription
$content
methodpublicsetCustom( $key,  $value) : void

Parameters
NameTypeDescription
$key
$value
methodpublicsetImage( $image) : void

Parameters
NameTypeDescription
$image
methodpublicsetJavascript( $js) : void

Parameters
NameTypeDescription
$js
methodpublicsetLink( $link) : void

Parameters
NameTypeDescription
$link
methodpublicsetMultiLink( $righttoparea,  $righttopaction,  $rightbottomarea,  $rightbottomaction) : void

Parameters
NameTypeDescription
$righttoparea
$righttopaction
$rightbottomarea
$rightbottomaction
methodpublicupdateAttributes( $attributes) : void

Parameters
NameTypeDescription
$attributes

\UI_Form

Package: Default

Properties

>VPropertypublic$content
Details
Type
n/a
>VPropertypublic$formaction
Details
Type
n/a
>VPropertypublic$formevent
Details
Type
n/a
>VPropertypublic$formmethod
Details
Type
n/a
>VPropertypublic$formname
Details
Type
n/a
>VPropertypublic$formtarget
Details
Type
n/a
>VPropertypublic$formvars
Details
Type
n/a
>VPropertypublic$header
Details
Type
n/a
>VPropertypublic$id
Details
Type
n/a
>VPropertypublic$items
Details
Type
n/a
>VPropertypublic$rownames
Details
Type
n/a
>VPropertypublic$tablebordercolor
Details
Type
n/a
>VPropertypublic$tableid
Details
Type
n/a

Methods

methodpublicUI_Form( $name,  $action = "",  $method = "post",  $target = "") : void

Parameters
NameTypeDescription
$name
$action
$method
$target
methodpublicadd( $field,  $content = "") : void

Parameters
NameTypeDescription
$field
$content
methodpublicrender( $return = true) : void

Parameters
NameTypeDescription
$return
methodpublicsetEvent( $event,  $jsCall) : void

Parameters
NameTypeDescription
$event
$jsCall
methodpublicsetVar( $name,  $value) : void

Parameters
NameTypeDescription
$name
$value

\UI_Left_Top

Package: Default

Properties

>VPropertypublic$javascripts
Details
Type
n/a
>VPropertypublic$link
Details
Type
n/a

Methods

methodpublicUI_Left_Top() : void

methodpublicrender() : void

methodpublicsetAdditionalContent( $content) : void

Parameters
NameTypeDescription
$content
methodpublicsetJS( $type,  $script) : void

Parameters
NameTypeDescription
$type
$script
methodpublicsetLink( $link) : void

Parameters
NameTypeDescription
$link

\UI_List

Package: Default

Properties

>VPropertypublic$actions
Details
Type
n/a
>VPropertypublic$alt
Details
Type
n/a
>VPropertypublic$bgcolor
Details
Type
n/a
>VPropertypublic$border
Details
Type
n/a
>VPropertypublic$caption
Details
Type
n/a
>VPropertypublic$extra
Details
Type
n/a
>VPropertypublic$image
Details
Type
n/a
>VPropertypublic$imagewidth
Details
Type
n/a
>VPropertypublic$javascripts
Details
Type
n/a
>VPropertypublic$link
Details
Type
n/a
>VPropertypublic$padding
Details
Type
n/a
>VPropertypublic$solid
Details
Type
n/a
>VPropertypublic$title
Details
Type
n/a
>VPropertypublic$type
Details
Type
n/a
>VPropertypublic$width
Details
Type
n/a

Methods

methodpublicUI_List() : void

methodpublicrender( $print = false) : void

Parameters
NameTypeDescription
$print
methodpublicsetBgColor( $item,  $color) : void

Parameters
NameTypeDescription
$item
$color
methodpublicsetBorder( $border) : void

Parameters
NameTypeDescription
$border
methodpublicsetCell( $item,  $cell,  $value) : void

Parameters
NameTypeDescription
$item
$cell
$value
methodpublicsetCellAlignment( $item,  $cell,  $alignment) : void

Parameters
NameTypeDescription
$item
$cell
$alignment
methodpublicsetCellExtra( $item,  $cell,  $extra) : void

Parameters
NameTypeDescription
$item
$cell
$extra
methodpublicsetCellVAlignment( $item,  $cell,  $alignment) : void

Parameters
NameTypeDescription
$item
$cell
$alignment
methodpublicsetExtra( $item,  $extra) : void

Parameters
NameTypeDescription
$item
$extra
methodpublicsetPadding( $padding) : void

Parameters
NameTypeDescription
$padding
methodpublicsetSolidBorder( $solid) : void

Parameters
NameTypeDescription
$solid
methodpublicsetWidth( $width) : void

Parameters
NameTypeDescription
$width

\UI_Menu

Package: Default

Properties

>VPropertypublic$actions
Details
Type
n/a
>VPropertypublic$alt
Details
Type
n/a
>VPropertypublic$bgColor
Details
Type
n/a
>VPropertypublic$border
Details
Type
n/a
>VPropertypublic$caption
Details
Type
n/a
>VPropertypublic$extra
Details
Type
n/a
>VPropertypublic$image
Details
Type
n/a
>VPropertypublic$imagewidth
Details
Type
n/a
>VPropertypublic$javascripts
Details
Type
n/a
>VPropertypublic$link
Details
Type
n/a
>VPropertypublic$padding
Details
Type
n/a
>VPropertypublic$show
Details
Type
n/a
>VPropertypublic$title
Details
Type
n/a
>VPropertypublic$type
Details
Type
n/a

Methods

methodpublicUI_Menu() : void

methodpublicrender( $print = true) : void

Parameters
NameTypeDescription
$print
methodpublicsetActions( $item,  $key,  $action) : void

Parameters
NameTypeDescription
$item
$key
$action
methodpublicsetBgColor( $item,  $bgColor) : void

Parameters
NameTypeDescription
$item
$bgColor
methodpublicsetBorder( $border) : void

Parameters
NameTypeDescription
$border
methodpublicsetExtra( $item,  $extra) : void

Parameters
NameTypeDescription
$item
$extra
methodpublicsetImage( $item,  $image,  $maxwidth = 0) : void

Parameters
NameTypeDescription
$item
$image
$maxwidth
methodpublicsetLink( $item,  $link) : void

Parameters
NameTypeDescription
$item
$link
methodpublicsetPadding( $padding) : void

Parameters
NameTypeDescription
$padding
methodpublicsetRowmark( $rowmark = true) : void

Parameters
NameTypeDescription
$rowmark
methodpublicsetTitle( $item,  $title) : void

Parameters
NameTypeDescription
$item
$title

\UI_Page

Package: Default

Properties

>VPropertypublic$content
Details
Type
n/a
>VPropertypublic$margin
Details
Type
n/a
>VPropertypublic$scripts
Details
Type
n/a

Methods

methodpublicUI_Page() : void

methodpublicaddScript( $name,  $script) : void

Parameters
NameTypeDescription
$name
$script
methodpublicrender( $print = true) : void

Parameters
NameTypeDescription
$print
methodpublicsetContent( $content) : void

Parameters
NameTypeDescription
$content
methodpublicsetMargin( $margin) : void

Parameters
NameTypeDescription
$margin
methodpublicsetMessageBox() : void

methodpublicsetReload() : void

\UI_Table_Form

Package: Default

Properties

>VPropertypublic$accesskey
Details
Type
n/a
>VPropertypublic$cancelLink
Details
Type
n/a
>VPropertypublic$captions
Details
Type
n/a
>VPropertypublic$formaction
Details
Type
n/a
>VPropertypublic$formmethod
Details
Type
n/a
>VPropertypublic$formname
Details
Type
n/a
>VPropertypublic$formvars
Details
Type
n/a
>VPropertypublic$header
Details
Type
n/a
>VPropertypublic$id
Details
Type
n/a
>VPropertypublic$itemType
Details
Type
n/a
>VPropertypublic$items
Details
Type
n/a
>VPropertypublic$rownames
Details
Type
n/a
>VPropertypublic$submitjs
Details
Type
n/a
>VPropertypublic$tablebordercolor
Details
Type
n/a
>VPropertypublic$tableid
Details
Type
n/a
>VPropertypublic$width
Details
Type
n/a

Methods

methodpublicUI_Table_Form( $name,  $action = "",  $method = "post") : void

Parameters
NameTypeDescription
$name
$action
$method
methodpublicadd( $caption,  $field,  $rowname = "",  $style = "") : void

Parameters
NameTypeDescription
$caption
$field
$rowname
$style
methodpublicaddCancel( $link) : void

Parameters
NameTypeDescription
$link
methodpublicaddHeader( $header) : void

Parameters
NameTypeDescription
$header
methodpublicaddSubHeader( $header) : void

Parameters
NameTypeDescription
$header
methodpublicrender( $return = true) : void

Parameters
NameTypeDescription
$return
methodpublicsetAccessKey( $key) : void

Parameters
NameTypeDescription
$key
methodpublicsetActionButton( $id,  $image,  $description = "",  $accesskey = false,  $action = false) : void

Parameters
NameTypeDescription
$id
$image
$description
$accesskey
$action
methodpublicsetActionEvent( $id,  $event) : void

Parameters
NameTypeDescription
$id
$event
methodpublicsetConfirm( $id,  $title,  $description) : void

Parameters
NameTypeDescription
$id
$title
$description
methodpublicsetSubmitJS( $js) : void

Parameters
NameTypeDescription
$js
methodpublicsetVar( $name,  $value) : void

Parameters
NameTypeDescription
$name
$value
methodpublicsetWidth( $width) : void

Parameters
NameTypeDescription
$width
methodpublicunsetActionButton( $id) : void

Parameters
NameTypeDescription
$id

\cScrollList

Package: Default
Class ScrollableList Class for scrollable backend lists
Children
\TODOBackendList

Properties

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

Methods

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

Creates a new FrontendList object.

Parameters
NameTypeDescription
$defaultstyle

boolean use the default style for object initializing?

$action
methodpublicconvert( $field,  $value,  $hiddendata) : void

Field converting facility.

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

Parameters
NameTypeDescription
$field

Field index

$value

Field value

$hiddendata
methodpublicgetCurrentPage() : void

Returns the current page.

Details
Returns
Current page number  
methodpublicgetNumPages() : void

Returns the amount of pages.

Details
Returns
Amount of pages  
methodpubliconRenderColumn( $column) : void

Is called when a new column is rendered

Parameters
NameTypeDescription
$column
methodpubliconRenderRow( $row) : void

Is called when a new row is rendered

Parameters
NameTypeDescription
$row

The current row which is being rendered

methodpublicrender( $return = true) : void

Outputs or optionally returns

Parameters
NameTypeDescription
$return

If true, returns the list

methodpublicsetCustom( $key,  $custom) : void

Sets the custom parameters for sortable links

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

Parameters
NameTypeDescription
$key

Custom entry key

$custom

Custom entry value

methodpublicsetData( $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.

Parameters
NameTypeDescription
$index

Numeric index

methodpublicsetHeader() : 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.

methodpublicsetHiddenData( $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.

Parameters
NameTypeDescription
$index

Numeric index

methodpublicsetListStart( $startpage) : void

Sets the starting page number.

Parameters
NameTypeDescription
$startpage

Page number on which the list display starts

methodpublicsetResultsPerPage( $numresults) : void

Sets the number of records per page.

Parameters
NameTypeDescription
$numresults

Amount of records per page

methodpublicsetSortable( $key,  $sortable) : void

Sets the sortable flag for a specific row.

$obj->setSortable(true);

Parameters
NameTypeDescription
$key
$sortable

boolean true or false

methodpublicsort( $field,  $order) : void

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

Parameters
NameTypeDescription
$field

Field index

$order

Sort order (see php's sort documentation)

Documentation was generated by phpDocumentor 2.0.0a12.