Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Interface class for Zend_View compatible template engine implementations

__isset(
string $key
)
:
boolean
Allows testing with empty() and isset() to work
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
boolean |

__set(
string $key, mixed $val
)
:
void
Assign a variable to the view
Name | Type | Description |
---|---|---|
$key | string | The variable name. |
$val | mixed | The variable value. |

__unset(
string $key
)
:
void
Allows unset() on object properties to work
Name | Type | Description |
---|---|---|
$key | string |

addBasePath(
string $path, string $classPrefix
=
'Zend_View'
)
:
void
Add an additional path to view resources
Name | Type | Description |
---|---|---|
$path | string | |
$classPrefix | string |

assign(
string|array $spec, mixed $value
=
null
)
:
void
Assign variables to the view script via differing strategies.
Suggested implementation is to allow setting a specific key to the specified value, OR passing an array of key => value pairs to set en masse.
Name | Type | Description |
---|---|---|
$spec | string|array | The assignment strategy to use (key or array of key => value pairs) |
$value | mixed | (Optional) If assigning a named variable, use this as the value. |

clearVars(
)
:
void
Clear all assigned variables
Clears all variables assigned to Zend_View either via {@link assign()} or property overloading ({@link __get()}/{@link __set()}).

getEngine(
)
:
mixed
Return the template engine object, if any
If using a third-party template engine, such as Smarty, patTemplate, phplib, etc, return the template engine object. Useful for calling methods on these objects, such as for setting filters, modifiers, etc.
Type | Description |
---|---|
mixed |

render(
string $name
)
:
string
Processes a view script and returns the output.
Name | Type | Description |
---|---|---|
$name | string | The script name to process. |
Type | Description |
---|---|
string | The script output. |

setBasePath(
string $path, string $classPrefix
=
'Zend_View'
)
:
void
Set a base path to all view resources
Name | Type | Description |
---|---|---|
$path | string | |
$classPrefix | string |