Constants

FUNCTION_UPDATE_PICKER_VALUE

FUNCTION_UPDATE_PICKER_VALUE

VAR_PICKER_VALUES

VAR_PICKER_VALUES

VAR_PICKER_DEFAULT_VALUE

VAR_PICKER_DEFAULT_VALUE

VAR_PICKER_ENTRY_ID

VAR_PICKER_ENTRY_ID

Properties

$values

$values : array<mixed,string>

Type

array<mixed,string> — Possible values

$default

$default : string

Type

string — Default value

Methods

collect()

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

Collect the Script Features of the given objects

Returns

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

prepare()

prepare(\FML\Script\Script  $script) : static

Prepare the given Script for rendering by adding the needed Labels, etc.

Parameters

\FML\Script\Script $script

Script to prepare

Returns

static

__construct()

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

Construct a new ValuePicker Feature

Parameters

\FML\Controls\Label $label

(optional) Label

\FML\Controls\Entry $entry

(optional) Hidden Entry

array<mixed,string> $values

(optional) Possible values

string $default

(optional) Default value

setLabel()

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

Set the Label

Parameters

\FML\Controls\Label $label

Label

Returns

static

setEntry()

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

Set the hidden Entry

Parameters

\FML\Controls\Entry $entry

Hidden Entry

Returns

static

getValues()

getValues() : array<mixed,string>

Get the possible values

Returns

array<mixed,string>

addValue()

addValue(string  $value) : static

Add a possible value

Parameters

string $value

Possible value

Returns

static

setValues()

setValues(array<mixed,string>  $values) : static

Set the possible values

Parameters

array<mixed,string> $values

Possible values

Returns

static

getDefault()

getDefault() : string

Get the default value

Returns

string

setDefault()

setDefault(string  $default) : static

Set the default value

Parameters

string $default

Default value

Returns

static

buildUpdatePickerValueFunction()

buildUpdatePickerValueFunction() : string

Build the function text

Returns

string

buildInitScriptText()

buildInitScriptText() : string

Build the init script text

Returns

string

buildClickScriptText()

buildClickScriptText() : string

Build the script text for Label clicks

Returns

string