FormUrl
class FormUrl extends FormTextbox
Class FormUrl
Traits
Trait FormTextboxTrait
Constants
INPUT_FILTER_NUMERIC |
Possible input filters for setInputFilter() |
INPUT_FILTER_MONEY |
|
INPUT_FILTER_DECIMAL |
|
INPUT_FILTER_INTEGER |
|
INPUT_FILTER_OPERATOR |
|
INPUT_FILTER_STRING |
|
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
Display field
Display field in print mode
No description
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
Set Auto Title attribute, usually visible when no data has been entered into the field This attribute is very similar to the placeholder attribute an may conflict if both are set.
Set Autocomplete for this field
Show Custom Error Message for this field
Format output to show as formatted numeric value.
Automatically format the default value using an call to the XELOS Format Helper
Set input filter - a javascript input check. This may conflict with a HTML5 pattern attribute.
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
Consider Field as required
Set Field label
Set max chars for this field Array Syntax: maxlength
Set HTML5 Placeholder Attribute, usually visible when no data has been entered into the field
Manipulate another fields data when the value of the current field changes.
Add Custom HTML before the field element
Show Copy to Clipboard function next to this field?
Submit the form when the user presses enter? (Standard for POST forms, but not standard for GET forms) Useful if you are implementing a search form using GET request method
Set Title attribute, title is shown on hovering over the field
Set HTML5 REGEX Pattern Attribute, which will be used by browsers to validate user input
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 10
string
display_field(string $fieldname, $value = '', string $type = 'textbox')
Display field
in
FormTextbox at line 285
string
display_field_print(string $fieldname, string $default_value = false)
Display field in print mode
in
FormTextboxTrait at line 21
string
display_textbox_field(string $fieldname, bool $default_value = false, string $type = 'textbox')
No description
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
in
FormTextbox at line 294
mixed
save()
Save
in
FormBase at line 103
$this
set(string $name, mixed $value)
No description
in
FormTextbox at line 351
$this
setAutoTitle(string $title = '')
Set Auto Title attribute, usually visible when no data has been entered into the field This attribute is very similar to the placeholder attribute an may conflict if both are set.
It is advised to use the placeholder attribute as HTML5 standard
in
FormTextbox at line 486
FormTextbox
setAutocomplete(string $dataUrl = '', int $minChars = 2, string $afterUpdateElementJSFunction = '')
deprecated
deprecated
Set Autocomplete for this field
in
FormComponent at line 391
$this
setCSSClassName(string $class = null)
Set Field Row CSS class name
in
FormTextbox at line 373
$this
setCSSStyle(string $style = '')
Set Custom CSS Style
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
in
FormComponent at line 413
$this
setDescriptionText(string $description = null)
Set Field Help Text
in
FormTextbox at line 421
$this
setDisplayFilterNumeric(bool $displayAsMoney = false)
Format output to show as formatted numeric value.
This will be in the users locale, e.g. german users will see a COMMA (,) where english users will see a POINT (.)
in
FormTextbox at line 435
$this
setFormat(string $format = '')
deprecated
deprecated
Automatically format the default value using an call to the XELOS Format Helper
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
in
FormTextbox at line 408
$this
setInputFilter(string $inputFilter = self::INPUT_FILTER_NUMERIC)
Set input filter - a javascript input check. This may conflict with a HTML5 pattern attribute.
This will be in the users locale, e.g. german users will see a COMMA (,) where english users will see a POINT (.)
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
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
in
FormTextbox at line 316
$this
setMaxlength(int $length = null)
Set max chars for this field Array Syntax: maxlength
in
FormTextbox at line 457
$this
setOnChangeJS(string $jsfunction = '')
Set the onchange HTML attribute
in
FormTextbox at line 446
$this
setOnClickJS(string $jsfunction = '')
Set the onclick HTML attribute
in
FormTextbox at line 362
$this
setPlaceholder(string $title = '')
Set HTML5 Placeholder Attribute, usually visible when no data has been entered into the field
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
in
FormTextbox at line 327
$this
setShowCopyToClipboard(bool $bool = true)
Show Copy to Clipboard function next to this field?
in
FormTextbox at line 469
$this
setSubmitOnEnter(bool $bool = true)
Submit the form when the user presses enter? (Standard for POST forms, but not standard for GET forms) Useful if you are implementing a search form using GET request method
in
FormComponent at line 435
$this
setSuffixHTML(string $html = null)
Add Custom HTML after the field element
in
FormTextbox at line 338
$this
setTitle(string $title = '')
Set Title attribute, title is shown on hovering over the field
in
FormTextbox at line 385
$this
setValidationPattern(string $pattern = '', string $onInvalidMessage = null)
Set HTML5 REGEX Pattern Attribute, which will be used by browsers to validate user input
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
FormTextbox at line 26
bool|string
validate()
No description