lib/eztemplate/classes/eztemplate.php

Show:

inherited

Classes
- \eZTemplate

Table of Contents

File containing the eZTemplate class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: lib
Version: 4.6.0

\eZTemplate
jump to top

Package: lib

File containing the eZTemplate class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Constants

 
                RESOURCE_FETCH
                = 1

 
                RESOURCE_QUERY
                = 2

 
                ELEMENT_TEXT
                = 1

 
                ELEMENT_SINGLE_TAG
                = 2

 
                ELEMENT_NORMAL_TAG
                = 3

 
                ELEMENT_END_TAG
                = 4

 
                ELEMENT_VARIABLE
                = 5

 
                ELEMENT_COMMENT
                = 6

 
                NODE_ROOT
                = 1

 
                NODE_TEXT
                = 2

 
                NODE_VARIABLE
                = 3

 
                NODE_FUNCTION
                = 4

 
                NODE_OPERATOR
                = 5

 
                NODE_INTERNAL
                = 100

 
                NODE_INTERNAL_CODE_PIECE
                = 101

 
                NODE_INTERNAL_VARIABLE_SET
                = 105

 
                NODE_INTERNAL_VARIABLE_UNSET
                = 102

 
                NODE_INTERNAL_NAMESPACE_CHANGE
                = 103

 
                NODE_INTERNAL_NAMESPACE_RESTORE
                = 104

 
                NODE_INTERNAL_WARNING
                = 120

 
                NODE_INTERNAL_ERROR
                = 121

 
                NODE_INTERNAL_RESOURCE_ACQUISITION
                = 140

 
                NODE_OPTIMIZED_RESOURCE_ACQUISITION
                = 141

 
                NODE_INTERNAL_OUTPUT_ASSIGN
                = 150

 
                NODE_INTERNAL_OUTPUT_READ
                = 151

 
                NODE_INTERNAL_OUTPUT_INCREASE
                = 152

 
                NODE_INTERNAL_OUTPUT_DECREASE
                = 153

 
                NODE_INTERNAL_OUTPUT_SPACING_INCREASE
                = 160

 
                NODE_INTERNAL_SPACING_DECREASE
                = 161

 
                NODE_OPTIMIZED_INIT
                = 201

 
                NODE_USER_CUSTOM
                = 1000

 
                TYPE_VOID
                = 0

 
                TYPE_STRING
                = 1

 
                TYPE_NUMERIC
                = 2

 
                TYPE_IDENTIFIER
                = 3

 
                TYPE_VARIABLE
                = 4

 
                TYPE_ATTRIBUTE
                = 5

 
                TYPE_OPERATOR
                = 6

 
                TYPE_BOOLEAN
                = 7

 
                TYPE_ARRAY
                = 8

 
                TYPE_DYNAMIC_ARRAY
                = 9

 
                TYPE_INTERNAL
                = 100

 
                TYPE_INTERNAL_CODE_PIECE
                = 101

 
                TYPE_PHP_VARIABLE
                = 102

 
                TYPE_OPTIMIZED_NODE
                = 201

 
                TYPE_OPTIMIZED_ARRAY_LOOKUP
                = 202

 
                TYPE_OPTIMIZED_CONTENT_CALL
                = 203

 
                TYPE_OPTIMIZED_ATTRIBUTE_LOOKUP
                = 204

 
                TYPE_INTERNAL_STOP
                = 999

 
                TYPE_STRING_BIT
                = 1

 
                TYPE_NUMERIC_BIT
                = 2

 
                TYPE_IDENTIFIER_BIT
                = 4

 
                TYPE_VARIABLE_BIT
                = 8

 
                TYPE_ATTRIBUTE_BIT
                = 16

 
                TYPE_OPERATOR_BIT
                = 32

 
                TYPE_NONE
                = 0

 
                TYPE_ALL
                = 63

 
                TYPE_BASIC
                = 47

 
                TYPE_MODIFIER_MASK
                = 48

 
                NAMESPACE_SCOPE_GLOBAL
                = 1

 
                NAMESPACE_SCOPE_LOCAL
                = 2

 
                NAMESPACE_SCOPE_RELATIVE
                = 3

 
                DEBUG_INTERNALS
                = false

 
                FILE_ERRORS
                = 1

Properties


                 $AutoloadPathList= ''

Details

Type: n/a


                 $CurrentLocalVariablesNames= ''

Details

Type: n/a


                 $DefaultResource= ''

Details

Type: n/a


                 $DoCounter= ''

Details

Type: n/a


                 $ElseifCounter= ''

Details

Type: n/a


                 $ErrorLog= ''

Details

Type: n/a


                 $ForCounter= ''

Details

Type: n/a


                 $ForeachCounter= ''

Details

Type: n/a


                 $FunctionAttributes= ''

Details

Type: n/a


                 $Functions= ''

Details

Type: n/a


                 $IncludeOutput= ''

Details

Type: n/a


                 $IncludeText= ''

Details

Type: n/a


                 $IsCachingAllowed= ''

Details

Type: n/a


                 $LDelim= ''

Details

Type: n/a


                 $Level= '0'

Default value0Details

Type: n/a


                 $Literals= ''

Details

Type: n/a


                 $LocalVariablesNamesStack= ''

Details

Type: n/a


                 $MaxLevel= '40'

Default value40Details

Type: n/a


                 $Operators= ''

Details

Type: n/a


                 $RDelim= ''

Details

Type: n/a


                 $Resources= ''

Details

Type: n/a


                 $ShowDetails= 'false'

Default valuefalseDetails

Type: n/a


                 $TemplatesUsageStatistics= ''

Details

Type: n/a


                 $TestCompile= ''

Details

Type: n/a


                 $Text= ''

Details

Type: n/a


                 $TimeStamp= ''

Details

Type: n/a


                 $Tree= ''

Details

Type: n/a


                 $Variables= ''

Details

Type: n/a


                 $WarningLog= ''

Details

Type: n/a


                 $WhileCounter= ''

Details

Type: n/a

bool
                 $factory= 'false'

static

Factory flag as used by {@link eZTemplate::factory()} Reset with {@link eZTemplate::resetInstance()}

Default valuefalseDetails

Type: bool

null|\eZTemplate
                 $instance= ''

static

Singelton instance of eZTemplate used by {@link eZTemplate::instance()} Reset with {@link eZTemplate::resetInstance()}

Details

Type: null | \eZTemplate

Methods

appendDebugNodes(
           $root,  $resourceData
          )
        
        :
          void

Parameters

Name	Type	Description
$root
$resourceData

appendElement(
           $text,  $item,  $nspace,  $name
          )
        
        :
          void

Parameters

Name	Type	Description
$text
$item
$nspace
$name

appendElementText(
           $textElements,  $item,  $nspace,  $name
          )
        
        :
          void

Parameters

Name	Type	Description
$textElements
$item
$nspace
$name

appendTemplateFetch(
           $actualTemplateName
          )
        
        :
          void

Parameters

Name	Type	Description
$actualTemplateName

appendTemplateToStatistics(
           $templateName,  $templateFileName
          )
        
        :
          void

Parameters

Name	Type	Description
$templateName
$templateFileName

appendTemplateToStatisticsIfNeeded(
           $templateName,  $templateFileName
          )
        
        :
          void

Parameters

Name	Type	Description
$templateName
$templateFileName

attributeValue(
           $data,  $nspace
          )
        
        :
          void

Parameters

Name	Type	Description
$data
$nspace

autoload(
          
          )
        
        :
          void

autoloadPathList(
          
          )
        
        :
          void

canCompileTemplate(
           $resourceData,  $extraParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$resourceData
$extraParameters

compileTemplate(
           $resourceData,  $extraParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$resourceData
$extraParameters

compileTemplateFile(
           $file,  $returnResourceData
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$file
$returnResourceData

createLocalVariablesList(
          
          )
        
        :
          void

destroyLocalVariablesList(
          
          )
        
        :
          void

display(
           $template
              =
              false,  $extraParameters
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$template
$extraParameters

doFunction(
           $name,  $func_obj,  $nspace,  $current_nspace
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$func_obj
$nspace
$current_nspace

doOperator(
           $element,  $namespace,  $current_nspace,  $value,  $operatorName,  $operatorParameters,  $named_params
          )
        
        :
          void

Parameters

Name	Type	Description
$element
$namespace
$current_nspace
$value
$operatorName
$operatorParameters
$named_params

eZTemplate(
          
          )
        
        :
          void

elementValue(
           $dataElements,  $rootNamespace,  $currentNamespace,  $placement
              =
              false,  $checkExistance
              =
              false,  $checkForProxy
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$dataElements
$rootNamespace
$currentNamespace
$placement
$checkExistance
$checkForProxy

emptyVariable(
          
          )
        
        :
          void

error(
           $name,  $txt,  $placement
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$txt
$placement

errorCount(
          
          )
        
        :
          void

errorLog(
          
          )
        
        :
          void

executeCompiledTemplate(
           $resourceData,  $textElements,  $rootNamespace,  $currentNamespace,  $extraParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$resourceData
$textElements
$rootNamespace
$currentNamespace
$extraParameters

expandAttributes(
           $attributeList,  $chooseText,  $maxThreshold,  $minThreshold
              =
              1
          )
        
        :
          void

Parameters

Name	Type	Description
$attributeList
$chooseText
$maxThreshold
$minThreshold

extraParameters(
           $name,  $count,  $maxCount
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$count
$maxCount

factory(
          
          )
        
        :
          \eZTemplate

static

Returns a shared instance of the eZTemplate class with default settings applied, like: - Autoload operators loaded - Debug mode set - eZTemplateDesignResource::instance registered

Returns

Type	Description
\eZTemplate

Details

Since: 4.3

fetch(
           $template
              =
              false,  $extraParameters
              =
              false,  $returnResourceData
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$template
$extraParameters
$returnResourceData

fetchFunctionObject(
           $functionName
          )
        
        :
          void

Parameters

Name	Type	Description
$functionName

hasChildren(
           $function,  $functionName
          )
        
        :
          void

Parameters

Name	Type	Description
$function
$functionName

hasErrors(
          
          )
        
        :
          void

hasLocalVariable(
           $varName,  $rootNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$varName
$rootNamespace

hasVariable(
          string $var, string $namespace
              =
              '', array $attrs
              =
              null
          )
        
        :
          bool

Returns true if the variable $var is set in namespace $namespace, if $attrs is supplied all attributes must exist for the function to return true.

Parameters

Name	Type	Description
$var	string
$namespace	string	(optional)
$attrs	array	(optional) Deprecated as of 4.4.

Returns

Type	Description
bool

hasWarnings(
          
          )
        
        :
          void

Returns the eZINI object instance for the template.ini file.

Returns

Type	Description
\eZINI

instance(
          
          )
        
        :
          \eZTemplate

static

Returns a shared instance of the eZTemplate class.

Returns

Type	Description
\eZTemplate

isCachingAllowed(
          
          )
        
        :
          void

isDebugEnabled(
          
          )
        
        :
          void

static

isMethodDebugEnabled(
          
          )
        
        :
          void

static

isTemplatesUsageStatisticsEnabled(
          
          )
        
        :
          void

static

isXHTMLCodeIncluded(
          
          )
        
        :
          void

static

leftDelimiter(
          
          )
        
        :
          void

load(
           $uri,  $extraParameters
              =
              false,  $returnResourceData
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$uri
$extraParameters
$returnResourceData

loadAndRegisterFunctions(
           $functionDefinition
          )
        
        :
          void

Parameters

Name	Type	Description
$functionDefinition

loadAndRegisterOperators(
           $operatorDefinition
          )
        
        :
          void

Parameters

Name	Type	Description
$operatorDefinition

loadURIData(
           $resourceObject,  $uri,  $resourceName,  $template,  $extraParameters,  $displayErrors
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$resourceObject
$uri
$resourceName
$template
$extraParameters
$displayErrors

loadURIRoot(
           $uri,  $displayErrors
              =
              true,  $extraParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$uri
$displayErrors
$extraParameters

mergeNamespace(
           $rootNamespace,  $additionalNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$rootNamespace
$additionalNamespace

missingParameter(
           $name,  $param
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$param

operatorInputSupported(
           $operatorName
          )
        
        :
          void

Parameters

Name	Type	Description
$operatorName

operatorParameterList(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

parse(
           $sourceText,  $rootElement,  $rootNamespace,  $resourceData
          )
        
        :
          void

Parameters

Name	Type	Description
$sourceText
$rootElement
$rootNamespace
$resourceData

placementText(
           $placement
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$placement

process(
           $root,  $text,  $rootNamespace,  $currentNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$root
$text
$rootNamespace
$currentNamespace

processFunction(
           $functionName,  $textElements,  $functionChildren,  $functionParameters,  $functionPlacement,  $rootNamespace,  $currentNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$functionName
$textElements
$functionChildren
$functionParameters
$functionPlacement
$rootNamespace
$currentNamespace

processNode(
           $node,  $textElements,  $rootNamespace,  $currentNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$node
$textElements
$rootNamespace
$currentNamespace

processOperator(
           $operatorName,  $operatorParameters,  $rootNamespace,  $currentNamespace,  $valueData,  $placement
              =
              false,  $checkExistance
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$operatorName
$operatorParameters
$rootNamespace
$currentNamespace
$valueData
$placement
$checkExistance

processURI(
           $uri,  $displayErrors
              =
              true,  $extraParameters,  $textElements,  $rootNamespace,  $currentNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$uri
$displayErrors
$extraParameters
$textElements
$rootNamespace
$currentNamespace

processVariable(
           $textElements,  $variableData,  $variablePlacement,  $rootNamespace,  $currentNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$textElements
$variableData
$variablePlacement
$rootNamespace
$currentNamespace

registerAutoloadFunctions(
           $functionDefinition
          )
        
        :
          void

Parameters

Name	Type	Description
$functionDefinition

registerAutoloadOperators(
           $operatorDefinition
          )
        
        :
          void

Parameters

Name	Type	Description
$operatorDefinition

registerFilter(
          
          )
        
        :
          void

registerFunction(
           $func_name,  $func_obj
          )
        
        :
          void

Parameters

Name	Type	Description
$func_name
$func_obj

registerFunctions(
           $functionObject
          )
        
        :
          void

Parameters

Name	Type	Description
$functionObject

registerFunctionsInternal(
           $functionObject,  $debug
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$functionObject
$debug

registerLiteral(
           $func_name
          )
        
        :
          void

Parameters

Name	Type	Description
$func_name

registerOperator(
           $op_name,  $op_obj
          )
        
        :
          void

Parameters

Name	Type	Description
$op_name
$op_obj

registerOperators(
           $operatorObject
          )
        
        :
          void

Parameters

Name	Type	Description
$operatorObject

registerOperatorsInternal(
           $operatorObject,  $debug
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$operatorObject
$debug

registerResource(
           $res
          )
        
        :
          void

Parameters

Name	Type	Description
$res

resetElements(
          
          )
        
        :
          void

resetErrorLog(
          
          )
        
        :
          void

resetInstance(
          
          )
        
        :
          void

static

Reset shared instance of the eZTemplate class and factory flag as used by {@link eZTemplate::instance()} and {@link eZTemplate::factory()}

Details

Since: 4.3

resetVariables(
          
          )
        
        :
          void

resourceData(
           $resourceObject,  $uri,  $resourceName,  $templateName
          )
        
        :
          void

Parameters

Name	Type	Description
$resourceObject
$uri
$resourceName
$templateName

resourceFor(
           $uri,  $res,  $template
          )
        
        :
          void

Parameters

Name	Type	Description
$uri
$res
$template

resourceHandler(
           $resourceName
          )
        
        :
          void

Parameters

Name	Type	Description
$resourceName

rightDelimiter(
          
          )
        
        :
          void

setAutoloadPathList(
           $pathList
          )
        
        :
          void

Parameters

Name	Type	Description
$pathList

setCompileTest(
           $val
          )
        
        :
          void

Parameters

Name	Type	Description
$val

setIncludeOutput(
           $uri,  $output
          )
        
        :
          void

Parameters

Name	Type	Description
$uri
$output

setIncludeText(
           $uri,  $text
          )
        
        :
          void

Parameters

Name	Type	Description
$uri
$text

setIsCachingAllowed(
           $allowed
          )
        
        :
          void

Parameters

Name	Type	Description
$allowed

setIsDebugEnabled(
           $debug
          )
        
        :
          void

static

Parameters

Name	Type	Description
$debug

setIsTemplatesUsageStatisticsEnabled(
           $enabled
          )
        
        :
          void

Parameters

Name	Type	Description
$enabled

setLeftDelimiter(
           $delim
          )
        
        :
          void

Parameters

Name	Type	Description
$delim

setLocalVariable(
           $varName,  $varValue,  $rootNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$varName
$varValue
$rootNamespace

setRightDelimiter(
           $delim
          )
        
        :
          void

Parameters

Name	Type	Description
$delim

setShowDetails(
           $show
          )
        
        :
          void

Parameters

Name	Type	Description
$show

setVariable(
          string $var, string $val, string $namespace
              =
              '', bool $scopeSafe
              =
              false
          )
        
        :
          void

Sets the template variable $var to the value $val.

Parameters

Name	Type	Description
$var	string
$val	string
$namespace	string	(optional)
$scopeSafe	bool	If true, will assure that $var is not overridden for $namespace. False by default

Details

Used_by: \eZTemplate::setVariableRef()

setVariableRef(
          string $var, string $val, string $namespace
              =
              ''
          )
        
        :
          void

Sets the template variable $var to the value $val by ref

Parameters

Name	Type	Description
$var	string
$val	string
$namespace	string	(optional)

Details

Deprecated: Since 4.4, have not used references since 3.10
Uses: \eZTemplate::setVariable()

templateFetchList(
          
          )
        
        :
          void

templatesUsageStatistics(
          
          )
        
        :
          void

static

testCompile(
          
          )
        
        :
          void

undefinedFunction(
           $func_name
          )
        
        :
          void

Parameters

Name	Type	Description
$func_name

undefinedVariable(
           $name,  $var
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$var

unregisterLiteral(
           $func_name
          )
        
        :
          void

Parameters

Name	Type	Description
$func_name

unregisterOperator(
           $op_name
          )
        
        :
          void

Parameters

Name	Type	Description
$op_name

unregisterResource(
           $res_name
          )
        
        :
          void

Parameters

Name	Type	Description
$res_name

unsetLocalVariable(
           $varName,  $rootNamespace
          )
        
        :
          void

Parameters

Name	Type	Description
$varName
$rootNamespace

unsetLocalVariables(
          
          )
        
        :
          void

unsetVariable(
          string $var, string $namespace
              =
              ''
          )
        
        :
          void

Unsets the template variable $var.

Parameters

Name	Type	Description
$var	string
$namespace	string	(optional)

validateTemplateFile(
           $file,  $returnResourceData
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$file
$returnResourceData

variable(
          string $var, string $namespace
              =
              '', array $attrs
              =
              null
          )
        
        :
          string | array

Returns the content of the variable $var using namespace $namespace, if $attrs is supplied the result of the attributes is returned.

Parameters

Name	Type	Description
$var	string
$namespace	string	(optional)
$attrs	array	(optional) Deprecated as of 4.4

Returns

Type	Description
string \| array

variableAttribute(
           $var,  $attrs
          )
        
        :
          void

Parameters

Name	Type	Description
$var
$attrs

variableText(
           $var,  $namespace
              =
              "",  $attrs
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$var
$namespace
$attrs

warning(
           $name,  $txt,  $placement
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$txt
$placement

warningCount(
          
          )
        
        :
          void

warningLog(
          
          )
        
        :
          void

lib/eztemplate/classes/eztemplate.php

\eZTemplatejump to top

Constants

Properties

Methods

\eZTemplate
jump to top