NAME
Kernel::WebApp::Util::ConfigItem::Field::Role::IsField – Base role for the configuration item class fields.
PUBLIC INTERFACE
has Name
Attribute that holds the field name.
has Label
Attribute that holds the field label.
has ClassName
Attribute that holds the current class name.
has Path
Attribute that holds the full definition path.
has PathWithClass
Attribute that holds the full definition path with the class at the beginning.
has PathLabels
Attribute that holds the labels from the full definition path.
has PathLabelsWithClass
Attribute that holds the full definition path with the class at the beginning.
has PathString
Attribute that holds the full definition path.
has PathStringWithClass
Attribute that holds the full definition path.
has PathLevel
Attribute that holds the depth level of the class field.
has Value
Attribute that holds the current field values. It's saved in a array, because of the multiple fields.
has FormFieldValue
Attribute that holds the current form field value. It's saved in a array, because of the multiple fields.
has FormFieldAttributes
Attribute that holds the form field attributes (e.g. 'Required' or field specific values like 'Size').
has TranslatableValues
Attribute that holds the information if the field is translatable.
has Searchable
Attribute that holds the information if the field is searchable.
has Hidden
Attribute that holds the information if the field is hidden.
has SuppressVersionAdd
Attribute that holds the information if a new item version should be suppressed ('UpdateLastVersion', 'Ignore').
has MultipleField
Attribute that holds the information if the field can be added more then one times.
has MultipleFieldMin
Attribute that holds the information of the multiple field count minimum value.
has MultipleFieldMax
Attribute that holds the information of the multiple field count maximum value.
has MultipleFieldDefault
Attribute that holds the information of the multiple field default value.
has SubFields
Attribute that holds the information if the field has sub fields.
has Link
Attribute that holds the information about the link.
has NotForCustomer
Attribute that holds the information if the field is available for the customer or not.
requires Type
Every field needs to define his field Type.
requires FilterFormFieldSchema
Every field needs to define a function for the filter form field schema.
requires _FormFieldSchema
Every field needs to define a function for the form field schema.
MethodParamValidationSchema()
Add the param validation schema for the push event modules.
DisplayValueData()
Returns the display value data for the current field.
ExportDisplayValue()
Returns the export display value for the current field.
SearchConditionGet()
Returns the display value data for the current field.
FilterLabel()
Returns the filter label (with or without class suffix).
FilterLabelPlaceholder()
Returns the filter label placeholder (with or without class).
IsInvalid()
Check the current value with the current validator list.
FormFieldSchema()
Use the internal field function _FormFieldSchema to get the correct form schema, but in some situations we need to use the special dynamic definition field.
PRIVATE INTERFACE
has _FilterLabel
Attribute that holds the filter label.
has _FilterLabelWithClass
Attribute that holds the filter label with class.
has _Validators
Attribute that holds the validator list for the field
_BuildFilterLabel()
Build the _FilterLabel value (e.g. %s – %s).
_BuildFilterLabelWithClass()
Build the _FilterLabelWithClass value (e.g. %s: %s – %s).
_BuildPathString()
Build the PathString with the current Path array.
_BuildPathWithClass()
Build the PathWithClass array.
_BuildPathLabelsWithClass()
Build the PathLabelsWithClass array.
_BuildPathStringWithClass()
Build the PathStringWithClass with the current Path array.
_BuildValidators()
Build the Validators for the current field.
_BuildPathLevel()
Build the PathLevel with the current Path array.
_BuildFinalLink()
Builds the final Link.
