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

__construct()

FormBase constructor.

from  FormBase
append(string $name, mixed $value, bool|string $key = false)

No description

from  FormBase
void
concat(string $name, string $value)

No description

from  FormBase
mixed
destroy($name)

No description

from  FormBase
string
display_field(string $fieldname, $value = '', string $type = 'textbox')

Display field

string
display_field_print(string $fieldname, string $default_value = false)

Display field in print mode

string
display_textbox_field(string $fieldname, bool $default_value = false, string $type = 'textbox')

No description

mixed
get(string $name)

No description

from  FormBase
array
getConfig()

No description

from  FormBase
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

string
getElementVisibilityClass()

Get Element Visibility Class Formerly known as tag class

bool
getIsVisible()

Determine visibilty based on user input on dependent fields

string
get_description()

No description

mixed
get_display_value()

returns the displayed value

array
get_group(string $prefix)

No description

from  FormBase
string
get_help_tooltip_icon()

No description

array
get_properties()

No description

from  FormBase
array|bool
get_validation_options()

No description

get_value()

No description

bool
hasCombinedInputFields()

Does this component use combined input fields which required special handling from form?

init_obj()

Initializes the form base

from  FormBase
$this
insertAfter(FormComponent $formComponent = null)

Insert this field after the specified field

$this
insertBefore(FormComponent $formComponent = null)

Insert this field before the specified field

bool
isReadonly()

Returns TRUE if field is readonly, FALSE otherwise.

bool
is_displayed()

Checks if the field is hidden by a tag. It is important when validating

from  FormBase
void
post_process()

No description

void
process()

Process e.g. file upload, resize etc.

string
render(string|false $name = false, string|false $value = false)

No description

mixed
save()

Save

$this
set(string $name, mixed $value)

No description

from  FormBase
$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.

setAutocomplete(string $dataUrl = '', int $minChars = 2, string $afterUpdateElementJSFunction = '') deprecated

Set Autocomplete for this field

$this
setCSSClassName(string $class = null)

Set Field Row CSS class name

$this
setCSSStyle(string $style = '')

Set Custom CSS Style

$this
setCustomErrorText(string $error_msg)

Show Custom Error Message for this field

$this
setDefaultValue(mixed $value = null)

Set Field default value

$this
setDescriptionText(string $description = null)

Set Field Help Text

$this
setDisplayFilterNumeric(bool $displayAsMoney = false)

Format output to show as formatted numeric value.

$this
setFormat(string $format = '') deprecated

Automatically format the default value using an call to the XELOS Format Helper

$this
setGridClass(string $gridClass = null)

Set Flexbox Grid Class

$this
setHelpText(string $help = null)

Set Field Help Text

$this
setInputFilter(string $inputFilter = self::INPUT_FILTER_NUMERIC)

Set input filter - a javascript input check. This may conflict with a HTML5 pattern attribute.

$this
setIsDBField(bool $bool = true)

Field is to be loaded from and saved to database.

$this
setIsI18NField(bool $bool = true)

Field is considered to be translatable. This is usually determined automatically reading the instance configuration of the calling instance

$this
setIsReadonly(bool $bool = true)

Consider Field as readonly

$this
setIsRequired(bool $bool = true, bool $onlyRequiredIfVisible = true)

Consider Field as required

$this
setLabel(string $label = '', string $icon_class = '', int $width_in_px = null)

Set Field label

$this
setMaxlength(int $length = null)

Set max chars for this field Array Syntax: maxlength

$this
setOnChangeJS(string $jsfunction = '')

Set the onchange HTML attribute

$this
setOnClickJS(string $jsfunction = '')

Set the onclick HTML attribute

$this
setPlaceholder(string $title = '')

Set HTML5 Placeholder Attribute, usually visible when no data has been entered into the field

$this
setPopulateField(FormComponent $target, string $dataURL = null)

Manipulate another fields data when the value of the current field changes.

$this
setPrefixHTML(string $html = null)

Add Custom HTML before the field element

$this
setShowCopyToClipboard(bool $bool = true)

Show Copy to Clipboard function next to this field?

$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

$this
setSuffixHTML(string $html = null)

Add Custom HTML after the field element

$this
setTitle(string $title = '')

Set Title attribute, title is shown on hovering over the field

$this
setValidationPattern(string $pattern = '', string $onInvalidMessage = null)

Set HTML5 REGEX Pattern Attribute, which will be used by browsers to validate user input

$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

$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

set_display_value(mixed $value)

set the displayed value

void
set_properties(array $array)

No description

from  FormBase
set_request_vars($request)

No description

bool|string
validate()

No description

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

Parameters

string $name

property name

mixed $value

property value

bool|string $key

key of property array

in FormBase at line 185
void concat(string $name, string $value)

No description

Parameters

string $name

of the property

string $value

to be concated

Return Value

void

in FormBase at line 170
mixed destroy($name)

No description

Parameters

$name

Return Value

mixed

last value

at line 10
string display_field(string $fieldname, $value = '', string $type = 'textbox')

Display field

Parameters

string $fieldname
$value
string $type

Return Value

string

in FormTextbox at line 285
string display_field_print(string $fieldname, string $default_value = false)

Display field in print mode

Parameters

string $fieldname
string $default_value

Return Value

string

in FormTextboxTrait at line 21
string display_textbox_field(string $fieldname, bool $default_value = false, string $type = 'textbox')

No description

Parameters

string $fieldname
bool $default_value
string $type

Return Value

string

in FormBase at line 76
mixed get(string $name)

No description

Parameters

string $name

name of the property

Return Value

mixed

in FormBase at line 83
array getConfig()

No description

Return Value

array

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

Return Value

string

Exceptions

Exception

in FormComponent at line 595
protected string getElementVisibilityClass()

Get Element Visibility Class Formerly known as tag class

Return Value

string

in FormComponent at line 496
bool getIsVisible()

Determine visibilty based on user input on dependent fields

Return Value

bool

True if considered visible

in FormComponent at line 168
string get_description()

No description

Return Value

string

html or false if no description is set

in FormComponent at line 274
mixed get_display_value()

returns the displayed value

Return Value

mixed

value

in FormBase at line 219
array get_group(string $prefix)

No description

Parameters

string $prefix

prefix (e.g. mygroup_ )

Return Value

array

in FormComponent at line 149
string get_help_tooltip_icon()

No description

Return Value

string

html or false if no help is set

in FormBase at line 91
array get_properties()

No description

Return Value

array

in FormComponent at line 47
array|bool get_validation_options()

No description

Return Value

array|bool

validation options, false on failure

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?

Return Value

bool

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

Parameters

FormComponent $formComponent

Return Value

$this

in FormComponent at line 529
$this insertBefore(FormComponent $formComponent = null)

Insert this field before the specified field

Parameters

FormComponent $formComponent

Return Value

$this

in FormComponent at line 369
bool isReadonly()

Returns TRUE if field is readonly, FALSE otherwise.

Return Value

bool

in FormBase at line 239
bool is_displayed()

Checks if the field is hidden by a tag. It is important when validating

Return Value

bool

in FormComponent at line 257
void post_process()

No description

Return Value

void

in FormComponent at line 181
void process()

Process e.g. file upload, resize etc.

Return Value

void

in FormComponent at line 198
string render(string|false $name = false, string|false $value = false)

No description

Parameters

string|false $name
string|false $value

Return Value

string

in FormTextbox at line 294
mixed save()

Save

Return Value

mixed

in FormBase at line 103
$this set(string $name, mixed $value)

No description

Parameters

string $name

propoerty name

mixed $value

property value

Return Value

$this

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

Parameters

string $title

Return Value

$this

in FormTextbox at line 486
FormTextbox setAutocomplete(string $dataUrl = '', int $minChars = 2, string $afterUpdateElementJSFunction = '') deprecated

deprecated It is advised to use a Textbox List field instead of using the autocomplete function

Set Autocomplete for this field

Parameters

string $dataUrl

Where do we get field suggestions? The data URL is expected to return an UL LI List

int $minChars

After how many characters input is the autocomplete triggered?

string $afterUpdateElementJSFunction

JS Callback to be triggered when the user has chosen an element from the autocomplete suggestion

Return Value

FormTextbox

in FormComponent at line 391
$this setCSSClassName(string $class = null)

Set Field Row CSS class name

Parameters

string $class

e.g. hide_label, error

Return Value

$this

in FormTextbox at line 373
$this setCSSStyle(string $style = '')

Set Custom CSS Style

Parameters

string $style

e.g. width:100px;

Return Value

$this

in FormComponent at line 559
$this setCustomErrorText(string $error_msg)

Show Custom Error Message for this field

Parameters

string $error_msg

Return Value

$this

in FormComponent at line 380
$this setDefaultValue(mixed $value = null)

Set Field default value

Parameters

mixed $value

Return Value

$this

in FormComponent at line 413
$this setDescriptionText(string $description = null)

Set Field Help Text

Parameters

string $description

String to help people understand this fields value and options

Return Value

$this

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 (.)

Parameters

bool $displayAsMoney

Consider value as money? (2 decimals)

Return Value

$this

in FormTextbox at line 435
$this setFormat(string $format = '') deprecated

deprecated Does not make sense for most cases as the output is usually HTML and not a proper value for an input

Automatically format the default value using an call to the XELOS Format Helper

Parameters

string $format

e.g. money, percent, filesize

Return Value

$this

See also

Format::multi_format

in FormComponent at line 573
$this setGridClass(string $gridClass = null)

Set Flexbox Grid Class

Parameters

string $gridClass

Example: xcol-6_md-12

Return Value

$this

in FormComponent at line 402
$this setHelpText(string $help = null)

Set Field Help Text

Parameters

string $help

String to help people fill out your form

Return Value

$this

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 (.)

Parameters

string $inputFilter

Return Value

$this

in FormComponent at line 336
$this setIsDBField(bool $bool = true)

Field is to be loaded from and saved to database.

Parameters

bool $bool

Return Value

$this

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

Parameters

bool $bool

Return Value

$this

in FormComponent at line 360
$this setIsReadonly(bool $bool = true)

Consider Field as readonly

Parameters

bool $bool

Return Value

$this

in FormComponent at line 325
$this setIsRequired(bool $bool = true, bool $onlyRequiredIfVisible = true)

Consider Field as required

Parameters

bool $bool
bool $onlyRequiredIfVisible

If field is used with dependent visibility we consider the field only required when the field was visible to the user

Return Value

$this

in FormComponent at line 311
$this setLabel(string $label = '', string $icon_class = '', int $width_in_px = null)

Set Field label

Parameters

string $label
string $icon_class

CSS Icon class, e.g. icon-time

int $width_in_px

Return Value

$this

in FormTextbox at line 316
$this setMaxlength(int $length = null)

Set max chars for this field Array Syntax: maxlength

Parameters

int $length

Return Value

$this

in FormTextbox at line 457
$this setOnChangeJS(string $jsfunction = '')

Set the onchange HTML attribute

Parameters

string $jsfunction

Return Value

$this

in FormTextbox at line 446
$this setOnClickJS(string $jsfunction = '')

Set the onclick HTML attribute

Parameters

string $jsfunction

Return Value

$this

in FormTextbox at line 362
$this setPlaceholder(string $title = '')

Set HTML5 Placeholder Attribute, usually visible when no data has been entered into the field

Parameters

string $title

Return Value

$this

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

Parameters

FormComponent $target
string $dataURL

Return Value

$this

in FormComponent at line 424
$this setPrefixHTML(string $html = null)

Add Custom HTML before the field element

Parameters

string $html

e.g. 'http:// '

Return Value

$this

in FormTextbox at line 327
$this setShowCopyToClipboard(bool $bool = true)

Show Copy to Clipboard function next to this field?

Parameters

bool $bool

Return Value

$this

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

Parameters

bool $bool

Return Value

$this

in FormComponent at line 435
$this setSuffixHTML(string $html = null)

Add Custom HTML after the field element

Parameters

string $html

e.g. ' hours'

Return Value

$this

in FormTextbox at line 338
$this setTitle(string $title = '')

Set Title attribute, title is shown on hovering over the field

Parameters

string $title

Return Value

$this

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

Parameters

string $pattern

REGEX Pattern e.g. [0-9]{5} for german zip code

string $onInvalidMessage

Text displayed if validation fails, e.g. ZIP Code should be 5 numbers

Return Value

$this

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

Parameters

FormComponent $formComponent

Null will reset and remove all existing dependencies

array $matchingValues

Field will be shown/visible if the dependent field contains/has one of the values specified

Return Value

$this

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

Parameters

bool $bool

Return Value

$this

in FormComponent at line 265
set_display_value(mixed $value)

set the displayed value

Parameters

mixed $value

value

in FormBase at line 155
void set_properties(array $array)

No description

Parameters

array $array

associated array like property=>value

Return Value

void

in FormComponent at line 31
set_request_vars($request)

No description

Parameters

$request

in FormTextbox at line 26
bool|string validate()

No description

Return Value

bool|string

True if data is considered valid. String for specific error message. Empty string will also evaluate as valid.