1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. UI
  9. \
  10. FormEditor

FormEditor

class FormEditor extends UIComponent

Documentation

Constants

SYSTEM_TEMPLATE_UI_FOLDER

Properties

$xf_link from  UIComponent
$link_id from  UIComponent
array $GPvars from  UIComponent
Core $mod
protected array $local_template_marker from  UIComponent
protected bool $_overwrite_param_array from  UIComponent
protected bool|array|ModelCollection $marker_content from  UIComponent
string $mod_object_manager from  UIComponent
protected bool $_orig_marker_content from  UIComponent
protected array $_allowed_params_filter from  UIComponent
string $unique_dom_id from  UIComponent
protected string $uid from  UIComponent
string read-only $_content

When used in template this property will contain the XML/HTML within the XUI Nodes

 from  UIComponent
$id
$field_name
$form_name

Methods

__construct(string $form_name, string $field_name = null)

No description

string
__toString()

No description

from  UIComponent
bool
add_field_item(string $type, array $config)

Add another field item

add_field_property(mixed $types, string $property_name, array $property_field_def)

Add custom properties to certain fields

change_field_spec(mixed $types, string $property_name, mixed $value)

Add custom properties to certain fields

disable_i18n_mode()

Disable i18n mode

mixed
get($var)

Get Variable / Option

from  UIComponent
string
get_unique_dom_id()

Generates a unique dom id, dependent on the provided UID, as well as the current context.

from  UIComponent
Template|null
get_view(string|bool $section = false)

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

from  UIComponent
hide_i18n_switcher()

No description

init()

put your comment there.

from  UIComponent
string
parse_template(string $template_content, array|bool $marker_array = false)

No description

from  UIComponent
string|null
parse_template_cb_wrapper(mixed $matches)

No description

from  UIComponent
mixed|string
parse_xtag($xml_source)

No description

from  UIComponent
process()

Declared in Classes

from  UIComponent
render()

No description

mixed
render_xtag_element()

No description

from  UIComponent
void
reset_marker_content()

restores original content of marker_content

from  UIComponent
void
set(mixed $var, mixed $value = false)

Set Variable / Option

from  UIComponent
set_allowed_field_types(array $types)

Set the allowed (selectable) field types

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

from  UIComponent
set_component_title($component_title)

No description

set_excluded_field_types(array $types)

Set the excluded (not selectable) field types

set_form(mixed $form)

No description

void
set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

from  UIComponent
set_mod(mixed $mod)

Set link to owning module

from  UIComponent
void
set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

from  UIComponent
set_show_export_link($show_export_link = true)

No description

set_show_preview_link($show_preview_link)

No description

set_workbench_title($workbench_title)

No description

Details

at line 75
__construct(string $form_name, string $field_name = null)

No description

Parameters

string $form_name

Form-Name where this editor is embedded in
string $field_name

Field-Name within your form

in UIComponent at line 324
string __toString()

No description

Return Value

string

at line 314
bool add_field_item(string $type, array $config)

Add another field item

Parameters

string $type

Type (hidden, textbox, textarea)
array $config

Config (title->, icon_class->'icon_input',config->array)

Return Value

bool

success

at line 282
add_field_property(mixed $types, string $property_name, array $property_field_def)

Add custom properties to certain fields

Parameters

mixed $types

Field type (e.g. textbox) as string OR multiple types as array OR * for all
string $property_name

Name of new property (e.g. show_it)
array $property_field_def

Array with field definition (XF FDL Form Format)

at line 299
change_field_spec(mixed $types, string $property_name, mixed $value)

Add custom properties to certain fields

Parameters

mixed $types

Field type (e.g. textbox) as string OR multiple types as array OR * for all
string $property_name

Name of the property (e.g. _show_default_value or _show_required)
mixed $value

Value for the property

at line 637
disable_i18n_mode()

Disable i18n mode

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

in UIComponent at line 202
string get_unique_dom_id()

Generates a unique dom id, dependent on the provided UID, as well as the current context.

Return Value

string

in UIComponent at line 289
Template|null get_view(string|bool $section = false)

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

Parameters

string|bool $section

Name

Return Value

Template|null

Exceptions

Exception

at line 40
hide_i18n_switcher()

No description

in UIComponent at line 72
init()

put your comment there.

..

in UIComponent at line 221
string parse_template(string $template_content, array|bool $marker_array = false)

No description

Parameters

string $template_content

HTML Template
array|bool $marker_array

Markers and Values

Return Value

string

Parsed HTML Content

in UIComponent at line 234
string|null parse_template_cb_wrapper(mixed $matches)

No description

Parameters

mixed $matches

Return Value

string|null

in UIComponent at line 260
mixed|string parse_xtag($xml_source)

No description

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

in UIComponent at line 335
process()

Declared in Classes

at line 329
render()

No description

Exceptions

ContentException

in UIComponent at line 268
mixed render_xtag_element()

No description

Return Value

mixed

in UIComponent at line 173
void reset_marker_content()

restores original content of marker_content

Return Value

void

in UIComponent at line 106
void set(mixed $var, mixed $value = false)

Set Variable / Option

Parameters

mixed $var

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)
mixed $value

Value of Variable

Return Value

void

at line 262
set_allowed_field_types(array $types)

Set the allowed (selectable) field types

Parameters

array $types

Containing fieldtypes, e.g. array('textbox', 'checkbox');

in UIComponent at line 122
void set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

Parameters

mixed $member_array

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)
mixed $vars

Value of Variable

Return Value

void

at line 50
set_component_title($component_title)

No description

Parameters

$component_title

at line 271
set_excluded_field_types(array $types)

Set the excluded (not selectable) field types

Parameters

array $types

Containing fieldtypes, e.g. array('textbox', 'checkbox');

at line 250
set_form(mixed $form)

No description

Parameters

mixed $form

Form in JSON syntax or ARRAY

in UIComponent at line 165
void set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

Parameters

mixed $marker_content

Return Value

void

in UIComponent at line 90
set_mod(mixed $mod)

Set link to owning module

Parameters

mixed $mod

in UIComponent at line 135
void set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

Parameters

mixed $input_params

Return Value

void

No description

Parameters

$show_export_link

No description

Parameters

$show_preview_link

at line 45
set_workbench_title($workbench_title)

No description

Parameters

$workbench_title