sfTemplateEngine Class

All Classes

sfTemplateAutoloader: sfTemplateAutoloader is an autoloader for the templating classes.
sfTemplateDebuggerInterface: sfTemplateLoaderDebuggerInterface is the interface you need to implement
sfTemplateEngine: sfTemplateEngine is the main class of the templating component.
sfTemplateHelper: sfTemplateHelper is the base class for all helper classes.
sfTemplateHelperAssets: sfTemplateHelperAssets is the base class for all helper classes that manages assets.
sfTemplateHelperInterface: sfTemplateHelperInterface is the interface all helpers must implement.
sfTemplateHelperJavascripts: sfTemplateHelperJavascripts is a helper that manages JavaScripts.
sfTemplateHelperSet: sfTemplateHelperSet represents a set of helpers to be used with a templating engine.
sfTemplateHelperStylesheets: sfTemplateHelperStylesheets is a helper that manages stylesheets.
sfTemplateLoader: sfTemplateLoader is the base class for all template loader classes.
sfTemplateLoaderCache: sfTemplateLoaderCache is a loader that caches other loaders responses
sfTemplateLoaderChain: sfTemplateLoaderChain is a loader that calls other loaders to load templates.
sfTemplateLoaderCompilableInterface: sfTemplateLoaderCompilableInterface is the interface a template loader must implement
sfTemplateLoaderFilesystem: sfTemplateLoaderFilesystem is a loader that read templates from the filesystem.
sfTemplateLoaderInterface: sfTemplateLoaderInterface is the interface all loaders must implement.
sfTemplateRenderer: sfTemplateRenderer is the base class for all template renderer.
sfTemplateRendererInterface: sfTemplateRendererInterface is the interface all renderer classes must implement.
sfTemplateRendererPhp: sfTemplateRendererPhp is a renderer for PHP templates.
sfTemplateStorage: sfTemplateRenderer is the base class for all storage classes.
sfTemplateStorageFile: sfTemplateStorageFile represents a template stored on the filesystem.
sfTemplateStorageString: sfTemplateStorageFile represents a template stored in a string.

RELEASE INFORMATION

You are currently browsing the API for the trunk version.

sfTemplateEngine is the main class of the templating component.

METHODS
`__construct()`	constructor.
`render()`	renders a template.
`setHelperSet()`	sets a helper value.
`getHelperSet()`	gets all helper values.
`__get()`	gets a helper value.
`extend()`	decorates the current template with another one.
`start()`	starts a new slot.
`stop()`	stops a slot.
`has()`	returns true if the slot exists.
`get()`	gets the slot value.
`set()`	sets a slot value.
`output()`	outputs a slot.
`escape()`	escapes a string by using the current charset.
`setCharset()`	sets the charset to use.
`getCharset()`	gets the current charset.

__construct($loader, $renderers, $helperSet)

Constructor.

ARGUMENTS
`$loader`	A loader instance
`$renderers`	An array of renderer instances
`$helperSet`	A helper set instance

(string) render($name, $parameters)

Renders a template.

ARGUMENTS
`$name`	A template logical name
`$parameters`	An array of parameters to pass to the template

returns The evaluated template as a string

throws InvalidArgumentException if the renderer does not exist or if the template does not exist

setHelperSet($name, $value)

Sets a helper value.

ARGUMENTS

$name The helper name

$value The helper value
(array) getHelperSet()

Gets all helper values.

returns An array of all helper values
(mixed) __get($name)

Gets a helper value.

ARGUMENTS

$name The helper name

returns The helper value

throws InvalidArgumentException if the helper is not defined
extend($template)

Decorates the current template with another one.

ARGUMENTS

$template The decorator logical name
start($name)

Starts a new slot.

This method starts an output buffer that will be
closed when the stop() method is called.

ARGUMENTS

$name The slot name

throws InvalidArgumentException if a slot with the same name is already started
stop()

Stops a slot.

throws LogicException if no slot has been started
has($name)

Returns true if the slot exists.

ARGUMENTS

$name The slot name
(string) get($name, $default)

Gets the slot value.

ARGUMENTS

$name The slot name

$default The default slot content

returns The slot content
set($name, $content)

Sets a slot value.

ARGUMENTS

$name The slot name

$content The slot content
(Boolean) output($name, $default)

Outputs a slot.

ARGUMENTS

$name The slot name

$default The default slot content

returns true if the slot is defined or if a default content has been provided, false otherwise
(string) escape($value)

Escapes a string by using the current charset.

ARGUMENTS

$value A string to escape

returns The escaped string or the original value if not a string
setCharset($charset)

Sets the charset to use.

ARGUMENTS

$charset The charset
(string) getCharset()

Gets the current charset.

returns The current charset

Templating

Simple yet powerful templating framework

sfTemplateEngine Class

All Classes

RELEASE INFORMATION

__construct($loader, $renderers, $helperSet)

(string) render($name, $parameters)

setHelperSet($name, $value)

(array) getHelperSet()

(mixed) __get($name)

extend($template)

start($name)

stop()

has($name)

(string) get($name, $default)

set($name, $content)

(Boolean) output($name, $default)

(string) escape($value)

setCharset($charset)

(string) getCharset()

Open-Source Products

Services

Templating Simple yet powerful templating framework

sfTemplateEngine Class

All Classes

RELEASE INFORMATION

__construct($loader, $renderers, $helperSet)

(string) render($name, $parameters)

setHelperSet($name, $value)

(array) getHelperSet()

(mixed) __get($name)

extend($template)

start($name)

stop()

has($name)

(string) get($name, $default)

set($name, $content)

(Boolean) output($name, $default)

(string) escape($value)

setCharset($charset)

(string) getCharset()

Open-Source Products

Services

Templating

Simple yet powerful templating framework