\template

Summary

Methods
Properties
Constants
__get()
__isset()
__dependencies()
__shortcuts()
__destruct()
__construct()
save_state()
load_state()
get_templatedata()
set_templateout()
get_templateout()
set_template()
add_js()
js_file()
staticHTML()
add_meta()
css_file()
add_css()
add_listener()
combine_css()
debug_css_files()
resolve_css_file()
combine_js()
cleanup_combined()
add_rssfeed()
set_filenames()
fullpath_filename()
resolve_templatefile()
get_combined_css()
get_header_js()
get_footer_js()
display()
assign_array()
assign_vars()
assign_var()
assign_block_vars()
compileString()
handleModifier()
delete_cache()
add_common_cssfiles()
generate_error()
get_error_details()
parseLess()
$dependencies
$shortcuts
$singleton
$class_hash
No constants found
No protected methods found
$_data
$caching
$root
$data_root
$style_code
$root_dir
$template
$files
$filename
$error_message
$compiled_code
$uncompiled_code
$statcontent_file
$body_filename
$is_install
$intErrorCount
$block_names
$block_else_level
$include_counter
$block_nesting_level
$tplout_set
$tpl_output
$template_listener
N/A
lang()
glang()
loadfile()
security()
perform_header_tasks()
implode_cssjsfiles()
assign_var_from_handle()
assign_from_include()
compile()
compile_var_tags()
pre_compile()
compile_tag_block()
compile_tag_if()
compile_tag_include()
assign_from_listener()
_parse_is_expr()
generate_block_varref()
generate_block_data_ref()
compile_load()
compile_write()
replace_paths_css()
display_error()
strip_tags_php()
replaceSomePathVariables()
$_shorts
$_shorts_loaded
$_class_index
$handle
$states
N/A

Properties

$dependencies

$dependencies : 

Type

$shortcuts

$shortcuts : 

Type

$singleton

$singleton : 

Type

$class_hash

$class_hash : 

Type

$_data

$_data : 

Type

$caching

$caching : 

Type

$root

$root : 

Type

$data_root

$data_root : 

Type

$style_code

$style_code : 

Type

$root_dir

$root_dir : 

Type

$template

$template : 

Type

$files

$files : 

Type

$filename

$filename : 

Type

$error_message

$error_message : 

Type

$compiled_code

$compiled_code : 

Type

$uncompiled_code

$uncompiled_code : 

Type

$statcontent_file

$statcontent_file : 

Type

$body_filename

$body_filename : 

Type

$is_install

$is_install : 

Type

$intErrorCount

$intErrorCount : 

Type

$block_names

$block_names : 

Type

$block_else_level

$block_else_level : 

Type

$include_counter

$include_counter : 

Type

$block_nesting_level

$block_nesting_level : 

Type

$tplout_set

$tplout_set : 

Type

$tpl_output

$tpl_output : 

Type

$template_listener

$template_listener : 

Type

$_shorts

$_shorts : 

Type

$_shorts_loaded

$_shorts_loaded : 

Type

$_class_index

$_class_index : 

Type

$handle

$handle : 

Type

$states

$states : 

Type

Methods

__get()

__get(  $name) 

Parameters

$name

__isset()

__isset(  $name) 

Parameters

$name

__dependencies()

__dependencies() 

__shortcuts()

__shortcuts() 

__destruct()

__destruct() 

__construct()

__construct(  $install = false) 

Parameters

$install

save_state()

save_state(  $name) 

Parameters

$name

load_state()

load_state(  $name) 

Parameters

$name

get_templatedata()

get_templatedata(  $key) 

Parameters

$key

set_templateout()

set_templateout(  $key,   $value = false) 

Parameters

$key
$value

get_templateout()

get_templateout(  $key) 

Parameters

$key

set_template()

set_template(  $style_code = '',   $template = '',   $root_dir = 'templates/') 

Parameters

$style_code
$template
$root_dir

add_js()

add_js(  $varval,   $type = 'docready') 

Assign custom JS Code to the Header

Parameters

$varval
$type

js_file()

js_file(  $varval,   $type = 'combined',   $key = false) 

Assign custom JS File to the Header

Parameters

$varval
$type
$key

staticHTML()

staticHTML(  $varval) 

Parameters

$varval

add_meta()

add_meta(  $strMetatag) 

Parameters

$strMetatag

css_file()

css_file(  $varval,   $media = 'screen',   $first = false) 

Assign custom CSS File to the Header

Parameters

$varval
$media
$first

add_css()

add_css(  $varval,   $blnDirect = false) 

Assign custom CSS Code to the Header

Parameters

$varval
$blnDirect

add_listener()

add_listener(string  $strListenerName, string  $strHTML, boolean  $blnPrepare = false) 

Adds HTML Code for a template listener

Parameters

string $strListenerName
string $strHTML
boolean $blnPrepare

combine_css()

combine_css() 

debug_css_files()

debug_css_files() 

resolve_css_file()

resolve_css_file(  $cssfile,   $stylecode = false) 

Parameters

$cssfile
$stylecode

combine_js()

combine_js() 

cleanup_combined()

cleanup_combined() 

add_rssfeed()

add_rssfeed(  $title,   $url,   $arrPermissions = array(),   $type = 'application/rss+xml') 

Assign RSS-Feeds to the Header $id = uniqueid of feed, e.g. latest_news $title = e.g. My Guild DKP - Shoutbox $url = when using permissions, just add the filename and store the RSS-Feed in Folder $pfh->FolderPath('rss', 'eqdkp'), otherwise use relative path to the folder of the RSS-Feed

Parameters

$title
$url
$arrPermissions
$type

set_filenames()

set_filenames(  $filename_array) 

Sets the template filenames for handles. $filename_array should be a hash of handle => filename pairs.

Parameters

$filename_array

fullpath_filename()

fullpath_filename(  $filename,   $basefile = false) 

Parameters

$filename
$basefile

resolve_templatefile()

resolve_templatefile(  $filename,   $stylecode = false) 

Parameters

$filename
$stylecode

get_combined_css()

get_combined_css() 

get_header_js()

get_header_js() 

get_footer_js()

get_footer_js() 

display()

display(  $handle = 'main') 

Load the file for the handle, compile the file, and run the compiled code. This will print out the results of executing the template.

Parameters

$handle

assign_array()

assign_array(  $name,   $array,   $morekeys = '') 

Parameters

$name
$array
$morekeys

assign_vars()

assign_vars(  $vararray) 

Parameters

$vararray

assign_var()

assign_var(  $varname,   $varval) 

Parameters

$varname
$varval

assign_block_vars()

assign_block_vars(  $blockname,   $vararray) 

Parameters

$blockname
$vararray

compileString()

compileString(  $strString,   $arrVars = array()) 

Parameters

$strString
$arrVars

handleModifier()

handleModifier(  $strLangString,   $strModifier) 

Parameters

$strLangString
$strModifier

delete_cache()

delete_cache(  $template = '') 

Parameters

$template

add_common_cssfiles()

add_common_cssfiles() 

generate_error()

generate_error(  $content,   $handle = false,   $sprintf = '',   $function = '') 

Parameters

$content
$handle
$sprintf
$function

get_error_details()

get_error_details() 

parseLess()

parseLess(  $strCSS,   $strMapFile = false) 

Parameters

$strCSS
$strMapFile

lang()

lang(  $key) 

Parameters

$key

glang()

glang(  $key,   $lang = false,   $exists = false) 

Parameters

$key
$lang
$exists

loadfile()

loadfile(  $handle) 

If not already done, load the file for the given handle and populate the uncompiled_code[] hash with its code. Do not compile.

Parameters

$handle

security()

security() 

perform_header_tasks()

perform_header_tasks() 

implode_cssjsfiles()

implode_cssjsfiles(  $before,   $after,   $glue,   $array,   $type = '') 

Parameters

$before
$after
$glue
$array
$type

assign_var_from_handle()

assign_var_from_handle(  $varname,   $handle) 

Inserts the uncompiled code for $handle as the value of $varname in the root-level. This can be used to effectively include a template in the middle of another template.

Note that all desired assignments to the variables in $handle should be done BEFORE calling this function.

Parameters

$varname
$handle

assign_from_include()

assign_from_include(  $filename) 

Parameters

$filename

compile()

compile(  $code,   $do_not_echo = false,   $retvar = 'return') 

Parameters

$code
$do_not_echo
$retvar

compile_var_tags()

compile_var_tags(  $text_blocks) 

Parameters

$text_blocks

pre_compile()

pre_compile(  $tag_args) 

Parameters

$tag_args

compile_tag_block()

compile_tag_block(  $tag_args) 

Parameters

$tag_args

compile_tag_if()

compile_tag_if(  $tag_args,   $elseif) 

Parameters

$tag_args
$elseif

compile_tag_include()

compile_tag_include(  $tag_args) 

Parameters

$tag_args

assign_from_listener()

assign_from_listener(  $strListenername) 

Parameters

$strListenername

_parse_is_expr()

_parse_is_expr(  $is_arg,   $tokens) 

Parameters

$is_arg
$tokens

generate_block_varref()

generate_block_varref(  $namespace,   $varname) 

Generates a reference to the given variable inside the given (possibly nested) block namespace. This is a string of the form: ' . $this->_data['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i].

..['varname'] . ' It's ready to be inserted into an "echo" line in one of the templates. NOTE: expects a trailing "." on the namespace.

Parameters

$namespace
$varname

generate_block_data_ref()

generate_block_data_ref(  $blockname,   $include_last_iterator) 

Generates a reference to the array of data values for the given (possibly nested) block namespace. This is a string of the form: $this->_data['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i].

..['$childN']

If $include_last_iterator is true, then [$_childN_i] will be appended to the form shown above. NOTE: does not expect a trailing "." on the blockname.

Parameters

$blockname
$include_last_iterator

compile_load()

compile_load(  $_str,   $handle,   $do_echo) 

Parameters

$_str
$handle
$do_echo

compile_write()

compile_write(  $handle,   $data) 

Parameters

$handle
$data

replace_paths_css()

replace_paths_css(  $strCSS,   $stylepath = false,   $data = false,   $path = false) 

Parameters

$strCSS
$stylepath
$data
$path

display_error()

display_error(  $title,   $message) 

Parameters

$title
$message

strip_tags_php()

strip_tags_php(  $code) 

Parameters

$code

replaceSomePathVariables()

replaceSomePathVariables(  $in,   $root_path,   $stylepath) 

Parameters

$in
$root_path
$stylepath