templateparser Class Reference
[Template-Parser-Class]

List of all members.

Public Member Functions
	templateparser ($tpl_folder)
	Class Constructor.
	_templateparser ()
	Class Destructor.
	tpl_display_tpl ()
	Display the complete converted template.
	tpl_flush_errors ()
	Flush the complete template error buffer.
	tpl_get_errorlist ()
	Returns array with all errors which happened during the last parse process. After the call the list will be cleared.
	tpl_parse_all ($tpl_name)
	Parse the complete template.
	tpl_register_var ($var_value, $var_name)
	Register normal variable or array. Arrays get a new index name like "arrayname.keyvalue". The keyvalue starts from 0.
	tpl_unset_array ($array_name)
	Unset array by name.
	tpl_unset_var ($var_name)
	Unset variable by name.
	tpl_get_reg_array_size ($array_name)
	Returns size of registered array.
	tpl_include_files ()
	Include the data through the include command.
	tpl_parse_loops ()
	Convert all loops. Note that loops inside loops will be not supported at this time.
	tpl_parse_vars ()
	Converts all vars.
	tpl_read_tpl ($tpl_name)
	Reads complete template file.
Public Attributes
	$tpl_error_hdl = 0
	$tpl_folder = 0
	$tpl_name = 0
	$tpl_string = 0
	$tpl_vars = array()

---

Constructor & Destructor Documentation

function templateparser::templateparser (  $  tpl_folder  )

Class Constructor. Parameters: $tpl_folder  = ABSOLUT path to the template working folder

---

Member Function Documentation

function templateparser::_templateparser (   )

Class Destructor.

function templateparser::tpl_display_tpl (   )

Display the complete converted template.

function templateparser::tpl_flush_errors (   )

Flush the complete template error buffer. Returns: Returns 'true' if everything has been all right else 'false'.

function templateparser::tpl_get_errorlist (   )

Returns array with all errors which happened during the last parse process. After the call the list will be cleared. Returns: Array with error list

function templateparser::tpl_get_reg_array_size (  $  array_name  )

Returns size of registered array. Parameters: $array_name  = Name of array Returns: Size of array

function templateparser::tpl_include_files (   )

Include the data through the include command. Returns: Returns 'true' if everything has been all right else 'false'.

function templateparser::tpl_parse_all (  $  tpl_name  )

Parse the complete template. Parameters: $tpl_name  = Name of template Returns: Returns 'true' if everything has been all right else 'false'.

function templateparser::tpl_parse_loops (   )

Convert all loops. Note that loops inside loops will be not supported at this time. Returns: Returns 'true' if everything has been all right else 'false'.

function templateparser::tpl_parse_vars (   )

Converts all vars. Returns: Returns 'true' if everything has been all right else 'false'.

function templateparser::tpl_read_tpl (  $  tpl_name  )

Reads complete template file. Parameters: $tpl_name  = Name of template file Returns: Template file data

function templateparser::tpl_register_var (  $  var_value, $  var_name )

Register normal variable or array. Arrays get a new index name like "arrayname.keyvalue". The keyvalue starts from 0. Parameters: $var_value  = Variable or array value $var_name  = Variable or array name Returns: Returns 'true' if everything has been all right else 'false'.

function templateparser::tpl_unset_array (  $  array_name  )

Unset array by name. Parameters: $array_name  = Name of array Returns: Returns 'true' if everything has been all right else 'false'.

function templateparser::tpl_unset_var (  $  var_name  )

Unset variable by name. Parameters: $var_name  = Name of var Returns: Returns 'true' if everything has been all right else 'false'.

---

Member Data Documentation

templateparser::$tpl_error_hdl = 0

Error message handler

templateparser::$tpl_folder = 0

Template working folder

templateparser::$tpl_name = 0

Actual template

templateparser::$tpl_string = 0

Includes the complete template string

templateparser::$tpl_vars = array()

Includes all registered vars and arrays

---

The documentation for this class was generated from the following file:

• templateparser.php

---