Path

ez components / documentation / api reference / 1.1 / template


eZ Components 1.1

Template

[ Tutorial ] [ EBNF ] [ Functions ] [ Syntax ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Element index for package Template

[ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ k ] [ l ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ v ] [ x ] [ _ ]

_

__construct : ezcTemplateParseException
in file parse_exception.php, method ezcTemplateParseException::__construct()
    Initialises the exception with the original template file path and the new file path.
__construct : ezcTemplateParserException
in file parser_exception.php, method ezcTemplateParserException::__construct()
    Initialises the exception with the failing elements, parser, source code and error messages.
__construct : ezcTemplateConfiguration
in file configuration.php, method ezcTemplateConfiguration::__construct()
    Initialises the configuration with default template, compiled path, and context.
__construct : ezcTemplateNoManagerException
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 : ezcTemplate
in file template.php, method ezcTemplate::__construct()
    Intializes the ezcTemplate with the default settings.
__construct : ezcTemplateTypeHintException
in file typehint_exception.php, method ezcTemplateTypeHintException::__construct()
    This exception should be caught, and rethrown. The message is not important.
__construct : ezcTemplateVariableWrongTypeException
in file variable_wrong_type_exception.php, method ezcTemplateVariableWrongTypeException::__construct()
    Initialises the exception with the name, expected and actual type value. The error text is automatically generated.
__construct : ezcTemplateVariableWrongDirectionException
in file variable_wrong_direction_exception.php, method ezcTemplateVariableWrongDirectionException::__construct()
    Initialises the exception with the name, expected and actual direction value. The error text is automatically generated.
__construct : ezcTemplateVariableUndefinedException
in file variable_undefined_exception.php, method ezcTemplateVariableUndefinedException::__construct()
    Initialises the exception with the name of the variable. The error text is automatically generated.
__construct : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::__construct()
    Initialises an empty collection of variables.
__construct : ezcTemplateLocatorNotFoundException
in file locator_not_found_exception.php, method ezcTemplateLocatorNotFoundException::__construct()
    Initialises the exception with the location object $location which contains the locator which is missing.
__construct : ezcTemplateNoOutputContextException
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 : ezcTemplateFileFailedRenameException
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 : ezcTemplateInvalidCompiledFileException
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 : ezcTemplateSourceToTstParserException
in file element_parser_exception.php, method ezcTemplateSourceToTstParserException::__construct()
    Initialises the exception with the failing elements, parser, source code and error messages.
__construct : ezcTemplateTstNodeException
in file element_exception.php, method ezcTemplateTstNodeException::__construct()
    Initialises the exception with the type of error which automatically generates an exception message.
__construct : ezcTemplateFileFailedUnlinkException
in file file_failed_unlink_exception.php, method ezcTemplateFileFailedUnlinkException::__construct()
    Initialises the exception with the template file path.
__construct : ezcTemplateFileNotFoundException
in file file_not_found_exception.php, method ezcTemplateFileNotFoundException::__construct()
    Initialises the exception with the template file path.
__construct : ezcTemplateFileNotWriteableException
in file file_not_writeable_exception.php, method ezcTemplateFileNotWriteableException::__construct()
__construct : ezcTemplateFileNotReadableException
in file file_not_readable_exception.php, method ezcTemplateFileNotReadableException::__construct()
    Initialises the exception with the template file path.
__get : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::__get()
    Returns the value of the variable $name.
__get : ezcTemplateConfiguration
in file configuration.php, method ezcTemplateConfiguration::__get()
    Returns the value of the property $name.
__get : ezcTemplate
in file template.php, method ezcTemplate::__get()
    Returns the value of the property $name.
__isset : ezcTemplateConfiguration
in file configuration.php, method ezcTemplateConfiguration::__isset()
    Returns true if the property $name is set, otherwise false.
__isset : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::__isset()
    Returns true if the variable $name is set.
__isset : ezcTemplate
in file template.php, method ezcTemplate::__isset()
    Returns true if the property $name is set, otherwise false.
__set : ezcTemplate
in file template.php, method ezcTemplate::__set()
    Sets the property $name to $value.
__set : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::__set()
    Sets the value $value to the variable $name.
__set : ezcTemplateConfiguration
in file configuration.php, method ezcTemplateConfiguration::__set()
    Sets the property $name to the value $value

c

cleanupEol : ezcTemplateXhtmlContext
in file xhtml_context.php, method ezcTemplateXhtmlContext::cleanupEol()
    Does nothing.
cleanupEol : ezcTemplateOutputContext
in file output_context.php, method ezcTemplateOutputContext::cleanupEol()
cleanupEol : ezcTemplateNoContext
in file no_context.php, method ezcTemplateNoContext::cleanupEol()
    Does nothing.
cleanupWhitespace : ezcTemplateXhtmlContext
in file xhtml_context.php, method ezcTemplateXhtmlContext::cleanupWhitespace()
    Does nothing.
cleanupWhitespace : ezcTemplateOutputContext
in file output_context.php, method ezcTemplateOutputContext::cleanupWhitespace()
cleanupWhitespace : ezcTemplateNoContext
in file no_context.php, method ezcTemplateNoContext::cleanupWhitespace()
    Does nothing.
current : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::current()
    Returns the current variable
configuration.php
procedural page configuration.php

d

directionName : ezcTemplateVariableWrongDirectionException
in file variable_wrong_direction_exception.php, method ezcTemplateVariableWrongDirectionException::directionName()

e

$elements : ezcTemplateSourceToTstParserException
in file element_parser_exception.php, variable ezcTemplateSourceToTstParserException::$elements
    Array of elements which should be used to extract failed code.
$errorCursor : ezcTemplateParserException
in file parser_exception.php, variable ezcTemplateParserException::$errorCursor
    Cursor where the error occured.
$errorDetails : ezcTemplateParserException
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.
$errorDetails : ezcTemplateSourceToTstParserException
in file element_parser_exception.php, variable ezcTemplateSourceToTstParserException::$errorDetails
    A more detailed error message which can for instance give hints to the end-user why it failed.
$errorMessage : ezcTemplateSourceToTstParserException
in file element_parser_exception.php, variable ezcTemplateSourceToTstParserException::$errorMessage
    The one-liner error message.
$errorMessage : ezcTemplateParserException
in file parser_exception.php, variable ezcTemplateParserException::$errorMessage
    The one-liner error message.
ezcTemplate
in file template.php, class ezcTemplate
    The ezcTemplate class provides the main interface for processing templates.
ezcTemplateConfiguration
in file configuration.php, class ezcTemplateConfiguration
    Contains the common configuration options for template managers.
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.
ezcTemplateInvalidCompiledFileException
in file invalid_compiled_file_exception.php, class ezcTemplateInvalidCompiledFileException
    Exception for missing invalid compiled files.
ezcTemplateLocatorNotFoundException
in file locator_not_found_exception.php, class ezcTemplateLocatorNotFoundException
    Exception for missing locator handlers in the template manager. The tried location object is passed to the constructor.
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.
ezcTemplateParseException
in file parse_exception.php, class ezcTemplateParseException
    Exception for problems when renaming template files.
ezcTemplateParserException
in file parser_exception.php, class ezcTemplateParserException
    Exception for failed element parsers.
ezcTemplateSourceToTstParserException
in file element_parser_exception.php, class ezcTemplateSourceToTstParserException
    Exception for failed element parsers.
ezcTemplateTstNodeException
in file element_exception.php, class ezcTemplateTstNodeException
    Exception for problems in parser element code.
ezcTemplateTypeHintException
in file typehint_exception.php, class ezcTemplateTypeHintException
    Exception for problems in parser element code.
ezcTemplateVariableCollection
in file variable_collection.php, class ezcTemplateVariableCollection
    Contains the template variables.
ezcTemplateVariableUndefinedException
in file variable_undefined_exception.php, class ezcTemplateVariableUndefinedException
    Exception for undefined template variables.
ezcTemplateVariableWrongDirectionException
in file variable_wrong_direction_exception.php, class ezcTemplateVariableWrongDirectionException
    Exception for problems with direction of template variables.
ezcTemplateVariableWrongTypeException
in file variable_wrong_type_exception.php, class ezcTemplateVariableWrongTypeException
    Exception for problems with type of template variables.
ezcTemplateXhtmlContext
in file xhtml_context.php, class ezcTemplateXhtmlContext
    The ezcTemplateXhtmlContext class escapes special HTML characters in the output.
element_exception.php
procedural page element_exception.php
element_parser_exception.php
procedural page element_parser_exception.php

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

g

generateOptionHash : ezcTemplate
in file template.php, method ezcTemplate::generateOptionHash()
    Generates a unique hash from the current options.
getErrorMessage : ezcTemplateParserException
in file parser_exception.php, method ezcTemplateParserException::getErrorMessage()
    Generates the error message from member variables and returns it.
getErrorMessage : ezcTemplateSourceToTstParserException
in file element_parser_exception.php, method ezcTemplateSourceToTstParserException::getErrorMessage()
    Generates the error message from member variables and returns it.
getInstance : ezcTemplateConfiguration
in file configuration.php, method ezcTemplateConfiguration::getInstance()
    Returns the unique configuration instance named $name.
getVariableArray : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::getVariableArray()
    Returns all variables in an array.

i

identifier : ezcTemplateXhtmlContext
in file xhtml_context.php, method ezcTemplateXhtmlContext::identifier()
    Returns the unique identifier for the context handler.
identifier : ezcTemplateOutputContext
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 : ezcTemplateNoContext
in file no_context.php, method ezcTemplateNoContext::identifier()
    Returns the unique identifier for the context handler.
indent : ezcTemplateXhtmlContext
in file xhtml_context.php, method ezcTemplateXhtmlContext::indent()
    Does nothing.
indent : ezcTemplateOutputContext
in file output_context.php, method ezcTemplateOutputContext::indent()
indent : ezcTemplateNoContext
in file no_context.php, method ezcTemplateNoContext::indent()
    Does nothing.
invalid_compiled_file_exception.php
procedural page invalid_compiled_file_exception.php

k

key : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::key()
    Returns the current key.

l

locator_not_found_exception.php
procedural page locator_not_found_exception.php

n

INVALID_PROGRAM_ELEMENT : ezcTemplateParseException
in file parse_exception.php, class constant ezcTemplateParseException::INVALID_PROGRAM_ELEMENT
    The element passed to the program parser is not valid at the program context.
next : ezcTemplateVariableCollection
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

o

NO_FIRST_CHILD : ezcTemplateTstNodeException
in file element_exception.php, class constant ezcTemplateTstNodeException::NO_FIRST_CHILD
    Element has no children, cannot get first child.
NO_LAST_CHILD : ezcTemplateTstNodeException
in file element_exception.php, class constant ezcTemplateTstNodeException::NO_LAST_CHILD
    Element has no children, cannot get last child.
NO_SOURCE_CODE : ezcTemplateParseException
in file parse_exception.php, class constant ezcTemplateParseException::NO_SOURCE_CODE
    No source code was found in source object.
output_context.php
procedural page output_context.php

p

process : ezcTemplate
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
parse_exception.php
procedural page parse_exception.php

r

removeVariable : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::removeVariable()
    Removes the variable named $name from the collection.
rewind : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::rewind()
    Iterator rewind method

s

$source : ezcTemplateSourceToTstParserException
in file element_parser_exception.php, variable ezcTemplateSourceToTstParserException::$source
    The source code object which caused the error.
$source : ezcTemplateParserException
in file parser_exception.php, variable ezcTemplateParserException::$source
    The source code object which caused the error.
$startCursor : ezcTemplateParserException
in file parser_exception.php, variable ezcTemplateParserException::$startCursor
    Cursor of the parsed line.

t

typehint_exception.php
procedural page typehint_exception.php
template.php
procedural page template.php
transformOutput : ezcTemplateXhtmlContext
in file xhtml_context.php, method ezcTemplateXhtmlContext::transformOutput()
    Escapes special HTML characters in the output.
transformOutput : ezcTemplateOutputContext
in file output_context.php, method ezcTemplateOutputContext::transformOutput()
    Transforms an expressions so it can be displayed in the current output context correctly.
transformOutput : ezcTemplateNoContext
in file no_context.php, method ezcTemplateNoContext::transformOutput()
    Doesn't change the output, and returns exactly the same node.

v

variable_undefined_exception.php
procedural page variable_undefined_exception.php
variable_wrong_direction_exception.php
procedural page variable_wrong_direction_exception.php
variable_wrong_type_exception.php
procedural page variable_wrong_type_exception.php
variable_collection.php
procedural page variable_collection.php
valid : ezcTemplateVariableCollection
in file variable_collection.php, method ezcTemplateVariableCollection::valid()
    Returns true if the iterator is at a valid location.

x

xhtml_context.php
procedural page xhtml_context.php
Last updated: Wed, 28 Nov 2007