replaceBlockfile()

replaceBlockfile() – Replaces an existing block with new content from a file.

Synopsis

require_once 'HTML/Template/Sigma.php';

mixed HTML_Template_Sigma::replaceBlockfile ( string $block , string $filename , boolean $keepContent = false )

Description

Replaces an existing block with new content from a file.

Parameter

string $block

name of a block to replace

string $filename

template file that contains the block

boolean $keepContent

TRUE if the parsed contents of the block should be kept

Return value

return SIGMA_OK on success, error object on failure

Throws

Possible PEAR_Error values
Error code Error message Reason Solution
SIGMA_BLOCK_NOT_FOUND Cannot find block '$block' There is no block $block in the template Check the block name spelling, check whether you added all the necessary blocks to the template
SIGMA_BLOCK_DUPLICATE The name of a block must be unique within a template. Block 'blockname' found twice. The loaded block contains a subblock that has the same name as the existing one Check the file contents and rename the block to something else
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_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.

Note

This function can not be called statically.

Replaces an existing block with new content. (Previous) Sets the directory to cache "prepared" templates in. (Next)
Last updated: Tue, 16 Sep 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.