PEAR Manual
Prev		Next

loadTemplateFile()

loadTemplateFile() -- Loads a template file.

Synopsis

require_once 'HTML/Template/Sigma.php';

mixed HTML_Template_Sigma::loadTemplateFile (string $filename [, boolean $removeUnknownVariables = TRUE [, boolean $removeEmptyBlocks = TRUE]])

Description

Loads a template file. If caching is on, then it checks whether a "prepared" template exists. If it does, it gets loaded instead of the original, if it does not, then the original gets loaded and prepared and then the prepared version is saved. addBlockfile() and replaceBlockfile() implement quite the same logic.

Parameter

string $filename: filename
boolean $removeUnknownVariables: remove unknown/unused variables?
boolean $removeEmptyBlocks: remove empty blocks?

Return value

return SIGMA_OK on success, error object on failure

Throws

Table 40-1. Possible PEAR_Error values

Error code	Error message	Reason	Solution
`SIGMA_TPL_NOT_FOUND`	Cannot read the template file '`$filename`'	File is unreadable for some reason	Check if the file exists and has correct permissions set
`SIGMA_CACHE_ERROR`	Cannot save template file 'filename'	A prepared template file cannot be saved	Check if the directory for prepared templates cache exists and is writeable for your script
`SIGMA_BLOCK_DUPLICATE`	The name of a block must be unique within a template. Block 'blockname' found twice.	The loaded file contains two blocks sharing the same name	Check the file and rename one of the the blocks to something else
`SIGMA_CALLBACK_SYNTAX_ERROR`	Cannot parse template function: (error description)	Bogus syntax for template function parameters.	Fix the template function definition, pay special attention to quoting rules.

See

see HTML_Template_Sigma::setTemplate(), HTML_Template_Sigma::$removeUnknownVariables, HTML_Template_Sigma::$removeEmptyBlocks

Note

This function can not be called statically.

Prev	Home	Next
hideBlock()	Up	parse()

PEAR Manual

loadTemplateFile()

Synopsis

Description

Parameter

Return value

Throws

See

Note

Newsletter

Hosted by

Search

Links