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

HtmlGeneric

class HtmlGeneric extends UIComponent

enable link abilities

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
$exclude

Methods

__construct(array $param_array = array())

Constructor

__set(string $key, mixed $value)

setter for beeing able to collect all params setted by xTag for transfering to link object in render function

string
__toString()

No description

from  UIComponent
HtmlGeneric
addAttribute(string $key, string|null $value = null)

Add Attribute for this element

HtmlGeneric
appendContent(string $content)

Append content to be surrounded by tags

mixed
get($var)

Get Variable / Option

from  UIComponent
string|null
getAttribute(string $key)

Get Attribute previously set for this element

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
HtmlGeneric
prependContent(string $content)

Prepend content to be surrounded by tags

process()

Declared in Classes

from  UIComponent
render()

Render XUI Object

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) deprecated

Set Variable / Option

from  UIComponent
HtmlGeneric
setContent(string $content)

Set content to be surrounded by tags

HtmlGeneric
setTag(string $tag)

Declare tag for element

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

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

Details

at line 35
__construct(array $param_array = array())

Constructor

Parameters

array $param_array

Param Array

at line 61
__set(string $key, mixed $value)

setter for beeing able to collect all params setted by xTag for transfering to link object in render function

Parameters

string $key
mixed $value

in UIComponent at line 328
string __toString()

No description

Return Value

string

at line 138
HtmlGeneric addAttribute(string $key, string|null $value = null)

Add Attribute for this element

Parameters

string $key

e.g. title
string|null $value

e.g. this is my title

Return Value

HtmlGeneric

at line 113
HtmlGeneric appendContent(string $content)

Append content to be surrounded by tags

Parameters

string $content

Return Value

HtmlGeneric

in UIComponent at line 187
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 154
string|null getAttribute(string $key)

Get Attribute previously set for this element

Parameters

string $key

Return Value

string|null

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

at line 125
HtmlGeneric prependContent(string $content)

Prepend content to be surrounded by tags

Parameters

string $content

Return Value

HtmlGeneric

in UIComponent at line 339
process()

Declared in Classes

at line 77
render()

Render XUI Object

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

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 101
HtmlGeneric setContent(string $content)

Set content to be surrounded by tags

Parameters

string $content

Return Value

HtmlGeneric

at line 89
HtmlGeneric setTag(string $tag)

Declare tag for element

Parameters

string $tag

e.g. div

Return Value

HtmlGeneric

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