Docs For Class MultiRootTemplate

Class: MultiRootTemplate

Inherited Variables

Class: Template

Template::$classname
Template::$debug
Template::$halt_on_error
Template::$last_error
Template::$postprocess_fn
Template::$preprocess_fn

Inherited Methods

Class: Template

Template::Template(): **************************************************************************** Class constructor. May be called with two optional parameters.
Template::clear_var(): **************************************************************************** This functions clears the value of a variable.
Template::finish(): **************************************************************************** This function returns the finished version of $str. That is, the policy regarding unresolved variable names will be applied to $str.
Template::get(): **************************************************************************** This function returns the finished version of the value of the variable named by $varname. That is, the policy regarding unresolved variable names will be applied to the variable $varname and the result returned.
Template::get_undefined(): **************************************************************************** This function returns a hash of unresolved variable names in $varname, keyed by their names (that is, the hash has the form $a[$name] = $name).
Template::get_var(): **************************************************************************** This function returns the value of the variable named by $varname.
Template::get_vars(): **************************************************************************** This function returns an associative array of all defined variables with the name as the key and the value of the variable as the value.
Template::haltmsg(): **************************************************************************** This function prints an error message.
Template::p(): **************************************************************************** This function prints the finished version of the value of the variable named by $varname. That is, the policy regarding unresolved variable names will be applied to the variable $varname then it will be printed.
Template::parse(): **************************************************************************** The function substitutes the values of all defined variables in the variable named $varname and stores or appends the result in the variable named $target.
Template::pparse(): **************************************************************************** This is shorthand for print $this->parse(...) and is functionally identical.
Template::psubst(): **************************************************************************** This is shorthand for print $this->subst($varname). See subst for further details.
Template::set_block(): **************************************************************************** A variable $parent may contain a variable block defined by:  content . This function removes that block from $parent and replaces it with a variable reference named $name.
Template::set_file(): **************************************************************************** Defines a filename for the initial value of a variable.
Template::set_root(): **************************************************************************** Checks that $root is a valid directory and if so sets this directory as the base directory from which templates are loaded by storing the value in $this->root. Relative filenames are prepended with the path in $this->root.
Template::set_unknowns(): **************************************************************************** Sets the policy for dealing with unresolved variable names.
Template::set_var(): **************************************************************************** This functions sets the value of a variable.
Template::subst(): ****************************************************************************
Template::unset_var(): **************************************************************************** This functions unsets a variable completely.

Class Details

[line 1001]

Class Methods

method filename [line 1020]

void filename(

$name)

Parameters:

$name

[ Top ]

method set_root [line 1011]

void set_root(

$A)

Overrides Template::set_root() (**************************************************************************** Checks that $root is a valid directory and if so sets this directory as the base directory from which templates are loaded by storing the value in $this->root. Relative filenames are prepended with the path in $this->root.)

Parameters:

[ Top ]

method Template [line 1003]

void Template(
[
$root = array()], [
$unknowns = 'remove'])

Overrides Template::Template() (**************************************************************************** Class constructor. May be called with two optional parameters.)

Parameters:

	$root
	$unknowns

[ Top ]

Documentation generated on Thu, 24 May 2012 02:09:19 -0400 by phpDocumentor 1.4.3

Class: MultiRootTemplate

Class Overview

Methods

Inherited Variables

Class: Template

Inherited Methods

Class: Template

Class Details

Class Methods

method filename [line 1020]

Parameters:

method set_root [line 1011]

Parameters:

method Template [line 1003]

Parameters: