Template
abstract class Template
Class Template
Properties
| static array | $theme_set_config | Stores Theme configuration information |
|
| static protected int | $output_mode | ||
| string | $block_id | ||
| array | $data_blocks | ||
| array | $marker_sets | ||
| Controller | $mod | ||
| array | $html_blocks | ||
| mixed | $markers | ||
| protected array | $file_cache | ||
| protected string | $render_stage | ||
| protected bool | $render_stage_key | ||
| protected bool | $render_stage_block | ||
| protected int | $render_stage_ttl | ||
| protected int | $render_stage_force_render | ||
| protected array | $_prerendered | ||
| protected bool | $final_render_call | ||
| protected array[] | $auto_render_sub_blocks | ||
| protected mixed | $template_includes | ||
| protected string | $render_mode | ||
| protected | $previous_render_mode | ||
| $render_mode_block | |||
| protected | $_raw_markers | ||
| protected bool | $option_template_debug | ||
| protected | $last_xtag_if_value | ||
| protected | $last_parse_template |
Methods
Template constructor.
No description
No description
Parse the passed HTML source for xTags and render these xTags
Internal Render Function
No description
Add a template to the registry
No description
No description
No description
No description
No description
No description
No description
No description
No description
Convert String to XML Node
ENABLE Pre-Rendering for template parsing
Escape / Convert Template specific characters (###;{{{;}}})
No description
Returns a string with all active accessibility classes
No description
No description
Get Config Value of Custom Theme Config
No description
No description
No description
No description
No description
Calls the render() function recursively of the passed object and returns the content
Returns the debug output for the current template
No description
Returns the xtag registry
This function is used to fund
Initialize common basic template markers like wwwres folders, system name and settings
put your comment there.
Is the current render cycle the last cycle? (i.e. initiated from view)
Set the theme configuration (theme set config)
No description
Output the final HTML
No description
No description
No description
Generic Template Loader
No description
Callback used by template language replace
Evaluate the passed XML Source parse xTags
Enables a template to execute certain tasks before page is fully rendered (e.g. AJAX navigation)
Register custom xtag parser
Remove a block which in turn will not be rendered
No description
No description
Render Action Function on Template if exists
No description
No description
No description
No description
Check wether a render stage is already cached or not This allows controllers to save on processing time if certain fields are calculated for the template only You need to call this function AFTER getting a view
wrapper for beeing able to use the output_login_form as renderer
Render Meta Script Resources
Render CSS Resources
Pre-Render Templates
put your comment there.
xTag Controller, regisitered for namespace xt (xelos template)
Renders the passed XML Element to String and uses registered xTag Controllers if possible
No description
No description
No description
Set Marker
Set Output Mode
No description
Details
at line 171
__construct()
Template constructor.
at line 2741
__toString()
No description
at line 1530
static string
_parse_template_content(string $template_content, bool $block = false, bool $parseLangStrings = true, Template $to = null)
| internal | param parse $bool Language Token? |
No description
at line 1577
static string
_parse_template_content_markers(string $template_content, Template $to)
Parse for ###Markers###
at line 1619
static mixed
_parse_template_content_xtags(mixed $content, bool|Template $to = false)
Parse the passed HTML source for xTags and render these xTags
at line 975
protected bool|string
_render_array_block(mixed $array, mixed $key = false)
Internal Render Function
at line 655
void
add_renderer(string|array $auto_render_sub_block)
No description
at line 292
bool
add_template(string $name, string $path)
Add a template to the registry
at line 1210
void
append(string $marker, string $content, string $block = 'content')
No description
at line 1231
void
append_to_list(string $marker, string $content, string $block = 'content')
No description
at line 1164
Template
assign(mixed $marker, string $content = 'array_fill', string $block = 'content', int|bool $cache_ttl = false, string $cache_group = 'default')
No description
at line 2953
protected
assignMobileAppInfo()
No description
at line 3067
assign_js($options)
No description
at line 1188
Template
assign_xss()
| internal | param mixed $marker Marker ID or Model Object |
| internal | param string $content Content (Default assumes $marker to be an array) |
| internal | param string $block Block ID (e.g. content) |
| internal | param int $cache_ttl Cache TTL (in seconds) |
| internal | param string $cache_group Cache Group (e.g. userID, Group) |
No description
at line 615
final protected string|null
auto_render_block(string $block)
No description
at line 1561
static
cb_gettext($matches)
No description
at line 1104
bool
clear_marker_cache(string $marker = '', string $cache_group = '', string $block = 'content')
No description
at line 2608
static DOMNode
convert_to_xml(string $xml_source, array $errors = array())
Convert String to XML Node
at line 475
protected void
disable_render_stage()
deprecated
deprecated
DISABLE Pre-Rendering and resets staging params
at line 462
protected
enable_render_stage(string $render_stage = 'pre', string $cache_key = 'auto', int $ttl = 3600, string $block_id = 'content')
deprecated
deprecated
ENABLE Pre-Rendering for template parsing
at line 3063
string
format_template_specialchars(string $text)
Escape / Convert Template specific characters (###;{{{;}}})
at line 1317
string
generateTemplateCacheKey(string $template_file, string $section, string|null $render_stage = null, string|null $cache_key = null)
No description
at line 3121
string
getAccessibilityClasses()
Returns a string with all active accessibility classes
at line 3145
protected
getExpertConfig($themeConfig = [])
No description
at line 3104
string
getFileCacheContent(string $tpl, string $section)
No description
at line 246
static mixed
get_config(string $var)
Get Config Value of Custom Theme Config
at line 1069
array
get_marker_block(string $block)
No description
at line 755
protected
get_marker_content(string $block, string $marker, bool $render_objects = false, $params = false)
No description
at line 603
get_output_mode()
No description
at line 680
array
get_render_blocks()
No description
at line 576
mixed
get_render_mode(bool $changes_only = false, bool $previous_mode = false)
No description
at line 693
protected object|string
get_rendered_object(object $object, array $params = null)
Calls the render() function recursively of the passed object and returns the content
at line 354
string
get_template_debug()
Returns the debug output for the current template
at line 2633
get_xtag_marker_value($params, $is_indexed = false, $clean_params = false, $escape_markers = true)
No description
at line 193
static array
get_xtag_registry()
Returns the xtag registry
at line 2105
array
handle_custom_namespace(mixed $ns, int $k, mixed $name)
This function is used to fund
at line 2976
Template
initBaseTemplate()
Initialize common basic template markers like wwwres folders, system name and settings
at line 340
init_template_vars()
put your comment there.
..
at line 432
bool
is_final_render_call()
Is the current render cycle the last cycle? (i.e. initiated from view)
at line 209
load_theme_set_config()
Set the theme configuration (theme set config)
at line 1082
bool
marker_is_cached(string $marker, string $cache_group = 'default', string $block = 'content')
No description
at line 202
string
output_html()
Output the final HTML
at line 2863
string
output_login_form()
No description
at line 3004
string
output_pw_change_form()
No description
at line 1268
protected string
parse_partial_template(string $template, string $section, $values)
No description
at line 1345
mixed
parse_template(string $template, string|bool $section = false, string|bool $block_id = false, string|bool $recursive = false)
Generic Template Loader
at line 1509
string
parse_template_content($template_content, bool $block = false, bool $parseLangStrings = true, bool $to = false)
No description
at line 1476
string
parse_template_translate_cb(array $matches)
Callback used by template language replace
at line 1638
mixed|string
parse_xtag(array $xml_source)
Evaluate the passed XML Source parse xTags
at line 309
mixed
pre_render_action(string $page, array $args = array())
Enables a template to execute certain tasks before page is fully rendered (e.g. AJAX navigation)
at line 181
register_xtag_parser(string $module_name, bool|array $callback = false)
Register custom xtag parser
at line 668
removeRenderer($block)
Remove a block which in turn will not be rendered
at line 2734
string
render()
No description
at line 2989
void
renderMultiFactorAuthenticationForm()
No description
at line 327
mixed
render_action(mixed $page, array $args = array())
Render Action Function on Template if exists
at line 948
protected string
render_array_block(mixed $array, string|bool $key = false)
No description
at line 2725
final string
render_content_marker()
No description
at line 2792
protected string
render_error()
No description
at line 490
string
render_html(bool $final_render_call = false)
No description
at line 1295
bool
render_is_prepared(mixed $template, mixed $section = 'false', mixed $render_stage = 'pre', mixed $cache_key = null)
deprecated
deprecated
Check wether a render stage is already cached or not This allows controllers to save on processing time if certain fields are calculated for the template only You need to call this function AFTER getting a view
at line 2854
string
render_login()
wrapper for beeing able to use the output_login_form as renderer
at line 259
string
render_meta_script_resources()
Render Meta Script Resources
at line 273
string
render_meta_style_resources()
Render CSS Resources
at line 445
render_prepare(string $render_stage = 'pre', string $cache_key = 'global', int $ttl = 3600, string $block_id = 'content')
deprecated
deprecated
Pre-Render Templates
at line 2844
string
render_system_flash_message()
put your comment there.
..
at line 2149
string
render_xtag(string $tag, array $params)
xTag Controller, regisitered for namespace xt (xelos template)
at line 1734
string
render_xtag_element(DOMNode $dom_node, bool $render_only_childs = false, bool $special_child_handling_overwrite = false)
Renders the passed XML Element to String and uses registered xTag Controllers if possible
at line 1248
mixed
retrieve(string $marker, string $block = 'content', bool $clean_params = false)
No description
at line 3113
void
setFileCacheContent(string $tpl, string $section, string $content = null)
No description
at line 1565
set_block_id($block_id)
No description
at line 1126
void
set_marker_content(string $block, mixed $marker, string $content = 'array_fill', int|bool $cache_ttl = false, string $cache_group = 'default')
Set Marker
at line 599
set_output_mode(int $flags = 0)
Set Output Mode
at line 546
void
set_render_mode(string $mode = 'full', string $block = 'content')
No description