User Tools

Site Tools


Sidebar

Dokumentation

vortex:apidoc:dropdownfield

DropdownField

DropdownField

Filename : /classes/table/fields/dropdownfield.php
Extends : Field

Description

Field of dropdown type, containing a set number of choices

Fields

Methods

getDOM( &$xmlDocument, $isRelation )

Definition : public function getDOM( &$xmlDocument, $isRelation = false )

Returns :

Description
Returns a DOMElement representing this field

Parameters

$isRelation

Type : boolean
Default value : false

Description
Flags whether this DOM describes a relation or not

$xmlDocument

Type :
Default value :

Description
A reference to the DOMDocument to create the DOMElement in

getHead()

Definition : public function getHead()

Returns :

Description
Get header information for this dropdown

Parameters

getList( $translate )

Definition : public function getList( $translate = true )

Returns :

Description
Get array with all the strings in this dropdown

Parameters

$translate

Type : boolean
Default value : false

Description
Whether to pass the strings through Lang::translate and return in the Locale language

getPlaintext( $save )

Definition : public function getPlaintext( $save = false )

Returns : String

Description
Get the plaintext representation of this field

Parameters

$save

Type : boolean
Default value : false

Description
Whether this call is done during the save process

getStringsXML()

Definition : public function getStringsXML()

Returns : String

Description
Get the strings in this dropdown as a String representation of an XML element

Parameters

setPlaintext( $plaintext, $init )

Definition : public function setPlaintext( $plaintext, $init=false )

Returns : boolean - false on error, true on success

Description
Set value given plaintext string

Parameters

$init

Type : boolean
Default value : false

Description
Whether this call is done during the init process

$plaintext

Type : String
Default value :

Description
Plaintext string to set

setValue( $value, $init, $skipSetPlaintext )

Definition : public function setValue( $value, $init=false, $skipSetPlaintext=false )

Returns : boolean - false on error, true on success

Description
Set the value of this field

Parameters

$init

Type : boolean
Default value : false

Description
Whether this call is done during the initialization process

$skipSetPlaintext

Type : boolean
Default value : false

Description
Skip setting the plaintext for improved performance

$value

Type : int
Default value :

Description
Value to set

translate( $plaintext )

Definition : public function translate( $plaintext )

Returns : int

Description
Translate the given plaintext String to the corresponding ID of the contained option

Parameters

$plaintext

Type : String
Default value :

Description
String to translate

vortex/apidoc/dropdownfield.txt · Last modified: 2019/06/28 07:07 by hubbe