\FML\ComponentsValuePicker

ValuePicker Component

Summary

Methods
Properties
Constants
__construct()
getName()
setName()
getValues()
setValues()
getDefault()
setDefault()
getLabel()
setLabel()
getEntry()
setEntry()
getScriptFeatures()
render()
No public properties found
No constants found
createLabel()
createEntry()
$name
$feature
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name : string

Type

string — ValuePicker name

Methods

__construct()

__construct(string  $name = null, array<mixed,string>  $values = null, string  $default = null, \FML\Controls\Label  $label = null) 

Create a new ValuePicker

Parameters

string $name

(optional) ValuePicker name

array<mixed,string> $values

(optional) Possible values

string $default

(optional) Default value

\FML\Controls\Label $label

(optional) ValuePicker label

getName()

getName() : string

Get the name

Returns

string

setName()

setName(string  $name) : static

Set the name

Parameters

string $name

ValuePicker name

Returns

static

getValues()

getValues() : array<mixed,string>

Get the possible values

Returns

array<mixed,string>

setValues()

setValues(array  $values) : static

Set the possible values

Parameters

array $values

Possible values

Returns

static

getDefault()

getDefault() : string

Get the default value

Returns

string

setDefault()

setDefault(boolean  $default) : static

Set the default value

Parameters

boolean $default

Default value

Returns

static

setLabel()

setLabel(\FML\Controls\Label  $label) : static

Set the Label

Parameters

\FML\Controls\Label $label

ValuePicker Label

Returns

static

setEntry()

setEntry(\FML\Controls\Entry  $entry) : static

Set the hidden Entry

Parameters

\FML\Controls\Entry $entry

Hidden Entry

Returns

static

getScriptFeatures()

getScriptFeatures() : array<mixed,\FML\Script\Features\ScriptFeature>

Get the Script Features

Returns

array<mixed,\FML\Script\Features\ScriptFeature>

render()

render(\DOMDocument  $domDocument) : \DOMElement

Render the XML element

Parameters

\DOMDocument $domDocument

DOMDocument for which the XML element should be rendered

Returns

\DOMElement

createLabel()

createLabel() : \FML\Controls\Label

Create the Label

Returns

\FML\Controls\Label

createEntry()

createEntry() : \FML\Controls\Entry

Create the hidden Entry

Returns

\FML\Controls\Entry