eZTemplateIncludeFunction Class Reference

Includes external template code using function "include". More...

List of all members.

Public Member Functions
	eZTemplateIncludeFunction ($inc_name="include")
	functionList ()
	functionTemplateHints ()
	hasChildren ()
	process ($tpl, &$textElements, $functionName, $functionChildren, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
	templateNodeTransformation ($functionName, &$node, $tpl, $parameters, $privateData)
Static Public Member Functions
static	handleInclude (&$textElements, &$uri, $tpl, $rootNamespace, $name)
Public Attributes
	$IncludeName
	The name of the include function.

---

Detailed Description

Includes external template code using function "include".

Allows the template designer to include another template file dynamically. This allows for reuse of commonly used template code. The new template file will loaded into the current namespace or a namspace specified by the template designer, any extra parameters to this function is set as template variables for the template file using the newly aquired namespace.

// Example template code
{include uri=file:myfile.tpl}

{include name=new_namespace uri=/etc/test.tpl}

Definition at line 32 of file eztemplateincludefunction.php.

---

Member Function Documentation

eZTemplateIncludeFunction::eZTemplateIncludeFunction

(

$

inc_name = "include"

)

Initializes the function with the function name $inc_name.

Definition at line 37 of file eztemplateincludefunction.php.

eZTemplateIncludeFunction::functionList

(

)

Returns an array of the function names, required for eZTemplate::registerFunctions.

Definition at line 45 of file eztemplateincludefunction.php.

eZTemplateIncludeFunction::functionTemplateHints

(

)

Definition at line 50 of file eztemplateincludefunction.php.

static eZTemplateIncludeFunction::handleInclude	(	&$	textElements,
		&$	uri,
		$	tpl,
		$	rootNamespace,
		$	name
	)		[static]

Takes care of loading the template file and set it in the $text parameter.

Definition at line 201 of file eztemplateincludefunction.php.

Referenced by eZTemplate\appendElementText(), contentPDFGenerate(), generatePDF(), process(), and eZXMLOutputHandler\renderTag().

eZTemplateIncludeFunction::hasChildren

(

)

Returns false, telling the template parser that this is a single tag.

Definition at line 209 of file eztemplateincludefunction.php.

eZTemplateIncludeFunction::process	(	$	tpl,
		&$	textElements,
		$	functionName,
		$	functionChildren,
		$	functionParameters,
		$	functionPlacement,
		$	rootNamespace,
		$	currentNamespace
	)

Loads the file specified in the parameter "uri" with namespace "name".

Definition at line 136 of file eztemplateincludefunction.php.

eZTemplateIncludeFunction::templateNodeTransformation	(	$	functionName,
		&$	node,
		$	tpl,
		$	parameters,
		$	privateData
	)

Definition at line 59 of file eztemplateincludefunction.php.

---

Member Data Documentation

eZTemplateIncludeFunction::$IncludeName

The name of the include function.

Definition at line 216 of file eztemplateincludefunction.php.

---

The documentation for this class was generated from the following file:

• eztemplateincludefunction.php