FormSelect
class FormSelect extends FormComponent
Properties
protected array | $config | from FormBase | |
bool | $save_requires_edit_var | from FormBase | |
Form | $form | from FormComponent | |
protected | $field_disable_save | Set to false if this field is not "saveable", e.g. static test |
from FormBase |
$REQUEST_VARS | from FormComponent | ||
$name | from FormComponent | ||
callable|bool | $db_handler | from FormComponent |
Methods
No description
Display field in print mode
Return Dom Selector for this field within the current form (This is NOT necessary unique if you are having 2 forms with identical names in form and field names
Get Element Visibility Class Formerly known as tag class
Does this component use combined input fields which required special handling from form?
Checks if the field is hidden by a tag. It is important when validating
No description
No description
Set ID Field of your datasource Array Syntax: pop_callback
Set Selector Category as Datasource
Show Custom Error Message for this field
Set delimiter of internally saved values Array Syntax: implode
Can user select multiple categories?
Field is to be loaded from and saved to database.
Field is considered to be translatable. This is usually determined automatically reading the instance configuration of the calling instance
Can user select multiple entries?
Consider Field as required
Set Field label
Set the onchange HTML attribute
Manipulate another fields data when the value of the current field changes.
Add Custom HTML before the field element
Set HTML attribute size
Set Values to choose from Array Syntax: pop_data
Set Visibility Dependency if you want your field only to be shown if another field has a specify value Array Syntax: tag, tag_source
Set field to be the event source for another dependent field. Changes of this fields values will trigger events to their dependent fields and change their visibility in the frontend
Details
in
FormBase at line 31
__construct()
FormBase constructor.
The constructor is able to set an array of properties options
in
FormBase at line 200
append(string $name, mixed $value, bool|string $key = false)
No description
in
FormBase at line 185
void
concat(string $name, string $value)
No description
in
FormBase at line 170
mixed
destroy($name)
No description
at line 20
string
display_field(string $fieldname, string|bool $default_value = false)
No description
at line 227
string
display_field_print(string $fieldname, string $default_value = false)
Display field in print mode
in
FormBase at line 76
mixed
get(string $name)
No description
in
FormBase at line 83
array
getConfig()
No description
in
FormComponent at line 583
string
getDomSelector()
Return Dom Selector for this field within the current form (This is NOT necessary unique if you are having 2 forms with identical names in form and field names
in
FormComponent at line 595
protected string
getElementVisibilityClass()
Get Element Visibility Class Formerly known as tag class
in
FormComponent at line 496
bool
getIsVisible()
Determine visibilty based on user input on dependent fields
in
FormComponent at line 168
string
get_description()
No description
in
FormComponent at line 274
mixed
get_display_value()
returns the displayed value
in
FormBase at line 219
array
get_group(string $prefix)
No description
in
FormComponent at line 149
string
get_help_tooltip_icon()
No description
in
FormBase at line 91
array
get_properties()
No description
in
FormComponent at line 47
array|bool
get_validation_options()
No description
in
FormComponent at line 187
get_value()
No description
in
FormComponent at line 39
bool
hasCombinedInputFields()
Does this component use combined input fields which required special handling from form?
in
FormBase at line 39
init_obj()
Initializes the form base
in
FormComponent at line 544
$this
insertAfter(FormComponent $formComponent = null)
Insert this field after the specified field
in
FormComponent at line 529
$this
insertBefore(FormComponent $formComponent = null)
Insert this field before the specified field
in
FormComponent at line 369
bool
isReadonly()
Returns TRUE if field is readonly, FALSE otherwise.
in
FormBase at line 239
bool
is_displayed()
Checks if the field is hidden by a tag. It is important when validating
in
FormComponent at line 257
void
post_process()
No description
in
FormComponent at line 181
void
process()
Process e.g. file upload, resize etc.
in
FormComponent at line 198
string
render(string|false $name = false, string|false $value = false)
No description
at line 231
mixed
save()
No description
in
FormBase at line 103
$this
set(string $name, mixed $value)
No description
in
FormComponent at line 391
$this
setCSSClassName(string $class = null)
Set Field Row CSS class name
at line 315
$this
setCallbackAsDatasource(callable $callback)
Set ID Field of your datasource Array Syntax: pop_callback
at line 327
$this
setCategoryAsDatasource(xmodel_selector_category $category)
deprecated
deprecated
Set Selector Category as Datasource
in
FormComponent at line 559
$this
setCustomErrorText(string $error_msg)
Show Custom Error Message for this field
in
FormComponent at line 380
$this
setDefaultValue(mixed $value = null)
Set Field default value
at line 289
$this
setDelimiter(string $delimiter = ',')
Set delimiter of internally saved values Array Syntax: implode
in
FormComponent at line 413
$this
setDescriptionText(string $description = null)
Set Field Help Text
in
FormComponent at line 573
$this
setGridClass(string $gridClass = null)
Set Flexbox Grid Class
in
FormComponent at line 402
$this
setHelpText(string $help = null)
Set Field Help Text
at line 360
$this
setHideNoValue(bool $bool = true)
Can user select multiple categories?
in
FormComponent at line 336
$this
setIsDBField(bool $bool = true)
Field is to be loaded from and saved to database.
in
FormComponent at line 349
$this
setIsI18NField(bool $bool = true)
Field is considered to be translatable. This is usually determined automatically reading the instance configuration of the calling instance
at line 349
$this
setIsMultiple(bool $bool = true)
Can user select multiple entries?
in
FormComponent at line 360
$this
setIsReadonly(bool $bool = true)
Consider Field as readonly
in
FormComponent at line 325
$this
setIsRequired(bool $bool = true, bool $onlyRequiredIfVisible = true)
Consider Field as required
in
FormComponent at line 311
$this
setLabel(string $label = '', string $icon_class = '', int $width_in_px = null)
Set Field label
at line 338
$this
setOnChangeJS(string $jsfunction = '')
Set the onchange HTML attribute
in
FormComponent at line 448
$this
setPopulateField(FormComponent $target, string $dataURL = null)
Manipulate another fields data when the value of the current field changes.
Common usage: Populate a second select once user chooses from the first select
in
FormComponent at line 424
$this
setPrefixHTML(string $html = null)
Add Custom HTML before the field element
at line 372
$this
setSize(int $size = null)
Set HTML attribute size
in
FormComponent at line 435
$this
setSuffixHTML(string $html = null)
Add Custom HTML after the field element
at line 303
$this
setValuesAsDatasource(array $values = [], array $group_data = [])
Set Values to choose from Array Syntax: pop_data
in
FormComponent at line 462
$this
setVisibilityDependsOn(FormComponent $formComponent = null, array $matchingValues = [])
Set Visibility Dependency if you want your field only to be shown if another field has a specify value Array Syntax: tag, tag_source
in
FormComponent at line 486
$this
setVisibilityIsSource(bool $bool = true)
Set field to be the event source for another dependent field. Changes of this fields values will trigger events to their dependent fields and change their visibility in the frontend
Fields are automatically set to be a source if used in a call of setVisibilityDependsOn()
Array Syntax: tag_source
in
FormComponent at line 265
set_display_value(mixed $value)
set the displayed value
in
FormBase at line 155
void
set_properties(array $array)
No description
in
FormComponent at line 31
set_request_vars($request)
No description
in
FormComponent at line 90
bool|string
validate()
No description