cms\includes\class.input.helper.php

Show: PublicProtectedPrivateinherited
Table of Contents

\UI_Config_Table

Package: Default

Properties

>VPropertypublic$_aCellAlignment
Details
Type
n/a
>VPropertypublic$_aCellClass
Details
Type
n/a
>VPropertypublic$_aCellColSpan
Details
Type
n/a
>VPropertypublic$_aCellVAlignment
Details
Type
n/a
>VPropertypublic$_aCells
Details
Type
n/a
>VPropertypublic$_aRowBgColor
Details
Type
n/a
>VPropertypublic$_aRowExtra
Details
Type
n/a
>VPropertypublic$_bAddMultiSelJS
Details
Type
n/a
>VPropertypublic$_bSolidBorder
Details
Type
n/a
>VPropertypublic$_sBorder
Details
Type
n/a
>VPropertypublic$_sBorderColor
Details
Type
n/a
>VPropertypublic$_sColorDark
Details
Type
n/a
>VPropertypublic$_sColorLight
Details
Type
n/a
>VPropertypublic$_sPadding
Details
Type
n/a
>VPropertypublic$_sTplCellCode
Details
Type
n/a
>VPropertypublic$_sTplTableFile
Details
Type
n/a
>VPropertypublic$_sWidth
Details
Type
n/a

Methods

methodpublicUI_Config_Table() : void

methodpublic_addMultiSelJS() : void

methodpublicrender( $bPrint = false) : void

Parameters
NameTypeDescription
$bPrint
methodpublicsetAddMultiSelJS( $bEnabled = true) : void

Parameters
NameTypeDescription
$bEnabled
methodpublicsetBorder( $sBorder) : void

Parameters
NameTypeDescription
$sBorder
methodpublicsetBorderColor( $sBorderColor) : void

Parameters
NameTypeDescription
$sBorderColor
methodpublicsetCell( $sRow,  $sCell,  $sContent) : void

Parameters
NameTypeDescription
$sRow
$sCell
$sContent
methodpublicsetCellAlignment( $sRow,  $sCell,  $sAlignment) : void

Parameters
NameTypeDescription
$sRow
$sCell
$sAlignment
methodpublicsetCellClass( $sRow,  $sCell,  $sClass) : void

Parameters
NameTypeDescription
$sRow
$sCell
$sClass
methodpublicsetCellColspan( $sRow,  $sCell,  $iColSpan) : void

Parameters
NameTypeDescription
$sRow
$sCell
$iColSpan
methodpublicsetCellTemplate( $sCode) : void

Parameters
NameTypeDescription
$sCode
methodpublicsetCellVAlignment( $sRow,  $sCell,  $sAlignment) : void

Parameters
NameTypeDescription
$sRow
$sCell
$sAlignment
methodpublicsetDarkColor( $sColor) : void

Parameters
NameTypeDescription
$sColor
methodpublicsetLightColor( $sColor) : void

Parameters
NameTypeDescription
$sColor
methodpublicsetPadding( $sPadding) : void

Parameters
NameTypeDescription
$sPadding
methodpublicsetRowBgColor( $sRow,  $sColor) : void

Parameters
NameTypeDescription
$sRow
$sColor
methodpublicsetRowExtra( $sRow,  $sExtra) : void

Parameters
NameTypeDescription
$sRow
$sExtra
methodpublicsetSolidBorder( $bSolidBorder = true) : void

Parameters
NameTypeDescription
$bSolidBorder
methodpublicsetTableTemplateFile( $sPath) : void

Parameters
NameTypeDescription
$sPath
methodpublicsetWidth( $sWidth) : void

Parameters
NameTypeDescription
$sWidth

\cHTMLInputSelectElement

Package: Default
HTML Select Element
Parent(s)
\cHTMLSelectElement < \cHTMLFormElement < \cHTML < \HTML_Common
Author
Timo A. Hummel  

Properties

>VPropertypublic$_aEventDefinitions
>VPropertypublic$_content
Details
Type
n/a
Inherited_from
\cHTML::$$_content  
Inherited_from
\cHTMLFormElement::$$_content  
Inherited_from
\cHTMLSelectElement::$$_content  
>VPropertypublicboolean $_contentlessTag
inherited
Defines if the current tag is a contentless tag
Inherited from: \cHTML::$$_contentlessTag\cHTMLFormElement::$$_contentlessTag\cHTMLSelectElement::$$_contentlessTag
Details
Type
boolean
Access
private  
Inherited_from
\cHTML::$$_contentlessTag  
Inherited_from
\cHTMLFormElement::$$_contentlessTag  
Inherited_from
\cHTMLSelectElement::$$_contentlessTag  
>VPropertypublicarray $_options
inherited
All cHTMLOptionElements
Inherited from: \cHTMLSelectElement::$$_options
Details
Type
array
Inherited_from
\cHTMLSelectElement::$$_options  
>VPropertypublicarray $_requiredScripts
inherited
Defines all scripts which are required by the current element
Inherited from: \cHTML::$$_requiredScripts\cHTMLFormElement::$$_requiredScripts\cHTMLSelectElement::$$_requiredScripts
Details
Type
array
Access
private  
Inherited_from
\cHTML::$$_requiredScripts  
Inherited_from
\cHTMLFormElement::$$_requiredScripts  
Inherited_from
\cHTMLSelectElement::$$_requiredScripts  
>VPropertypublicstring $_skeleton_close
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_close  
Inherited_from
\cHTMLFormElement::$$_skeleton_close  
Inherited_from
\cHTMLSelectElement::$$_skeleton_close  
>VPropertypublicstring $_skeleton_open
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_open  
Inherited_from
\cHTMLFormElement::$$_skeleton_open  
Inherited_from
\cHTMLSelectElement::$$_skeleton_open  
>VPropertypublicstring $_skeleton_single
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_skeleton_single  
Inherited_from
\cHTMLFormElement::$$_skeleton_single  
Inherited_from
\cHTMLSelectElement::$$_skeleton_single  
>VPropertypublicstring $_styledefs
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_styledefs  
Inherited_from
\cHTMLFormElement::$$_styledefs  
Inherited_from
\cHTMLSelectElement::$$_styledefs  
>VPropertypublicstring $_tag
inherited
Defines which tag to use
Inherited from: \cHTML::$$_tag\cHTMLFormElement::$$_tag\cHTMLSelectElement::$$_tag
Details
Type
string
Access
private  
Inherited_from
\cHTML::$$_tag  
Inherited_from
\cHTMLFormElement::$$_tag  
Inherited_from
\cHTMLSelectElement::$$_tag  

Methods

methodpublic__toString() : string
inherited

Direct call of object as string will return it's generated markup.

Inherited from: \cHTML::__toString()\cHTMLFormElement::__toString()\cHTMLSelectElement::__toString()
Returns
TypeDescription
stringGenerated markup
methodpublic_setContent( $content) : void
inherited

_setContent: Sets the content of the object

Inherited from: \cHTML::_setContent()\cHTMLFormElement::_setContent()\cHTMLSelectElement::_setContent()
Parameters
NameTypeDescription
$content

string/object String with the content or an object to render.

methodpublicaddArticles(int $iIDCat, bool $bColored = false, bool $bArtOnline = true, string $sSpaces = "") : int

Function addArticles.

Adds articles to select box values.

Parameters
NameTypeDescription
$iIDCatint

idcat of the category to be listed

$bColoredbool

Add color information to option elements

$bArtOnlinebool

If true, only online articles will be added

$sSpacesstring

Just some "" to show data hierarchically (used in conjunction with addCategories)

Returns
TypeDescription
intNumber of items added
methodpublicaddCategories(int $iMaxLevel = 0, bool $bColored = false, bool $bCatVisible = true, bool $bCatPublic = true, bool $bWithArt = false, bool $bArtOnline = true) : int

Function addCategories.

Adds category elements (optionally including articles) to select box values. Note: Using "with articles" adds the articles also - but the categories will get a negative value! There is no way to distinguish between a category id and an article id...

Parameters
NameTypeDescription
$iMaxLevelint

Max. level shown (to be exact: except this level)

$bColoredbool

Add color information to option elements

$bCatVisiblebool

If true, only add idcat as value, if cat is visible

$bCatPublicbool

If true, only add idcat as value, if cat is public

$bWithArtbool

Add also articles per category

$bArtOnlinebool

If true, show only online articles

Returns
TypeDescription
intNumber of items added
methodpublicaddOptionElement( $index,  $element) : \none
inherited

Adds an cHTMLOptionElement to the number of choices.

Inherited from: \cHTMLSelectElement::addOptionElement()
Parameters
NameTypeDescription
$index

string Index of the element

$element

object Filled cHTMLOptionElement to add

Returns
TypeDescription
\none
methodpublicaddRequiredScript( $script) : void
Parameters
NameTypeDescription
$script
methodpublicaddTypesFromArt(int $iIDCatArt, string $sTypeRange = "") : int

Function addTypesFromArt.

Adds types and type ids which are available for the specified article

Parameters
NameTypeDescription
$iIDCatArtint

Article id

$sTypeRangestring

Komma separated list of Contenido type ids which may be in the resulting list (e.g. '1','17','28')

Returns
TypeDescription
intNumber of items added
methodpublicadvanceID() : void
inherited

advances to the next ID available in the system.

Inherited from: \cHTML::advanceID()\cHTMLFormElement::advanceID()\cHTMLSelectElement::advanceID()

This function is useful if you need to use HTML elements in a loop, but don't want to re-create new objects each time.

methodpublicattachEventDefinition( $sName,  $sEvent,  $sCode) : void
inherited

attachEventDefinition: Attaches the code for an event

Inherited from: \cHTML::attachEventDefinition()\cHTMLFormElement::attachEventDefinition()\cHTMLSelectElement::attachEventDefinition()

Example to attach an onClick handler: setEventDefinition("foo", "onClick", "alert('foo');");

Parameters
NameTypeDescription
$sName

string defines the name of the event

$sEvent

string defines the event (e.g. onClick)

$sCode

string defines the code

methodpublicattachStyleDefinition( $sName,  $sDefinition) : string

This function is not restricted to a single style, e.g. you can set multiple style definitions as-is to the handler.

$example->attachStyle("myIdentifier", "border: 1px solid black; white-space: nowrap"); $example->attachStyle("myIdentifier2", "padding: 0px");

Results in:

style="border: 1px solid black; white-space: nowrap; padding: 0px;"

Parameters
NameTypeDescription
$sName

string Name for a style definition

$sDefinition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicautoFill( $stuff) : \none
inherited

Automatically creates and fills cHTMLOptionElements

Inherited from: \cHTMLSelectElement::autoFill()

Array format: $stuff = array( array("value","title"), array("value","title"));

or regular key => value arrays.

Parameters
NameTypeDescription
$stuff

array Array with all items

Returns
TypeDescription
\none
methodpubliccHTML() : void
inherited

Constructor Function Initializes the SGML open/close tags

Inherited from: \cHTML::cHTML()\cHTMLFormElement::cHTML()\cHTMLSelectElement::cHTML()
methodpubliccHTMLFormElement( $name = "",  $id = "",  $disabled = "",  $tabindex = "",  $accesskey = "") : \none

This is a generic form element, where specific elements should be inherited from this class.

Parameters
NameTypeDescription
$name

string Name of the element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpubliccHTMLInputSelectElement(string $sName, int $iWidth = "", string $sID = "", string $bDisabled = false, int $iTabIndex = null,  $sAccessKey = "") : \none

Constructor.

Creates an HTML select field (aka "DropDown").

Parameters
NameTypeDescription
$sNamestring

Name of the element

$iWidthint

Width of the select element

$sIDstring

ID of the element

$bDisabledstring

Item disabled flag (non-empty to set disabled)

$iTabIndexint

Tab index for form elements

$sAccessKey
Returns
TypeDescription
\none
methodpubliccHTMLSelectElement( $name,  $width = "",  $id = "",  $disabled = false,  $tabindex = null,  $accesskey = "") : \none
inherited

Constructor.

Inherited from: \cHTMLSelectElement::cHTMLSelectElement()

Creates an HTML select field (aka "DropDown").

Parameters
NameTypeDescription
$name

string Name of the element

$width

int width of the select element

$id

string ID of the element

$disabled

string Item disabled flag (non-empty to set disabled)

$tabindex

string Tab index for form elements

$accesskey

string Key to access the field

Returns
TypeDescription
\none
methodpublicfillCloseSkeleton() : string
Returns
TypeDescription
stringfilled SGML closer skeleton
methodpublicfillSkeleton( $attributes) : string
inherited

fillSkeleton: Fills the open SGML tag skeleton

Inherited from: \cHTML::fillSkeleton()\cHTMLFormElement::fillSkeleton()\cHTMLSelectElement::fillSkeleton()

fillSkeleton fills the SGML opener tag with the specified attributes. Attributes need to be passed in the stringyfied variant.

Parameters
NameTypeDescription
$attributes

string Attributes to set

Returns
TypeDescription
stringfilled SGML opener skeleton
methodpublicgetDefault() : \Selected
inherited

Search for the selected elements

Inherited from: \cHTMLSelectElement::getDefault()
Returns
TypeDescription
\Selected"lvalue"
methodpublicgetID() : string
inherited

getID: returns the current ID

Inherited from: \cHTML::getID()\cHTMLFormElement::getID()\cHTMLSelectElement::getID()
Returns
TypeDescription
stringcurrent ID
methodpublicrender() : string
inherited

render(): Alias for toHtml

Inherited from: \cHTML::render()\cHTMLFormElement::render()\cHTMLSelectElement::render()
Returns
TypeDescription
stringRendered HTML
methodpublicsetAccessKey( $accesskey) : \none
inherited

sets the access key for this element.

Inherited from: \cHTMLFormElement::setAccessKey()\cHTMLSelectElement::setAccessKey()
Parameters
NameTypeDescription
$accesskey

string The length of the access key. May be A-Z and 0-9.

Returns
TypeDescription
\none
methodpublicsetAlt( $alt) : void
inherited

setAlt: sets the alt and title attributes

Inherited from: \cHTML::setAlt()\cHTMLFormElement::setAlt()\cHTMLSelectElement::setAlt()

Sets the "alt" and "title" tags. Usually, "alt" is used for accessibility and "title" for mouse overs.

To set the text for all browsers for mouse over, set "alt" and "title". IE behaves incorrectly and shows "alt" on mouse over. Mozilla browsers only show "title" as mouse over.

Parameters
NameTypeDescription
$alt

string Text to set as the "alt" attribute

methodpublicsetAttribute( $sAttributeName,  $sValue) : void
inherited

setAttribte: Sets a specific attribute

Inherited from: \cHTML::setAttribute()\cHTMLFormElement::setAttribute()\cHTMLSelectElement::setAttribute()
Parameters
NameTypeDescription
$sAttributeName

string Name of the attribute

$sValue

string Value of the attribute

methodpublicsetClass( $class) : void
Parameters
NameTypeDescription
$class

string Text to set as the "alt" attribute

methodpublicsetContentlessTag( $contentlessTag = true) : void
Parameters
NameTypeDescription
$contentlessTag
methodpublicsetDefault( $lvalue) : \none
inherited

Sets a specific cHTMLOptionElement to the selected state.

Inherited from: \cHTMLSelectElement::setDefault()
Parameters
NameTypeDescription
$lvalue

string Specifies the "value" of the cHTMLOptionElement to set

Returns
TypeDescription
\none
methodpublicsetDisabled( $disabled) : \none
inherited

Sets the "disabled" attribute of an element.

Inherited from: \cHTMLFormElement::setDisabled()\cHTMLSelectElement::setDisabled()

User Agents usually are showing the element as "greyed-out".

Example: $obj->setDisabled("disabled"); $obj->setDisabled("");

The first example sets the disabled flag, the second one removes the disabled flag.

Parameters
NameTypeDescription
$disabled

string Sets the disabled-flag if non-empty

Returns
TypeDescription
\none
methodpublicsetEvent( $event,  $action) : void
inherited

adds an "onXXX" javascript event handler

Inherited from: \cHTML::setEvent()\cHTMLFormElement::setEvent()\cHTMLSelectElement::setEvent()

example: $item->setEvent("change","document.forms[0].submit");

Parameters
NameTypeDescription
$event

string Type of the event

$action

string Function or action to call (JavaScript Code)

methodpublicsetGenerateXHTML(bool $value) : void
staticinherited

Setter for static $_generateXHTML property

Inherited from: \cHTML::setGenerateXHTML()\cHTMLFormElement::setGenerateXHTML()\cHTMLSelectElement::setGenerateXHTML()
Parameters
NameTypeDescription
$valuebool
methodpublicsetID( $id) : void
Parameters
NameTypeDescription
$id
methodpublicsetMultiselect() : void
inherited

Inherited from: \cHTMLSelectElement::setMultiselect()
methodpublicsetSelected(array $aElements) : \none

Selects specified elements as selected

Parameters
NameTypeDescription
$aElementsarray

Array with "values" of the cHTMLOptionElement to set

Returns
TypeDescription
\none
methodpublicsetSize( $size) : void
inherited

Inherited from: \cHTMLSelectElement::setSize()
Parameters
NameTypeDescription
$size
methodpublicsetStyle( $style) : void
Parameters
NameTypeDescription
$style
methodpublicsetStyleDefinition( $entity,  $definition) : string
Parameters
NameTypeDescription
$entity

string Entity to define

$definition

string Definition for the given entity

Returns
TypeDescription
stringfilled SGML closing skeleton
methodpublicsetTabindex( $tabindex) : \none
inherited

sets the tab index for this element.

Inherited from: \cHTMLFormElement::setTabindex()\cHTMLSelectElement::setTabindex()

The tab index needs to be numeric, bigger than 0 and smaller than 32767.

Parameters
NameTypeDescription
$tabindex

int desired tab index

Returns
TypeDescription
\none
methodpublictoHTML() : void
inherited

Renders the output If the tag

Inherited from: \cHTML::toHTML()\cHTMLFormElement::toHTML()\cHTMLSelectElement::toHTML()
methodpublictoHtml() : string
inherited

Renders the select box

Inherited from: \cHTMLSelectElement::toHtml()
Returns
TypeDescription
stringRendered HTML
methodpublicunsetEvent( $event) : void

example: $item->unsetEvent("change");

Parameters
NameTypeDescription
$event

string Type of the event

Documentation was generated by phpDocumentor 2.0.0a12.