eZPublishCommunityProject(LegacyStack)  2013.6
eZTemplateSetFunction Class Reference

Sets template variables code using function 'set'. More...

Public Member Functions

 cleanupVariables ($tpl, $rootNamespace, &$currentNamespace, $setData)
 
 createDefaultVariables ($tpl, $functionParameters, $functionPlacement, $name, $rootNamespace, &$currentNamespace)
 
 defineVariables ($tpl, $functionParameters, $functionPlacement, $name, $rootNamespace, &$currentNamespace)
 
 eZTemplateSetFunction ($setName= 'set', $letName= 'let', $defaultName= 'default')
 
 functionList ()
 
 functionTemplateHints ()
 
 hasChildren ()
 
 process ($tpl, &$textElements, $functionName, $functionChildren, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
 
 templateHookProcess ($functionName, $functionHookName, $functionHook, $tpl, $functionParameters, $functionPlacement, $rootNamespace, $currentNamespace)
 
 templateNodeTransformation ($functionName, &$node, $tpl, $parameters, $privateData)
 

Public Attributes

 $DefaultName
 
 $LetName
 
 $SetName
 The name of the set function. More...
 
const SCOPE_GLOBAL = 3
 
const SCOPE_RELATIVE = 1
 
const SCOPE_ROOT = 2
 

Detailed Description

Sets template variables code using function 'set'.

Allows for setting template variables from templates using a template function. This is mainly used for optimizations.

The let function will define new variables and initialize them with a value while set only sets values to existing variables. The let function is also scoped with children which means that the variables are unset when the children are processed.

// Example template code
{let object=$item1 some_text='abc' integer=1}
{set object=$item2 some_text='def'}
{/let}
{set name=NewNamespace place='/etc/test.tpl'}

Member Function Documentation

eZTemplateSetFunction::cleanupVariables (   $tpl,
  $rootNamespace,
$currentNamespace,
  $setData 
)

Referenced by process().

eZTemplateSetFunction::createDefaultVariables (   $tpl,
  $functionParameters,
  $functionPlacement,
  $name,
  $rootNamespace,
$currentNamespace 
)

Referenced by process().

eZTemplateSetFunction::defineVariables (   $tpl,
  $functionParameters,
  $functionPlacement,
  $name,
  $rootNamespace,
$currentNamespace 
)

Referenced by process().

eZTemplateSetFunction::eZTemplateSetFunction (   $setName = 'set',
  $letName = 'let',
  $defaultName = 'default' 
)

Initializes the function with the function names $setName and $letName.

eZTemplateSetFunction::functionList ( )

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

eZTemplateSetFunction::functionTemplateHints ( )
eZTemplateSetFunction::hasChildren ( )

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

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

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

eZTemplateSetFunction::templateHookProcess (   $functionName,
  $functionHookName,
  $functionHook,
  $tpl,
  $functionParameters,
  $functionPlacement,
  $rootNamespace,
  $currentNamespace 
)
eZTemplateSetFunction::templateNodeTransformation (   $functionName,
$node,
  $tpl,
  $parameters,
  $privateData 
)

Member Data Documentation

eZTemplateSetFunction::$DefaultName
eZTemplateSetFunction::$LetName
eZTemplateSetFunction::$SetName

The name of the set function.

const eZTemplateSetFunction::SCOPE_GLOBAL = 3

Referenced by process().

const eZTemplateSetFunction::SCOPE_RELATIVE = 1

Referenced by process().

const eZTemplateSetFunction::SCOPE_ROOT = 2

Referenced by process().


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