Manual

SDK

 
   

API Reference
 

Sections

Todo

eZTemplateDelimitFunction Class Reference
[Template functions]

Displays left and right delimiter in templates. More...

List of all members.


Public Methods

 eZTemplateDelimitFunction ($lname="ldelim",$rname="rdelim")
& functionList ()
 process (&$tpl,&$textElements,$functionName,$functionChildren,$functionParameters,$functionPlacement,$nspace,$current_nspace)
 hasChildren ()

Public Attributes

 LName
 The name of the left delimiter tag.

 RName
 The name of the right delimiter tag.

Detailed Description

Displays left and right delimiter in templates.

This class iss a template function for outputting the left and right delimiters. Since the left and right delimiters are always parsed by the template engine it's not possible to output these characters. By registering an instance of this class as template functions you can get these characters with {ldelim} and {rdelim}.

The name of these functions can also be controlled by passing the names to the constructor.

Example: 

$tpl->registerFunctions( new eZTemplateDelimitFunction() );
// or custom names
$tpl->registerFunctions( new eZTemplateDelimitFunction( "l", "r" ) );
// alternatively
$obj = new eZTemplateDelimitFunction();
$tpl->registerFunction( "ldelim", $obj );
$tpl->registerFunction( "rdelim", $obj );

Definition at line eztemplatedelimitfunction.php.

Constructor & Destructor Documentation

eZTemplateDelimitFunction::eZTemplateDelimitFunction (  $    lname = "ldelim",
$    rname = "rdelim"
) 
 

Initializes the object with a name for the left and right delimiter. Default is ldelim for left and rdelim for right.

Definition at line eztemplatedelimitfunction.php.

References RName.

Member Function Documentation

& eZTemplateDelimitFunction::functionList (    ) 
 

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

Definition at line eztemplatedelimitfunction.php.

eZTemplateDelimitFunction::hasChildren (    ) 
 

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

Definition at line eztemplatedelimitfunction.php.

eZTemplateDelimitFunction::process (  &$    tpl,
&$    textElements,
$    functionName,
$    functionChildren,
$    functionParameters,
$    functionPlacement,
$    nspace,
$    current_nspace
) 
 

Outputs the left or right delimiter if the function names match.

Definition at line eztemplatedelimitfunction.php.

References RName.

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

Exponential