VarsTemplate
class VarsTemplate extends Template
Properties
static array | $theme_set_config | Stores Theme configuration information |
from Template |
static protected int | $output_mode | from Template | |
string | $block_id | from Template | |
array | $data_blocks | from Template | |
$marker_sets | |||
Controller | $mod | if called via Controller::get_vars() current instance is referenced |
|
array | $html_blocks | from Template | |
mixed | $markers | from Template | |
protected array | $file_cache | from Template | |
protected string | $render_stage | from Template | |
protected bool | $render_stage_key | from Template | |
protected bool | $render_stage_block | from Template | |
protected int | $render_stage_ttl | from Template | |
protected int | $render_stage_force_render | from Template | |
protected array | $_prerendered | from Template | |
protected bool | $final_render_call | from Template | |
protected array[] | $auto_render_sub_blocks | from Template | |
protected mixed | $template_includes | from Template | |
protected string | $render_mode | from Template | |
protected | $previous_render_mode | from Template | |
$render_mode_block | from Template | ||
protected | $_raw_markers | from Template | |
protected bool | $option_template_debug | from Template | |
protected | $last_xtag_if_value | from Template | |
protected | $last_parse_template | from Template | |
int | $id | ||
string | $template_file: | stored in MySQL as varchar |
|
string | $language: | stored in MySQL as char |
|
string | $culture: | stored in MySQL as char |
|
bool | $custom: | stored in MySQL as tinyint |
|
string | $instance_id: | stored in MySQL as varchar |
|
string | $module_name: | stored in MySQL as varchar |
|
string | $template: | stored in MySQL as mediumtext |
|
string | $hash: | stored in MySQL as binary |
|
int | $editor_id | ||
int | $created_at: | stored in MySQL as timestamp |
|
int | $updated_at: | stored in MySQL as timestamp |
|
string | $title | Extract from the XML template |
|
string|bool | $loaded_from | string db|file or false if could not be loaded |
|
bool | $is_custom |
Methods
Vars constructor
No description
No description
No description
Parse the passed HTML source for xTags and render these xTags
Internal Render Function
Add xml definition and html,head and body tags around the given xml_source
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
Get Block Attribute
No description
get an array with all existing blocks
No description
No description
No description
Calls the render() function recursively of the passed object and returns the content
Get XML Document as string
No description
This function is used to fund
No description
Is the current render cycle the last cycle? (i.e. initiated from view)
No description
No description
Generic Template Loader
No description
Callback used by template language replace
Enables a template to execute certain tasks before page is fully rendered (e.g. AJAX navigation)
Register custom xtag parser
Render Vars Template
Render Action Function on Template if exists
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
Pre-Render Templates
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
No description
Will set the content of an
Set Marker
Details
at line 74
__construct(string $source, bool $language = false, bool $culture = false, mixed $custom_allowed = null, bool $source_is_text = false)
Vars constructor
at line 223
mixed
__get(mixed $var)
No description
at line 229
__toString()
No description
in
Template at line 1512
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
in
Template at line 1559
static string
_parse_template_content_markers(string $template_content, Template $to)
Parse for ###Markers###
in
Template at line 1601
static mixed
_parse_template_content_xtags(mixed $content, bool|Template $to = false)
Parse the passed HTML source for xTags and render these xTags
in
Template at line 958
protected bool|string
_render_array_block(mixed $array, mixed $key = false)
Internal Render Function
in
Template at line 638
void
add_renderer(string|array $auto_render_sub_block)
No description
in
Template at line 278
bool
add_template(string $name, string $path)
Add a template to the registry
at line 302
string
add_xml_wrapper(string $xml_source)
Add xml definition and html,head and body tags around the given xml_source
in
Template at line 1193
void
append(string $marker, string $content, string $block = 'content')
No description
in
Template at line 1214
void
append_to_list(string $marker, string $content, string $block = 'content')
No description
in
Template at line 1147
Template
assign(mixed $marker, string $content = 'array_fill', string $block = 'content', int|bool $cache_ttl = false, string $cache_group = 'default')
No description
in
Template at line 3145
assign_js($options)
No description
in
Template at line 1171
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
in
Template at line 598
final protected string|null
auto_render_block(string $block)
No description
in
Template at line 1543
static
cb_gettext($matches)
No description
in
Template at line 1087
bool
clear_marker_cache(string $marker = '', string $cache_group = '', string $block = 'content')
No description
in
Template at line 2580
static DOMNode
convert_to_xml(string $xml_source, array $errors = array())
Convert String to XML Node
in
Template at line 458
protected void
disable_render_stage()
DISABLE Pre-Rendering and resets staging params
in
Template at line 446
protected
enable_render_stage(string $render_stage = 'pre', string $cache_key = 'auto', int $ttl = 3600, string $block_id = 'content')
ENABLE Pre-Rendering for template parsing
in
Template at line 3141
string
format_template_specialchars(string $text)
Escape / Convert Template specific characters (###;{{{;}}})
in
Template at line 1299
string
generateTemplateCacheKey(string $template_file, string $section, string|null $render_stage = null, string|null $cache_key = null)
No description
in
Template at line 3184
string
getFileCacheContent(string $tpl, string $section)
No description
at line 148
array|string
get_block_attribute(string $block_name, string|bool $attribute_name = false)
Get Block Attribute
at line 323
get_block_xml($block_name)
No description
at line 156
get_blocks()
get an array with all existing blocks
in
Template at line 232
static mixed
get_config(string $var)
Get Config Value of Custom Theme Config
in
Template at line 1052
array
get_marker_block(string $block)
No description
in
Template at line 738
protected
get_marker_content(string $block, string $marker, bool $render_objects = false, $params = false)
No description
in
Template at line 586
get_output_mode()
No description
at line 203
get_property($name)
No description
in
Template at line 663
array
get_render_blocks()
No description
in
Template at line 559
mixed
get_render_mode(bool $changes_only = false, bool $previous_mode = false)
No description
in
Template at line 676
protected object|string
get_rendered_object(object $object, array $params = null)
Calls the render() function recursively of the passed object and returns the content
in
Template at line 340
string
get_template_debug()
Returns the debug output for the current template
at line 164
string
get_xml()
Get XML Document as string
in
Template at line 2605
get_xtag_marker_value($params, $is_indexed = false, $clean_params = false, $escape_markers = true)
No description
in
Template at line 179
static array
get_xtag_registry()
Returns the xtag registry
in
Template at line 2085
array
handle_custom_namespace(mixed $ns, int $k, mixed $name)
This function is used to fund
at line 106
init()
No description
in
Template at line 326
init_template_vars()
put your comment there.
..
in
Template at line 418
bool
is_final_render_call()
Is the current render cycle the last cycle? (i.e. initiated from view)
in
Template at line 195
load_theme_set_config()
Set the theme configuration (theme set config)
in
Template at line 1065
bool
marker_is_cached(string $marker, string $cache_group = 'default', string $block = 'content')
No description
in
Template at line 188
string
output_html()
Output the final HTML
in
Template at line 2835
string
output_login_form()
No description
in
Template at line 3090
string
output_pw_change_form()
No description
in
Template at line 2931
string
output_two_factor_auth_form()
No description
in
Template at line 1251
protected string
parse_partial_template(string $template, string $section, $values)
No description
in
Template at line 1327
mixed
parse_template(string $template, string|bool $section = false, string|bool $block_id = false, string|bool $recursive = false)
Generic Template Loader
in
Template at line 1491
string
parse_template_content($template_content, bool $block = false, bool $parseLangStrings = true, bool $to = false)
No description
in
Template at line 1458
string
parse_template_translate_cb(array $matches)
Callback used by template language replace
in
Template at line 1620
mixed|string
parse_xtag(array $xml_source)
Evaluate the passed XML Source parse xTags
in
Template at line 295
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)
in
Template at line 167
register_xtag_parser(string $module_name, bool|array $callback = false)
Register custom xtag parser
in
Template at line 651
removeRenderer($block)
Remove a block which in turn will not be rendered
at line 191
string
render()
Render Vars Template
in
Template at line 313
mixed
render_action(mixed $page, array $args = array())
Render Action Function on Template if exists
in
Template at line 931
protected string
render_array_block(mixed $array, string|bool $key = false)
No description
in
Template at line 2697
final string
render_content_marker()
No description
in
Template at line 2764
protected string
render_error()
No description
in
Template at line 473
string
render_html(bool $final_render_call = false)
No description
in
Template at line 1277
bool
render_is_prepared(mixed $template, mixed $section = 'false', mixed $render_stage = 'pre', mixed $cache_key = null)
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
in
Template at line 2826
string
render_login()
wrapper for beeing able to use the output_login_form as renderer
in
Template at line 245
string
render_meta_script_resources()
Render Meta Script Resources
in
Template at line 259
string
render_meta_style_resources()
Render CSS Resources
in
Template at line 430
render_prepare(string $render_stage = 'pre', string $cache_key = 'global', int $ttl = 3600, string $block_id = 'content')
Pre-Render Templates
in
Template at line 2816
string
render_system_flash_message()
put your comment there.
..
in
Template at line 2129
string
render_xtag(string $tag, array $params)
xTag Controller, regisitered for namespace xt (xelos template)
in
Template at line 1716
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 311
replace_namespace($xml_source)
No description
at line 317
replace_namespace_reverse($xml_source)
No description
in
Template at line 1231
mixed
retrieve(string $marker, string $block = 'content', bool $clean_params = false)
No description
in
Template at line 3193
void
setFileCacheContent(string $tpl, string $section, string $content = null)
No description
in
Template at line 1547
set_block_id($block_id)
No description
at line 362
bool
set_block_xml(string $block_name, string $xml_source)
Will set the content of an
in
Template at line 1109
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 184
set_mod(Core $instance)
Set Instance Reference
in
Template at line 582
set_output_mode(int $flags = 0)
Set Output Mode
in
Template at line 529
void
set_render_mode(string $mode = 'full', string $block = 'content')
No description