class Tabs 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 $_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 $uid
string read-only $_content

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

from  UIComponent
protected $xtag_params

Methods

__construct($uid = false)

UIComponent constructor.

string
__toString()

No description

void
add_tab(string $label, string|bool $content = false, bool $selected = false)

No description

int
add_tab_link(array $link, bool $selected = false)

No description

add_tab_links(array $links, string $selected = null)

No description

mixed
get($var)

Get Variable / Option

array
get_tab_links()

No description

string
get_unique_dom_id()

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

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

init()

put your comment there.

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

No description

string|null
parse_template_cb_wrapper(mixed $matches)

No description

mixed|string
parse_xtag($xml_source)

No description

process()

Declared in Classes

render($params = false)

No description

mixed
render_xtag_element()

No description

void
reset_marker_content()

restores original content of marker_content

select_tab(int $tab_id)

No description

void
set(mixed $var, mixed $value = false) deprecated

Set Variable / Option

setHideHeading(bool $hideHeading = true)

No description

setIsCollapsible(bool $isCollapsible = true)

No description

setStartCollapsed(bool $startCollapsed = true)

No description

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

void
set_marker_content(mixed $marker_content = false)

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

set_mod(mixed $mod)

Set link to owning module

void
set_render_params(mixed $input_params = array())

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

set_tabstyle(string $style = 'normal')

Set Tabs to be positioned differently

set_uid($uid)

No description

Details

at line 51
__construct($uid = false)

UIComponent constructor.

Parameters

$uid

in UIComponent at line 328
string __toString()

No description

Return Value

string

at line 72
void add_tab(string $label, string|bool $content = false, bool $selected = false)

No description

Parameters

string $label Label
string|bool $content Content
bool $selected

Is the Tab selected?

Return Value

void

No description

Parameters

array $link

LinkHelper Array

bool $selected

is this tab selected?

Return Value

int

No description

Parameters

array $links

LinkHelper Arrays

string $selected

Key of the selected item

in UIComponent at line 187
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

No description

Return Value

array links

in UIComponent at line 204
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 294
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 223
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 239
string|null parse_template_cb_wrapper(mixed $matches)

No description

Parameters

mixed $matches

Return Value

string|null

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

No description

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

in UIComponent at line 339
process()

Declared in Classes

at line 192
render($params = false)

No description

Parameters

$params

in UIComponent at line 273
mixed render_xtag_element()

No description

Return Value

mixed

in UIComponent at line 175
void reset_marker_content()

restores original content of marker_content

Return Value

void

at line 139
select_tab(int $tab_id)

No description

Parameters

int $tab_id

Index ID, e.g. 1 = first Tag, 2 = second Tab

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

deprecated - It is preferred to have explicit setters/getters. Please check if you can rewrite usage to use explicit setters with documented options

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 173
Tabs setHideHeading(bool $hideHeading = true)

No description

Parameters

bool $hideHeading

Return Value

Tabs

at line 178
Tabs setIsCollapsible(bool $isCollapsible = true)

No description

Parameters

bool $isCollapsible

Return Value

Tabs

at line 183
Tabs setStartCollapsed(bool $startCollapsed = true)

No description

Parameters

bool $startCollapsed

Return Value

Tabs

in UIComponent at line 124
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

in UIComponent at line 167
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 137
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 85
set_tabstyle(string $style = 'normal')

Set Tabs to be positioned differently

Parameters

string $style

(normal, left, right)

at line 61
set_uid($uid)

No description

Parameters

$uid