CSGuiSelectionField
extends CSGuiField
in package
Defines the abstract API class for the GUI fields.
Tags
Table of Contents
- DEPENDENCE_VALUE_WILDCARD = '*'
- TYPE_CHECKBOX = 'Checkbox'
- TYPE_CODE = 'Code'
- TYPE_CONFIGURATION = 'Configuration'
- TYPE_DATE = 'Date'
- TYPE_HTML = 'Html'
- TYPE_NUMERIC = 'Numeric'
- TYPE_OBJECT = 'Object'
- TYPE_PASSWORD = 'Password'
- TYPE_SELECTION = 'Selection'
- TYPE_TAG = 'Tag'
- TYPE_TEXT = 'Text'
- TYPE_TEXT_AREA = 'TextArea'
- TYPE_TIME = 'Time'
- _getEditorAdditionalOptions() : mixed
- _getEditorType() : mixed
- _getFieldDependenciesForValue() : array<string|int, mixed>
- _getFieldDependenciesForValue
- addFieldDependency() : bool
- Adds a field dependency for a specific value.
- addOption() : bool
- Adds a GUI selection option to the current field.
- addValueDependency() : bool
- Adds a value dependency for a specific field.
- createFieldForType() : CSGuiField
- Returns a field configuration for a given type.
- createOption() : CSGuiSelectionOption
- Creates an GUI selection option for the current field.
- getDefaultValue() : mixed
- getErrorMessage() : mixed
- getFormattedOptions() : array<string|int, mixed>
- Returns an array with the formatted GUI selection options ({KEY} => {LABEL}).
- getLabel() : mixed
- getName() : mixed
- getOptions() : array<string|int, CSGuiSelectionOption>
- Returns all defined selection options for the current GUI field.
- getPaneTitle() : mixed
- getPaneTitleOrder() : mixed
- getSectionTitle() : mixed
- getSectionTitleOrder() : mixed
- getTooltip() : mixed
- getType() : mixed
- hasFieldDependencies() : bool
- Checks if the current GUI field or defined field options have any field dependencies.
- hasValueDependencies() : bool
- Returns whether the current field has value dependencies configured.
- isMultipleSelection() : bool
- Returns the flag if the field is a multiple selection.
- isReadonly() : mixed
- isRequired() : mixed
- isVisible() : mixed
- removeOptionForKey() : bool
- Removes a GUI selection option for a given option key.
- removeOptions() : bool
- Removes all defined GUI selection options from the current field.
- setDefaultValue() : mixed
- setErrorMessage() : mixed
- setLabel() : mixed
- setNoLabelTranslation() : void
- Disables the automatic translation of the field label
- setOptions() : bool
- Sets / Overwrites the GUI selection options for the current field.
- setPaneTitle() : mixed
- setReadonly() : mixed
- setRequired() : mixed
- setSectionTitle() : mixed
- setTooltip() : mixed
- setVisibility() : mixed
- shouldShowEmptyOption() : bool
- Returns the flag if the empty option is visible in the field selection.
- shouldTranslateFieldLabel() : bool|null
- Returns the value of the private class variable {@var $_bShouldTranslateFieldLabel}
- showEmptyOption() : mixed
- Defines the flag if the empty option should be visible in the field selection.
- showMultipleSelection() : bool
- Sets the flag if multiple selection should be available for the current field.
Constants
DEPENDENCE_VALUE_WILDCARD
public
mixed
DEPENDENCE_VALUE_WILDCARD
= '*'
Tags
TYPE_CHECKBOX
public
mixed
TYPE_CHECKBOX
= 'Checkbox'
Tags
TYPE_CODE
public
mixed
TYPE_CODE
= 'Code'
Tags
TYPE_CONFIGURATION
public
mixed
TYPE_CONFIGURATION
= 'Configuration'
Tags
TYPE_DATE
public
mixed
TYPE_DATE
= 'Date'
Tags
TYPE_HTML
public
mixed
TYPE_HTML
= 'Html'
Tags
TYPE_NUMERIC
public
mixed
TYPE_NUMERIC
= 'Numeric'
Tags
TYPE_OBJECT
public
mixed
TYPE_OBJECT
= 'Object'
Tags
TYPE_PASSWORD
public
mixed
TYPE_PASSWORD
= 'Password'
Tags
TYPE_SELECTION
public
mixed
TYPE_SELECTION
= 'Selection'
Tags
TYPE_TAG
public
mixed
TYPE_TAG
= 'Tag'
Tags
TYPE_TEXT
public
mixed
TYPE_TEXT
= 'Text'
Tags
TYPE_TEXT_AREA
public
mixed
TYPE_TEXT_AREA
= 'TextArea'
Tags
TYPE_TIME
public
mixed
TYPE_TIME
= 'Time'
Tags
Methods
_getEditorAdditionalOptions()
public
_getEditorAdditionalOptions() : mixed
Tags
Return values
mixed —_getEditorType()
public
_getEditorType() : mixed
Tags
Return values
mixed —_getFieldDependenciesForValue()
_getFieldDependenciesForValue
public
_getFieldDependenciesForValue(mixed $mValue) : array<string|int, mixed>
Parameters
- $mValue : mixed
Tags
Return values
array<string|int, mixed> —addFieldDependency()
Adds a field dependency for a specific value.
public
addFieldDependency(string $sFieldName[, bool $bShouldBeVisible = false ][, string $mValue = self::DEPENDENCE_VALUE_WILDCARD ]) : bool
It defines whether a field name should be visible or invisible if a specific value has been selected.
Parameters
- $sFieldName : string
-
The target field name of the field dependency.
- $bShouldBeVisible : bool = false
-
Whether the field should be visible or invisible.
- $mValue : string = self::DEPENDENCE_VALUE_WILDCARD
-
The value, when the field dependency should be used. Default value: "*" => self::DEPENDENCE_VALUE_WILDCARD
Tags
Return values
bool —addOption()
Adds a GUI selection option to the current field.
public
addOption(CSGuiSelectionOption $oSelectionOption) : bool
Parameters
- $oSelectionOption : CSGuiSelectionOption
-
The GUI selection option which should be added to the current field.
Tags
Return values
bool —addValueDependency()
Adds a value dependency for a specific field.
public
addValueDependency(string $sFieldName) : bool
It defines whether the dependent field should be cleared if the value changes.
Parameters
- $sFieldName : string
-
The target field name of the field to be cleared on change.
Tags
Return values
bool —createFieldForType()
Returns a field configuration for a given type.
public
static createFieldForType(string $sFieldConfigurationType, mixed $sName) : CSGuiField
Parameters
- $sFieldConfigurationType : string
- $sName : mixed
Tags
Return values
CSGuiField —createOption()
Creates an GUI selection option for the current field.
public
createOption(string $sKey) : CSGuiSelectionOption
Parameters
- $sKey : string
-
The key for the selection option.
Tags
Return values
CSGuiSelectionOption —getDefaultValue()
public
getDefaultValue() : mixed
Tags
Return values
mixed —getErrorMessage()
public
getErrorMessage() : mixed
Tags
Return values
mixed —getFormattedOptions()
Returns an array with the formatted GUI selection options ({KEY} => {LABEL}).
public
getFormattedOptions([bool $bReturnDetails = false ]) : array<string|int, mixed>
Parameters
- $bReturnDetails : bool = false
-
If the method should return the detailed options ({KEY} => {'text' => LABEL, 'style' => STYLE})
Tags
Return values
array<string|int, mixed> —with the formatted GUI selection options ({KEY} => {LABEL})
getLabel()
public
getLabel() : mixed
Tags
Return values
mixed —getName()
public
getName() : mixed
Tags
Return values
mixed —getOptions()
Returns all defined selection options for the current GUI field.
public
getOptions() : array<string|int, CSGuiSelectionOption>
Tags
Return values
array<string|int, CSGuiSelectionOption> —An array with all defined selection options.
getPaneTitle()
public
getPaneTitle() : mixed
Tags
Return values
mixed —getPaneTitleOrder()
public
getPaneTitleOrder() : mixed
Tags
Return values
mixed —getSectionTitle()
public
getSectionTitle() : mixed
Tags
Return values
mixed —getSectionTitleOrder()
public
getSectionTitleOrder() : mixed
Tags
Return values
mixed —getTooltip()
public
getTooltip() : mixed
Tags
Return values
mixed —getType()
public
final getType() : mixed
Tags
Return values
mixed —hasFieldDependencies()
Checks if the current GUI field or defined field options have any field dependencies.
public
hasFieldDependencies() : bool
Tags
Return values
bool —if the current GUI field or defined field options have any field dependencies.
hasValueDependencies()
Returns whether the current field has value dependencies configured.
public
hasValueDependencies() : bool
Tags
Return values
bool —true, if field has value dependencies, otherwise false.
isMultipleSelection()
Returns the flag if the field is a multiple selection.
public
isMultipleSelection() : bool
Tags
Return values
bool —isReadonly()
public
isReadonly() : mixed
Tags
Return values
mixed —isRequired()
public
isRequired() : mixed
Tags
Return values
mixed —isVisible()
public
isVisible() : mixed
Tags
Return values
mixed —removeOptionForKey()
Removes a GUI selection option for a given option key.
public
removeOptionForKey(mixed $mKey) : bool
Parameters
- $mKey : mixed
-
The option key which should be deleted from the defined GUI selection options.
Tags
Return values
bool —IF TRUE the key has been deleted IF FALSE the key hasn't been found.
removeOptions()
Removes all defined GUI selection options from the current field.
public
removeOptions() : bool
Tags
Return values
bool —setDefaultValue()
public
setDefaultValue(mixed $mDefaultValue) : mixed
Parameters
- $mDefaultValue : mixed
Tags
Return values
mixed —setErrorMessage()
public
setErrorMessage(mixed $sErrorMessage) : mixed
Parameters
- $sErrorMessage : mixed
Tags
Return values
mixed —setLabel()
public
setLabel(mixed $sLabel) : mixed
Parameters
- $sLabel : mixed
Tags
Return values
mixed —setNoLabelTranslation()
Disables the automatic translation of the field label
public
setNoLabelTranslation(bool $bDisableFieldLabelTranslation) : void
Parameters
- $bDisableFieldLabelTranslation : bool
Tags
Return values
void —setOptions()
Sets / Overwrites the GUI selection options for the current field.
public
setOptions(array<string|int, CSGuiSelectionOption> $aSelectionOptions) : bool
Parameters
- $aSelectionOptions : array<string|int, CSGuiSelectionOption>
-
An array with the GUI selection options.
Tags
Return values
bool —setPaneTitle()
public
setPaneTitle(mixed $sPaneTitle[, mixed $iPaneTitleOrder = null ]) : mixed
Parameters
- $sPaneTitle : mixed
- $iPaneTitleOrder : mixed = null
Tags
Return values
mixed —setReadonly()
public
setReadonly(mixed $bIsReadonly) : mixed
Parameters
- $bIsReadonly : mixed
Tags
Return values
mixed —setRequired()
public
setRequired(mixed $bIsRequired) : mixed
Parameters
- $bIsRequired : mixed
Tags
Return values
mixed —setSectionTitle()
public
setSectionTitle(mixed $sSectionTitle[, mixed $iSectionTitleOrder = null ]) : mixed
Parameters
- $sSectionTitle : mixed
- $iSectionTitleOrder : mixed = null
Tags
Return values
mixed —setTooltip()
public
setTooltip(mixed $sTooltip) : mixed
Parameters
- $sTooltip : mixed
Tags
Return values
mixed —setVisibility()
public
setVisibility(mixed $bIsVisible) : mixed
Parameters
- $bIsVisible : mixed
Tags
Return values
mixed —shouldShowEmptyOption()
Returns the flag if the empty option is visible in the field selection.
public
shouldShowEmptyOption() : bool
Tags
Return values
bool —shouldTranslateFieldLabel()
Returns the value of the private class variable {@var $_bShouldTranslateFieldLabel}
public
shouldTranslateFieldLabel() : bool|null
Tags
Return values
bool|null —showEmptyOption()
Defines the flag if the empty option should be visible in the field selection.
public
showEmptyOption(bool $bShouldShowEmptyOption) : mixed
Parameters
- $bShouldShowEmptyOption : bool
-
Whether the empty option is visible or not.
Tags
Return values
mixed —showMultipleSelection()
Sets the flag if multiple selection should be available for the current field.
public
showMultipleSelection(bool $bIsMultipleSelection) : bool
Parameters
- $bIsMultipleSelection : bool
-
Whether multiple selection should be available or not.