TableEditor
class TableEditor extends UIComponent
Constants
SYSTEM_TEMPLATE_UI_FOLDER |
|
Properties
Link | $xf_link | from UIComponent | |
string | $link_id | from UIComponent | |
array | $GPvars | from UIComponent | |
Core | $mod | ||
protected array | $local_template_marker | from UIComponent | |
protected | $_overwrite_param_array | ||
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 |
$links | |||
protected | $params | customizable by xTags |
Methods
No description
No description
No description
No description
No description
No description
Get new Link (Action)
No description
No description
Generates a unique dom id, dependent on the provided UID, as well as the current context.
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
put your comment there.
No description
No description
No description
Use a model to automatically setup an CRUD Editor for this model
No description
Set Variable / Option for an array
set callbacks
set download handler (Where to download a file)
Adds/Changes a field definition
You can add a simple filter to allow the user to filter the overview table by a certain keyword.
set grouping
set join statement
set limit for Pagination
sets marker_content to passed data -> restore original content with reset_marker_content()
hide add link
hide delete link
hide edit link
set order field
set order field
No description
No description
set primary key column
No description
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
set web directory location (storage path)
set where statement
No description
No description
Details
at line 112
__construct(bool|string $sql_table = false, array|bool $fields = false, array|bool $params = false, bool $override = false, bool|string $table_id = false)
No description
in
UIComponent at line 324
string
__toString()
No description
at line 1349
add_multi_action($action, $linkParams = array('label' => 'LABEL'), $callback = array())
No description
at line 1153
bool
delete_record(int $primaryKeyValue)
No description
at line 1001
enable_model_sort()
No description
in
UIComponent at line 185
mixed
get($var)
Get Variable / Option
at line 363
string
get_action()
No description
at line 874
get_edit_link($primaryKeyValue)
No description
at line 894
Form
get_form(array|bool $fdl = false)
No description
at line 882
array
get_new_link()
Get new Link (Action)
at line 384
int
get_primary_key()
No description
at line 564
Table
get_table(string $sql_table = 'auto', array|string $fields = 'auto', string $primaryKey = 'auto')
No description
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.
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
at line 120
init()
put your comment there.
..
in
UIComponent at line 221
string
parse_template(string $template_content, array|bool $marker_array = false)
No description
in
UIComponent at line 234
string|null
parse_template_cb_wrapper(mixed $matches)
No description
in
UIComponent at line 260
mixed|string
parse_xtag($xml_source)
No description
at line 1017
process(bool|string $force_action = false)
No description
at line 1189
render()
No description
in
UIComponent at line 268
mixed
render_xtag_element()
No description
in
UIComponent at line 173
void
reset_marker_content()
restores original content of marker_content
in
UIComponent at line 106
void
set(mixed $var, mixed $value = false)
Set Variable / Option
at line 130
setFieldsFromModel(Model $model, array $fields = [], array $params = [])
Use a model to automatically setup an CRUD Editor for this model
at line 373
set_action(string $action)
No description
in
UIComponent at line 122
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
at line 530
set_callbacks(array $callbacks)
set callbacks
at line 550
set_download_handler(string $download_handler)
set download handler (Where to download a file)
at line 349
set_field_params(string $field_id, array $params, string $mode = 'merge')
Adds/Changes a field definition
at line 509
set_filter_fields(array $fields)
You can add a simple filter to allow the user to filter the overview table by a certain keyword.
To enable the filter set the filter_fields parameter to an array containing all fields which should be included in the filter search.
at line 445
set_grouping(string $column)
set grouping
at line 488
set_join(string $statement)
set join statement
at line 465
set_limit(mixed $count)
set limit for Pagination
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()
in
UIComponent at line 90
set_mod(mixed $mod)
Set link to owning module
at line 420
set_no_add_link()
hide add link
at line 428
set_no_delete_link()
hide delete link
at line 436
set_no_edit_link()
hide edit link
at line 455
set_order_field(string $column, string $order_direction = "ASC")
set order field
at line 477
set_order_fields(array $columns, string $order_direction = "ASC")
set order field
warning: requires set_order_field() first
at line 234
void
set_params(string $data_source, array $fields, array $params, bool $overwrite = false, string $unique_table_id = null)
No description
at line 398
set_primary_key(int $id = null)
No description
at line 412
set_primary_key_column(string $column)
set primary key column
at line 1345
set_record_label($label = 'record')
No description
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)
at line 541
set_web_dir(string $location)
set web directory location (storage path)
at line 498
set_where(string $statement)
set where statement
at line 820
array|string
table_editor_cb($primaryKeyValue, $actionParams, string $concat = ' ', bool $return_array = false)
No description
at line 858
array|string
table_model_sort_cb($primaryKeyValue, $actionParams, string $concat = ' ', bool $return_array = false)
No description