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

Breadcrumb

class Breadcrumb 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 $_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
$last_level_clickable
$hide_links
protected $xtag_params

Methods

__construct(string $link_id = null)

UIComponent constructor.

from  UIComponent
string
__toString()

No description

from  UIComponent
int
add_level($main_link, $level_links = null)

No description

bool
add_link(int $level, array $link)

No description

eval_xtag_params()

put your comment there.

fill_by_table(int $current_id, string $link_format, string $table, bool|string $caption_field = false, bool|string $id_field = false, bool|string $pid_field = false, bool $uid_field = false)

No description

fill_by_tree(int $current_id, array $link_format, string $tree, bool $root_title = false)

No description

generate_default_navigation_breadcrumb(bool $show_current_level = false, bool $multilevel = false)

put your comment there.

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

in UIComponent at line 64
__construct(string $link_id = null)

UIComponent constructor.

Parameters

string $link_id

in UIComponent at line 324
string __toString()

No description

Return Value

string

at line 69
int add_level($main_link, $level_links = null)

No description

Parameters

$main_link
$level_links

Return Value

int

Current Level

No description

Parameters

int $level

Level 0 = Top/Front, 99 = Bottom/Last
array $link

Link-Array of the main link

Return Value

bool

success (returns false if no main link is present for this level)

at line 274
eval_xtag_params()

put your comment there.

..

at line 103
fill_by_table(int $current_id, string $link_format, string $table, bool|string $caption_field = false, bool|string $id_field = false, bool|string $pid_field = false, bool $uid_field = false)

No description

Parameters

int $current_id

Current Record ID
string $link_format

Tablename (use prepare_query() in XF instance context)
string $table

Name of the caption field (Default: caption)
bool|string $caption_field

ID Field (Default: id)
bool|string $id_field

Parent-ID Field (Default: pid)
bool|string $pid_field

Uniqe-ID can be set if you have a additional uniqid, different from the pid->id tree construct (Default: false)
bool $uid_field

at line 120
fill_by_tree(int $current_id, array $link_format, string $tree, bool $root_title = false)

No description

Parameters

int $current_id

Current Record ID
array $link_format

Link Array, the label will be set with filled with the caption
string $tree

Name of the caption field (Default: caption)
bool $root_title

at line 228
generate_default_navigation_breadcrumb(bool $show_current_level = false, bool $multilevel = false)

put your comment there.

..

Parameters

bool $show_current_level
bool $multilevel

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

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 154
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

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