Docs For Class HTML_Template

HTML_Template_PHPLIB (Constructor) [line 94]

HTML_Template_PHPLIB HTML_Template_PHPLIB(
[string
$root = '.'], [string
$unknowns = 'remove'], [array
$fallback = ''])

Constructor

Access: public

Parameters:

string	`$root`	—	template root directory
string	`$unknowns`	—	how to handle unknown variables
array	`$fallback`	—	fallback paths

[ Top ]

finish [line 407]

finished, finish(
string
$str)

Finish string

Return: i.e. substituted string
Access: public

Parameters:

string $str — string to finish

[ Top ]

get [line 440]

string get(
string
$varname)

Get finished variable

Return: string with finished variable

Parameters:

string $varname — variable to get

[ Top ]

getUndefined [line 373]

mixed getUndefined(
string
$handle)

Get undefined values of a handle

Return: false if an error occured or the undefined values
Access: public

Parameters:

string $handle — handle name

[ Top ]

getVar [line 347]

mixed getVar(
mixed
$varname)

Return one or more specific variable(s) with their values.

Return: array of variable names with their values or value of one specific variable
Access: public

Parameters:

mixed $varname — array with variable names or one variable name as a string

[ Top ]

getVars [line 329]

array getVars(
)

Return all defined variables and their values

Return: with all defined variables and their values
Access: public

[ Top ]

halt [line 541]

bool halt(
string
$msg)

Error function. Halt template system with message to show

Access: public

Parameters:

string $msg — message to show

[ Top ]

haltMsg [line 559]

object PEAR haltMsg(
string
$msg)

printf error message to show

Return: error object
Access: public

Parameters:

string $msg — message to show

[ Top ]

p [line 428]

void p(
string
$varname)

Print variable to the browser

Access: public

Parameters:

string $varname — name of variable to print

[ Top ]

parse [line 289]

string parse(
string
$target, string
$handle, [boolean
$append = false])

Parse handle into target

Parses handle $handle into $target, eventually appending handle at $target if $append is defined as TRUE.

Return: parsed handle
Access: public

Parameters:

string	`$target`	—	target handle to parse into
string	`$handle`	—	which handle should be parsed
boolean	`$append`	—	append it to $target or not?

[ Top ]

pParse [line 317]

bool pParse(
string
$target, string
$handle, [
$append = false])

Same as parse, but printing it.

Access: public

Parameters:

string	`$handle`	—	handle which should be parsed
string	`$target`	—	target to parse into
	`$append`	—

[ Top ]

pSubst [line 270]

bool pSubst(
string
$handle)

Same as subst but printing the result

Return: always false
Access: public

Parameters:

string $handle — handle of template

[ Top ]

setBlock [line 194]

void setBlock(
string
$parent, string
$handle, [string
$name = ''])

Set a block in the appropriate template handle

By setting a block like that:

html code

you can easily do repeating HTML code, i.e. output database data nice formatted into a HTML table where each DB row is placed into a HTML table row which is defined in this block. It extracts the template $handle from $parent and places variable {$name} instead.

Access: public

Parameters:

string	`$parent`	—	parent handle
string	`$handle`	—	block name handle
string	`$name`	—	variable substitution name

[ Top ]

setFile [line 153]

bool setFile(
mixed
$handle, [string
$filename = ''])

Set appropriate template files

With this method you set the template files you want to use. Either you supply an associative array with key/value pairs where the key is the handle for the filname and the value is the filename itself, or you define $handle as the file name handle and $filename as the filename if you want to define only one template.

Access: public

Parameters:

mixed	`$handle`	—	handle for a filename or array with handle/name value pairs
string	`$filename`	—	name of template file

[ Top ]

setRoot [line 108]

bool setRoot(
string
$root)

Sets the template directory

Access: public

Parameters:

string $root — new template directory

[ Top ]

setUnknowns [line 133]

void setUnknowns(
[string
$unknowns = 'keep'])

What to do with unknown variables

three possible values:

'remove' will remove unknown variables (don't use this if you define CSS in your page)
'comment' will replace undefined variables with comments
'keep' will keep undefined variables as-is

Access: public

Parameters:

string $unknowns — unknowns

[ Top ]

setVar [line 222]

void setVar(
string
$varname, [string
$value = ''], [boolean
$append = false])

Set corresponding substitutions for placeholders

Access: public

Parameters:

string	`$varname`	—	name of a variable that is to be defined or an array of variables with value substitution as key/value pairs
string	`$value`	—	value of that variable
boolean	`$append`	—	if true, the value is appended to the variable's existing value

[ Top ]

subst [line 252]

mixed subst(
string
$handle)

Substitute variables in handle $handle

Return: string substituted content of handle
Access: public

Parameters:

string $handle — name of handle

[ Top ]

Class: HTML_Template_PHPLIB

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$debug = false

$file = array()

$file_fallbacks = array()

$haltOnError = 'report'

$root = ''

$unknowns = 'remove'

Method Detail

HTML_Template_PHPLIB (Constructor) [line 94]

Parameters:

finish [line 407]

Parameters:

get [line 440]

Parameters:

getUndefined [line 373]

Parameters:

getVar [line 347]

Parameters:

getVars [line 329]

halt [line 541]

Parameters:

haltMsg [line 559]

Parameters:

p [line 428]

Parameters:

parse [line 289]

Parameters:

pParse [line 317]

Parameters:

pSubst [line 270]

Parameters:

setBlock [line 194]

Parameters:

setFile [line 153]

Parameters:

setRoot [line 108]

Parameters:

setUnknowns [line 133]

Parameters:

setVar [line 222]

Parameters:

subst [line 252]

Parameters: