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

Import

class Import extends UIComponent

Constants

SYSTEM_TEMPLATE_UI_FOLDER

Properties

$xf_link from  UIComponent
$link_id from  UIComponent
array $GPvars from  UIComponent
Controller $mod from  UIComponent
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
bool $group_fields
array $options

Methods

__construct(mixed $name)

No description

string
__toString()

No description

from  UIComponent
add_field(string $name, string $caption, array $options = array())

No description

clear_tmp_data(mixed $user_config_name)

Clear temp data

mixed
get($var)

Get Variable / Option

from  UIComponent
int
get_stepping()

No description

get_tmp_data($user_config_name)

get temp data

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
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
void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

from  UIComponent
set_fdl(mixed $fdl)

Additional FDL (Additional Form for step1)

set_import_mode(string $mode)

No description

set_incremental(bool $incremental)

If $this->incremental is set to true, $this->stepping rows will be handled before each redirect to prevent timeouts in time-intensive imports

set_init_handler(array $init_handler)

This callback is before step 1 is executed.

set_key_field($name)

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_save_handler($function)

No description

set_stepping(int $stepping)

No description

store_tmp_data($user_config_name, $data)

Store temporary to session

Details

at line 85
__construct(mixed $name)

No description

Parameters

mixed $name

in UIComponent at line 324
string __toString()

No description

Return Value

string

at line 100
add_field(string $name, string $caption, array $options = array())

No description

Parameters

string $name

Unique Name (used to identify field)
string $caption

Field Caption (Displayed to User)
array $options

at line 270
clear_tmp_data(mixed $user_config_name)

Clear temp data

Parameters

mixed $user_config_name

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 61
int get_stepping()

No description

Return Value

int

See also

set_incremental()

at line 289
get_tmp_data($user_config_name)

get temp data

Parameters

$user_config_name

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

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 161
render()

No description

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

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 115
set_fdl(mixed $fdl)

Additional FDL (Additional Form for step1)

Parameters

mixed $fdl

at line 138
set_import_mode(string $mode)

No description

Parameters

string $mode

Import Mode (update, insert, update_insert)

at line 53
set_incremental(bool $incremental)

If $this->incremental is set to true, $this->stepping rows will be handled before each redirect to prevent timeouts in time-intensive imports

Parameters

bool $incremental

at line 79
set_init_handler(array $init_handler)

This callback is before step 1 is executed.

$this is passed to allow access to settings and methods of the executing xui_import.

Parameters

array $init_handler

at line 153
set_key_field($name)

No description

Parameters

$name

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

at line 129
set_save_handler($function)

No description

Parameters

$function

at line 69
set_stepping(int $stepping)

No description

Parameters

int $stepping

See also

set_incremental()

at line 247
store_tmp_data($user_config_name, $data)

Store temporary to session

Parameters

$user_config_name
$data