addBlockfile()

addBlockfile() – Adds a block contained in the file to the template

Synopsis

require_once 'HTML/Template/Sigma.php';

mixed HTML_Template_Sigma::addBlockfile ( string $placeholder , string $block , string $filename )

Description

Adds a block taken from a file to the template, changing a variable placeholder to a block placeholder.

Parameter

string $placeholder

name of the variable placeholder

string $block

name of the block to be added

string $filename

template file that contains the block

Return value

return SIGMA_OK on success, error object on failure

Throws

Possible PEAR_Error values
Error code Error message Reason Solution
SIGMA_BLOCK_EXISTS Block '$block' already exists Tried to add a block with a name that is already present in the template Choose a different name for a new block
SIGMA_PLACEHOLDER_NOT_FOUND Variable placeholder '$placeholder' not found There is no placeholder to replace by a new block in the template Check the spelling of the placeholder name
SIGMA_PLACEHOLDER_DUPLICATE Placeholder '$placeholder' should be unique, found in multiple blocks A placeholder to be replaced by a new block should appear only in one place Check the spelling of the placeholder name, choose a different placeholder
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 added file contains a block that has the same name as the existing one Check the file and rename the block 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.

Note

This function can not be called statically.

Adds a block to the template (Previous) Checks if the block exists in the template (Next)
Last updated: Wed, 30 Jul 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.