CSGuiConfigurationField
extends CSGuiObjectField
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() : array<string|int, mixed>
- _getEditorType() : string
- _getFieldDependenciesForValue() : array<string|int, mixed>
- _getFieldDependenciesForValue
- addFieldDependency() : bool
- Adds a field dependency for a specific value.
- addFilter() : mixed
- addRecordClass() : mixed
- addValueDependency() : bool
- Adds a value dependency for a specific field.
- createFieldForType() : CSGuiField
- Returns a field configuration for a given type.
- getDefaultValue() : mixed
- getErrorMessage() : mixed
- getFilters() : mixed
- getLabel() : mixed
- getName() : mixed
- getPaneTitle() : mixed
- getPaneTitleOrder() : mixed
- getRecordClasses() : mixed
- getRootFolderIds() : array<string|int, mixed>
- Returns the root folder IDs defined for field.
- getSectionTitle() : mixed
- getSectionTitleOrder() : mixed
- getTooltip() : mixed
- getType() : mixed
- hasFieldDependencies() : bool
- Checks if the current GUI field has any field dependencies.
- hasValueDependencies() : bool
- Returns whether the current field has value dependencies configured.
- isMultipleSelection() : mixed
- isReadonly() : mixed
- isRequired() : mixed
- isVisible() : mixed
- removeFilter() : mixed
- removeFilters() : mixed
- removeRecordClass() : mixed
- setAllowFolderSelectionForRecordClass() : mixed
- setDefaultValue() : mixed
- setErrorMessage() : mixed
- setFilters() : bool
- Set object filters.
- setLabel() : mixed
- setNoLabelTranslation() : void
- Disables the automatic translation of the field label
- setPaneTitle() : mixed
- setReadonly() : mixed
- setRecordClasses() : mixed
- setRequired() : mixed
- setRootFolderIds() : mixed
- This method is used to set the folder root ids defined
- setSectionTitle() : mixed
- setTooltip() : mixed
- setVisibility() : mixed
- shouldAllowFolderSelectionForRecordClass() : mixed
- shouldShowClassAttributes() : bool
- Should the field show the class attributes.
- shouldShowClasses() : bool
- Should the field show the classes.
- shouldShowFolders() : bool
- Should the field show the folders.
- shouldShowStandardAttributes() : bool
- Should the field show the standard attributes.
- shouldTranslateFieldLabel() : bool|null
- Returns the value of the private class variable {@var $_bShouldTranslateFieldLabel}
- showClassAttributes() : void
- Show the class attributes in the field chooser.
- showClasses() : void
- Show the classes in the field chooser.
- showFolders() : void
- Show the folders in the field chooser.
- showMultipleSelection() : mixed
- showStandardAttributes() : void
- Show the standard attributes in the field chooser.
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() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —_getEditorType()
public
_getEditorType() : string
Tags
Return values
string —_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 —addFilter()
public
addFilter(mixed $sFilterType, mixed $mFilterValue) : mixed
Parameters
- $sFilterType : mixed
- $mFilterValue : mixed
Tags
Return values
mixed —addRecordClass()
public
addRecordClass(mixed $mRecordClass) : mixed
Parameters
- $mRecordClass : mixed
Tags
Return values
mixed —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 —getDefaultValue()
public
getDefaultValue() : mixed
Tags
Return values
mixed —getErrorMessage()
public
getErrorMessage() : mixed
Tags
Return values
mixed —getFilters()
public
getFilters() : mixed
Tags
Return values
mixed —getLabel()
public
getLabel() : mixed
Tags
Return values
mixed —getName()
public
getName() : mixed
Tags
Return values
mixed —getPaneTitle()
public
getPaneTitle() : mixed
Tags
Return values
mixed —getPaneTitleOrder()
public
getPaneTitleOrder() : mixed
Tags
Return values
mixed —getRecordClasses()
public
getRecordClasses() : mixed
Tags
Return values
mixed —getRootFolderIds()
Returns the root folder IDs defined for field.
public
getRootFolderIds() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —A list of root ids to which the search should be limited. If null is returned, no limitation has been defined.
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 has any field dependencies.
public
hasFieldDependencies() : bool
Tags
Return values
bool —if the current GUI field has 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()
public
isMultipleSelection() : mixed
Tags
Return values
mixed —isReadonly()
public
isReadonly() : mixed
Tags
Return values
mixed —isRequired()
public
isRequired() : mixed
Tags
Return values
mixed —isVisible()
public
isVisible() : mixed
Tags
Return values
mixed —removeFilter()
public
removeFilter(mixed $sFilterType) : mixed
Parameters
- $sFilterType : mixed
Tags
Return values
mixed —removeFilters()
public
removeFilters() : mixed
Tags
Return values
mixed —removeRecordClass()
public
removeRecordClass(mixed $mRecordClass) : mixed
Parameters
- $mRecordClass : mixed
Tags
Return values
mixed —setAllowFolderSelectionForRecordClass()
public
setAllowFolderSelectionForRecordClass(mixed $mRecordOrClass, mixed $bAllowFolderSelection) : mixed
Parameters
- $mRecordOrClass : mixed
- $bAllowFolderSelection : mixed
Tags
Return values
mixed —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 —setFilters()
Set object filters.
public
setFilters(array<string|int, mixed> $aFilters) : bool
Parameters
- $aFilters : array<string|int, mixed>
Tags
Return values
bool —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 —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 —setRecordClasses()
public
setRecordClasses(mixed $aRecordClasses) : mixed
Parameters
- $aRecordClasses : mixed
Tags
Return values
mixed —setRequired()
public
setRequired(mixed $bIsRequired) : mixed
Parameters
- $bIsRequired : mixed
Tags
Return values
mixed —setRootFolderIds()
This method is used to set the folder root ids defined
public
setRootFolderIds(array<string|int, mixed> $aRootFolderIds) : mixed
Parameters
- $aRootFolderIds : array<string|int, 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 —shouldAllowFolderSelectionForRecordClass()
public
shouldAllowFolderSelectionForRecordClass(mixed $mRecordClass) : mixed
Parameters
- $mRecordClass : mixed
Tags
Return values
mixed —shouldShowClassAttributes()
Should the field show the class attributes.
public
shouldShowClassAttributes() : bool
Tags
Return values
bool —whether the field should show the class attributes.
shouldShowClasses()
Should the field show the classes.
public
shouldShowClasses() : bool
Tags
Return values
bool —whether the field should show the classes
shouldShowFolders()
Should the field show the folders.
public
shouldShowFolders() : bool
Tags
Return values
bool —whether the field should show the folders.
shouldShowStandardAttributes()
Should the field show the standard attributes.
public
shouldShowStandardAttributes() : bool
Tags
Return values
bool —whether the field should show the standard attributes.
shouldTranslateFieldLabel()
Returns the value of the private class variable {@var $_bShouldTranslateFieldLabel}
public
shouldTranslateFieldLabel() : bool|null
Tags
Return values
bool|null —showClassAttributes()
Show the class attributes in the field chooser.
public
showClassAttributes(bool $bShowClassAttributes) : void
Parameters
- $bShowClassAttributes : bool
Tags
Return values
void —showClasses()
Show the classes in the field chooser.
public
showClasses(bool $bShowClasses) : void
Parameters
- $bShowClasses : bool
Tags
Return values
void —showFolders()
Show the folders in the field chooser.
public
showFolders(bool $bShowFolders) : void
Parameters
- $bShowFolders : bool
-
Whether the field chooser should show the folders.
Tags
Return values
void —showMultipleSelection()
public
showMultipleSelection(mixed $bIsMultipleSelection) : mixed
Parameters
- $bIsMultipleSelection : mixed
Tags
Return values
mixed —showStandardAttributes()
Show the standard attributes in the field chooser.
public
showStandardAttributes(bool $bShowStandardAttributes) : void
Parameters
- $bShowStandardAttributes : bool