Apache Zeta Components Manual :: Package Template Element Index
Element index for package Template
Package indexes
[
a ]
[
c ]
[
e ]
[
f ]
[
g ]
[
h ]
[
i ]
[
k ]
[
l ]
[
m ]
[
n ]
[
o ]
[
p ]
[
r ]
[
s ]
[
t ]
[
u ]
[
v ]
[
x ]
[
_ ]
Letter '_'
- __construct
- in file runtime_exception.php, method ezcTemplateRuntimeException::__construct()
Constructs a template runtime exception with message $msg.
- __construct
- in file parser_exception.php, method ezcTemplateParserException::__construct()
Initialises the exception with the failing elements, parser, source code and error messages.
- __construct
- in file no_output_context_exception.php, method ezcTemplateNoOutputContextException::__construct()
Initialises the exception with the location object $location which contains the locator which is missing.
- __construct
- in file source_to_tst_parser_exception.php, method ezcTemplateSourceToTstParserException::__construct()
Initialises the exception with the failing elements, parser, source code and error messages.
- __construct
- in file template.php, method ezcTemplate::__construct()
Intializes the ezcTemplate with a default configuration and empty $send and $receive properties.
- __construct
- in file variable_collection.php, method ezcTemplateVariableCollection::__construct()
Initialises an empty collection of variables.
- __construct
- in file typehint_exception.php, method ezcTemplateTypeHintException::__construct()
This exception should be caught, and rethrown. The message is not important.
- __construct
- in file template_exception.php, method ezcTemplateException::__construct()
Constructs a new ezcTemplateException with error message $message.
- __construct
- in file compilation_failed_exception.php, method ezcTemplateCompilationFailedException::__construct()
Creates a exception for failed compilations, error message is specified by caller.
- __construct
- in file no_manager_exception.php, method ezcTemplateNoManagerException::__construct()
Initialises the exception with the location object $location which contains the locator which is missing.
- __construct
- in file file_failed_rename_exception.php, method ezcTemplateFileFailedRenameException::__construct()
Initialises the exception with the original template file path and the new file path.
- __construct
- in file custom_block_exception.php, method ezcTemplateCustomBlockException::__construct()
Initialises the CustomBlock exception with the given message.
- __construct
- in file configuration.php, method ezcTemplateConfiguration::__construct()
Initialises the configuration with default template, compiled path, and context.
- __construct
- in file invalid_compiled_file_exception.php, method ezcTemplateInvalidCompiledFileException::__construct()
Initialises the exception with the location object $location which contains the locator which is missing.
- __construct
- in file file_failed_unlink_exception.php, method ezcTemplateFileFailedUnlinkException::__construct()
Initialises the exception with the template file path.
- __construct
- in file file_not_found_exception.php, method ezcTemplateFileNotFoundException::__construct()
Initialises the exception with the template file path.
- __construct
- in file file_not_writeable_exception.php, method ezcTemplateFileNotWriteableException::__construct()
Constructor
- __construct
- in file internal_exception.php, method ezcTemplateInternalException::__construct()
Creates a template internal exception.
- __construct
- in file file_not_readable_exception.php, method ezcTemplateFileNotReadableException::__construct()
Initialises the exception with the template file path.
- __get
- in file variable_collection.php, method ezcTemplateVariableCollection::__get()
Returns the value of the variable $name.
- __isset
- in file variable_collection.php, method ezcTemplateVariableCollection::__isset()
Returns true if the variable $name is set.
- __set
- in file variable_collection.php, method ezcTemplateVariableCollection::__set()
Sets the value in $value to the variable named $name.
Letter 'a'
- addExtension
- in file configuration.php, method ezcTemplateConfiguration::addExtension()
Adds custom tags or functions to the customBlock or customFunction property and indirectly adds the custom extension to the template language.
Letter 'c'
- $class
- in file custom_function_definition.php, variable ezcTemplateCustomFunctionDefinition::$class
Holds the (static) class that implements the function to be executed.
- $class
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$class
Holds the (static) class that implements the function to be executed.
- cleanExpired
- in file cache_manager.php, method ezcTemplateCacheManager::cleanExpired()
The cleanExpired method should remove the expired caches.
- current
- in file variable_collection.php, method ezcTemplateVariableCollection::current()
Returns the current variable
- configuration.php
- procedural page configuration.php
- compilation_failed_exception.php
- procedural page compilation_failed_exception.php
- custom_block_exception.php
- procedural page custom_block_exception.php
- cache_manager.php
- procedural page cache_manager.php
- custom_block.php
- procedural page custom_block.php
- custom_function.php
- procedural page custom_function.php
- custom_block_definition.php
- procedural page custom_block_definition.php
- custom_function_definition.php
- procedural page custom_function_definition.php
Letter 'e'
- $elements
- in file source_to_tst_parser_exception.php, variable ezcTemplateSourceToTstParserException::$elements
Array of elements which should be used to extract failed code.
- $errorCursor
- in file parser_exception.php, variable ezcTemplateParserException::$errorCursor
Cursor where the error occured.
- $errorDetails
- in file source_to_tst_parser_exception.php, variable ezcTemplateSourceToTstParserException::$errorDetails
A more detailed error message which can for instance give hints to the end-user why it failed.
- $errorDetails
- in file parser_exception.php, variable ezcTemplateParserException::$errorDetails
A more detailed error message which can for instance give hints to the end-user why it failed.
- $errorMessage
- in file source_to_tst_parser_exception.php, variable ezcTemplateSourceToTstParserException::$errorMessage
The one-liner error message.
- $errorMessage
- in file parser_exception.php, variable ezcTemplateParserException::$errorMessage
The one-liner error message.
- $excessParameters
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$excessParameters
When excessParameters is set to true, the custom block accepts any amount of parameters over the required parameters.
- ezcTemplate
- in file template.php, class ezcTemplate
The main class for processing templates.
- ezcTemplateCacheManager
- in file cache_manager.php, class ezcTemplateCacheManager
Interface for the class that implement a cache manager.
- ezcTemplateCompilationFailedException
- in file compilation_failed_exception.php, class ezcTemplateCompilationFailedException
ezcTemplateCompilationFailedException is thrown when a template could not be compiled.
- ezcTemplateConfiguration
- in file configuration.php, class ezcTemplateConfiguration
Contains the common configuration options for template managers.
- ezcTemplateCustomBlock
- in file custom_block.php, class ezcTemplateCustomBlock
Interface for classes which provides custom blocks to the template engine.
- ezcTemplateCustomBlockDefinition
- in file custom_block_definition.php, class ezcTemplateCustomBlockDefinition
Contains the definition of a custom block.
- ezcTemplateCustomBlockException
- in file custom_block_exception.php, class ezcTemplateCustomBlockException
ezcTemplateCustomBlock exception is thrown when an error occurs while processing a Custom Block.
- ezcTemplateCustomFunction
- in file custom_function.php, class ezcTemplateCustomFunction
Interface for classes which provides custom functions to the template engine.
- ezcTemplateCustomFunctionDefinition
- in file custom_function_definition.php, class ezcTemplateCustomFunctionDefinition
Contains the definition of a custom function.
- ezcTemplateException
- in file template_exception.php, class ezcTemplateException
ezcTemplateExceptions are thrown when an exceptional state occurs in the Template package.
- ezcTemplateFileFailedRenameException
- in file file_failed_rename_exception.php, class ezcTemplateFileFailedRenameException
Exception for problems when renaming template files.
- ezcTemplateFileFailedUnlinkException
- in file file_failed_unlink_exception.php, class ezcTemplateFileFailedUnlinkException
Exception for problems when unlinking template files.
- ezcTemplateFileNotFoundException
- in file file_not_found_exception.php, class ezcTemplateFileNotFoundException
Exception for problems when accessing template files which does not exists.
- ezcTemplateFileNotReadableException
- in file file_not_readable_exception.php, class ezcTemplateFileNotReadableException
Exception for problems when reading from template files.
- ezcTemplateFileNotWriteableException
- in file file_not_writeable_exception.php, class ezcTemplateFileNotWriteableException
Exception for problems when writing to template files.
- ezcTemplateInternalException
- in file internal_exception.php, class ezcTemplateInternalException
ezcTemplateInternalException is thrown when the Template engine comes into an unstable state.
- ezcTemplateInvalidCompiledFileException
- in file invalid_compiled_file_exception.php, class ezcTemplateInvalidCompiledFileException
Exception for missing invalid compiled files.
- ezcTemplateLocation
- in file location.php, class ezcTemplateLocation
Interface for classes implementing a dynamic template location.
- ezcTemplateLocator
- in file locator.php, class ezcTemplateLocator
- ezcTemplateNoContext
- in file no_context.php, class ezcTemplateNoContext
The ezcTemplateNoContext class doesn't change the output. This makes testing more easy.
- ezcTemplateNoManagerException
- in file no_manager_exception.php, class ezcTemplateNoManagerException
Exception for for missing managers in classes.
- ezcTemplateNoOutputContextException
- in file no_output_context_exception.php, class ezcTemplateNoOutputContextException
Exception for for missing output contexts in classes.
- ezcTemplateOutputContext
- in file output_context.php, class ezcTemplateOutputContext
Controls output handling in the template engine.
- ezcTemplateParserException
- in file parser_exception.php, class ezcTemplateParserException
Exception for failed element parsers.
- ezcTemplateRuntimeException
- in file runtime_exception.php, class ezcTemplateRuntimeException
ezcTemplateRuntimeException is thrown when an error occurs while executing a template. For example when a {use} variable without a default value is not given.
- ezcTemplateSourceToTstParserException
- in file source_to_tst_parser_exception.php, class ezcTemplateSourceToTstParserException
Exception for failed element parsers.
- ezcTemplateTypeHintException
- in file typehint_exception.php, class ezcTemplateTypeHintException
Exception for problems in parser element code.
- ezcTemplateVariableCollection
- in file variable_collection.php, class ezcTemplateVariableCollection
Contains template variables which are sent and received from templates.
- ezcTemplateXhtmlContext
- in file xhtml_context.php, class ezcTemplateXhtmlContext
The ezcTemplateXhtmlContext class escapes special HTML characters in the output.
Letter 'f'
- file_failed_rename_exception.php
- procedural page file_failed_rename_exception.php
- file_failed_unlink_exception.php
- procedural page file_failed_unlink_exception.php
- file_not_found_exception.php
- procedural page file_not_found_exception.php
- file_not_readable_exception.php
- procedural page file_not_readable_exception.php
- file_not_writeable_exception.php
- procedural page file_not_writeable_exception.php
Letter 'g'
- generateOptionHash
- in file template.php, method ezcTemplate::generateOptionHash()
Generates a unique hash from the current options.
- getCustomBlockDefinition
- in file custom_block.php, method ezcTemplateCustomBlock::getCustomBlockDefinition()
Return a ezcTemplateCustomBlockDefinition for the given block $name.
- getCustomFunctionDefinition
- in file custom_function.php, method ezcTemplateCustomFunction::getCustomFunctionDefinition()
Return a ezcTemplateCustomFunctionDefinition for the given function $name.
- getErrorMessage
- in file source_to_tst_parser_exception.php, method ezcTemplateSourceToTstParserException::getErrorMessage()
Generates the error message from member variables and returns it.
- getErrorMessage
- in file parser_exception.php, method ezcTemplateParserException::getErrorMessage()
Generates the error message from member variables and returns it.
- getInstance
- in file configuration.php, method ezcTemplateConfiguration::getInstance()
Returns the unique configuration instance named $name.
- getPath
- in file location.php, method ezcTemplateLocation::getPath()
Implement this method to return the path to the template source.
- getVariableArray
- in file variable_collection.php, method ezcTemplateVariableCollection::getVariableArray()
Returns all variables in an array.
Letter 'h'
- $hasCloseTag
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$hasCloseTag
Specifies whether the class has an open and close tag or only a open tag.
Letter 'i'
- $isStatic
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$isStatic
- identifier
- in file no_context.php, method ezcTemplateNoContext::identifier()
Returns the unique identifier for the context handler.
- identifier
- in file output_context.php, method ezcTemplateOutputContext::identifier()
Returns the unique identifier for the context handler. This is used to uniquely identify the handler, e.g. it is included in the path of compiled files.
- identifier
- in file xhtml_context.php, method ezcTemplateXhtmlContext::identifier()
Returns the unique identifier for the context handler.
- includeTemplate
- in file cache_manager.php, method ezcTemplateCacheManager::includeTemplate()
This method is called by the template engine when another template is included.
- isValid
- in file cache_manager.php, method ezcTemplateCacheManager::isValid()
The isValid method is called by ezcTemplate to verify whether the cache is valid.
- internal_exception.php
- procedural page internal_exception.php
- invalid_compiled_file_exception.php
- procedural page invalid_compiled_file_exception.php
Letter 'k'
- key
- in file variable_collection.php, method ezcTemplateVariableCollection::key()
Returns the current key.
Letter 'l'
- location.php
- procedural page location.php
- locator.php
- procedural page locator.php
Letter 'm'
- $method
- in file custom_function_definition.php, variable ezcTemplateCustomFunctionDefinition::$method
Holds the (static) method that should be run.
- $method
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$method
Holds the (static) method that should be run.
Letter 'n'
- next
- in file variable_collection.php, method ezcTemplateVariableCollection::next()
Proceed to the next element.
- no_context.php
- procedural page no_context.php
- no_manager_exception.php
- procedural page no_manager_exception.php
- no_output_context_exception.php
- procedural page no_output_context_exception.php
Letter 'o'
- $optionalParameters
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$optionalParameters
Holds the optional named parameters for this custom block.
- outdated_compilation_exception.php
- procedural page outdated_compilation_exception.php
- output_context.php
- procedural page output_context.php
Letter 'p'
- $parameters
- in file custom_function_definition.php, variable ezcTemplateCustomFunctionDefinition::$parameters
Holds the required and optional named parameters for this custom function.
- process
- in file template.php, method ezcTemplate::process()
Processes the specified template source and returns the output string.
- parser_exception.php
- procedural page parser_exception.php
Letter 'r'
- $requiredParameters
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$requiredParameters
Holds the required named parameters for this custom block.
- register
- in file cache_manager.php, method ezcTemplateCacheManager::register()
The user application should call this method to register values used in the current cache creation.
- removeVariable
- in file variable_collection.php, method ezcTemplateVariableCollection::removeVariable()
Removes the variable named $name from the collection.
- rewind
- in file variable_collection.php, method ezcTemplateVariableCollection::rewind()
Iterator rewind method
- runtime_exception.php
- procedural page runtime_exception.php
Letter 's'
- $sendTemplateObject
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$sendTemplateObject
Whether or not the Template object is available in the custom block.
- $sendTemplateObject
- in file custom_function_definition.php, variable ezcTemplateCustomFunctionDefinition::$sendTemplateObject
Whether or not the Template object is available in the custom function.
- $source
- in file source_to_tst_parser_exception.php, variable ezcTemplateSourceToTstParserException::$source
The source code object which caused the error.
- $source
- in file parser_exception.php, variable ezcTemplateParserException::$source
The source code object which caused the error.
- $startCursor
- in file parser_exception.php, variable ezcTemplateParserException::$startCursor
Cursor of the parsed line.
- $startExpressionName
- in file custom_block_definition.php, variable ezcTemplateCustomBlockDefinition::$startExpressionName
Holds the first parameter of a custom block without a name.
- startCaching
- in file cache_manager.php, method ezcTemplateCacheManager::startCaching()
The template engine calls this method when a new cache file will be created.
- stopCaching
- in file cache_manager.php, method ezcTemplateCacheManager::stopCaching()
The stopCaching method is called by the Template Engine when the cache file is created.
- source_to_tst_parser_exception.php
- procedural page source_to_tst_parser_exception.php
- string_tool.php
- procedural page string_tool.php
Letter 't'
- template_exception.php
- procedural page template_exception.php
- tst_node_exception.php
- procedural page tst_node_exception.php
- typehint_exception.php
- procedural page typehint_exception.php
- template.php
- procedural page template.php
- transformOutput
- in file xhtml_context.php, method ezcTemplateXhtmlContext::transformOutput()
Escapes special HTML characters in the output.
- transformOutput
- in file no_context.php, method ezcTemplateNoContext::transformOutput()
Doesn't change the output, and returns exactly the same node.
- transformOutput
- in file output_context.php, method ezcTemplateOutputContext::transformOutput()
Transforms an expressions so it can be displayed in the current output context correctly.
- translatePath
- in file locator.php, method ezcTemplateLocator::translatePath()
Method that is called upon every request for a template file.
Letter 'u'
- update
- in file cache_manager.php, method ezcTemplateCacheManager::update()
The user application should call this method when the value changes that is previously registered with the register() method.
Letter 'v'
- $variableArgumentList
- in file custom_function_definition.php, variable ezcTemplateCustomFunctionDefinition::$variableArgumentList
Whether or not the custom function can have an undefined amount of parameters.
- variable_collection.php
- procedural page variable_collection.php
- valid
- in file variable_collection.php, method ezcTemplateVariableCollection::valid()
Returns true if the iterator is at a valid location.
Letter 'x'
- xhtml_context.php
- procedural page xhtml_context.php