1. class
  2. Alvine
  3. \
  4. Application
  5. \
  6. Web
  7. \
  8. View
  9. \
  10. Definition
  11. \
  12. OptionField

OptionField

class OptionField extends Field implements InstantiableFromProperties

Diese Sonderform ist eine Felddefinition mit Optionen für Selects, Radio und Checkboxen

Über das Attribute option kann man einem Select eine Key/Value-Map übergeben, die Werte werden direkt als Option verwendet. Zusätzlich kann über options weitergehende Quellen für die Werte definiert werden:

file definert eine Datei im Property-Stiel mit key=value. route definert eine Route die aufgerufen wird und ein JSON einliest. url definert eine URL die aufgerufen wird und ein JSON einliest.

Beim Typ url muss über key und label der Schlüssel im JSON definiert werden.

Properties

protected string $name from Field
protected string $label from Field
protected string $visible from Field
protected boolean $editable from Field
protected type $type from Field
protected string $filterable from Field
protected SimpleMap $data from Field
protected type $info from Field
protected boolean $multiple
protected SimpleMap $options

Methods

__construct(string $name, string $type, string $label = null)

Neue Felddefinition

string
getName()

Name

from Field
string
getLabel()

Name

from Field
boolean
isVisible()

Sichtbarkeit

from Field
boolean
isEditable()

Änderbar

from Field
boolean
isFilterable()

Filtern nach dem Feld

from Field
boolean
isMultiple()

Mehrfachwerte

string
getType()

Type

from Field
Field
setDataAttribute(string $key, string $value)

Werte für Data-Attribute setzen

from Field
SimpleMap
getDataAttributes()

DataFelder

from Field
boolean
hasDataAttributes()

Prüfen ob die Felddefinitionen Data-Attribute hat

from Field
Field
setVisibility(boolean $visible)

Sichtbarkeit

from Field
Field
setEditable(boolean $editable)

Editable

from Field
Field
setFilterable(boolean $filterable)

Filterbar

from Field
Field
setInfo(string $text)

Infotext setzen

from Field
string
getInfo()

Infotext

from Field
static Field
getInstanceFromProperties(Properties $properties)

Definition aus Konfiguration auslesen

SimpleMap
getOptions()

Optionen (optional)

Field
setMultiple(boolean $multiple = true)

Mehrfachwerte aktivieren

Field
initOptions(Properties $properties)

Selectfelder initialisieren

initOptionsFromFile(Properties $options)

Optionen aus Datei

initOptionsFromURL(Properties $options)

Optionen von URL

Details

at line 64
__construct(string $name, string $type, string $label = null)

Neue Felddefinition

Parameters

string $name Name
string $type Typ
string $label Label

in Field at line 102
string getName()

Name

Return Value

string

in Field at line 111
string getLabel()

Name

Return Value

string

in Field at line 120
boolean isVisible()

Sichtbarkeit

Return Value

boolean

in Field at line 129
boolean isEditable()

Änderbar

Return Value

boolean

in Field at line 138
boolean isFilterable()

Filtern nach dem Feld

Return Value

boolean

at line 78
boolean isMultiple()

Mehrfachwerte

Return Value

boolean

in Field at line 156
string getType()

Type

Return Value

string Type

in Field at line 168
Field setDataAttribute(string $key, string $value)

Werte für Data-Attribute setzen

Parameters

string $key Attribute-Name
string $value Wert

Return Value

Field

in Field at line 178
SimpleMap getDataAttributes()

DataFelder

Return Value

SimpleMap Data-Felder

in Field at line 187
boolean hasDataAttributes()

Prüfen ob die Felddefinitionen Data-Attribute hat

Return Value

boolean

in Field at line 198
Field setVisibility(boolean $visible)

Sichtbarkeit

Parameters

boolean $visible

Return Value

Field

in Field at line 210
Field setEditable(boolean $editable)

Editable

Parameters

boolean $editable

Return Value

Field

in Field at line 222
Field setFilterable(boolean $filterable)

Filterbar

Parameters

boolean $filterable

Return Value

Field

in Field at line 234
Field setInfo(string $text)

Infotext setzen

Parameters

string $text

Return Value

Field

in Field at line 244
string getInfo()

Infotext

Return Value

string $text

at line 110
static Field getInstanceFromProperties(Properties $properties)

Definition aus Konfiguration auslesen

Parameters

Properties $properties Eigenschaften

Return Value

Field

at line 87
SimpleMap getOptions()

Optionen (optional)

Return Value

SimpleMap

at line 98
Field setMultiple(boolean $multiple = true)

Mehrfachwerte aktivieren

Parameters

boolean $multiple

Return Value

Field

at line 134
Field initOptions(Properties $properties)

Selectfelder initialisieren

Über das Attribute option kann eine Key/Value-Map übergeben werden, die direkt als Option verwendet wird. Zusätzlich kann über options weitergehende Werte definiert werden:

file definert eine Datei die Key/Values enthält. url definert eine URL die aufgerufen wird und ein JSON zurückgeben muss Beim Typ URL muss über key und label der Schlüssel im JSON definiert werden.

Parameters

Properties $properties

Return Value

Field

Exceptions

NotFoundException Wenn die definierte Map nicht vorhanden ist

at line 162
protected initOptionsFromFile(Properties $options)

Optionen aus Datei

Parameters

Properties $options \Alvine\Application\Web\View\Definition\Field

Exceptions

NotFoundException

at line 185
protected initOptionsFromURL(Properties $options)

Optionen von URL

Parameters

Properties $options \Alvine\Application\Web\View\Definition\Field