YANA 4 PHP Framework
Docs For Class SmartTemplate
«decorator» SmartTemplate
This implements a decorator class for the smarty template engine. The use of the "decorator" pattern actually means it "implements an API" on top of the original.
Note that this does not touch or even change the engine itself.
This class provides two things: most obviously it provides some features, that smarty does not have and in addition it does some more type checking and automates the initialization process.
Located in /includes/class_smarttemplate.php
Object | --SmartTemplate
Class | Description |
---|---|
Mailer | create and send mails based on templates |
Name | Type | Description |
---|---|---|
$filename | string | (optional) |
You may enter a filename of a template you want to use.
Name | Type | Description |
---|---|---|
$anotherObject | object |
Returns bool(true) if this object and $anotherObject are equal and bool(false) otherwise.
Two instances are considered equal if and only if they are both objects of the same class and they both refer to the same filesystem resource.
Redefinition of: Object::equals()
Name | Type | Description |
---|---|---|
$key | string | variable-name |
$overwrite | bool | true = on / false = off |
There are three ways to call this function:
If you call $smartTemplate->get($varName) it will get the template var $varName and return it.
If you call $smartTemplate->get("*") with the wildcard '*' or an empty string '' it will return an associative array containing all template vars.
If you call $smartTemplate->get() without a parameter it will fetch the current template and return it as a string.
If the $key parameter is NULL, the second parameter can be used to change the way how variables are imported from the global registry to the template. If set to false, existing template vars will not be replaced by vars of the same name in the registry. Otherwise template vars will get overwritten if the global registry has another value.
Returns a string containing the path and filename of the current template relative to the framework's home directory.
This function is used to unbox the smarty instance inside the object. It may be used to bypass the template class in cases where direct access to the smarty template engine is necessary.
Name | Type | Description |
---|---|---|
$varName | string | address |
$var | mixed | some new value |
This assigns the $var to the name $varName.
Unlike Smarty's "assign()" this function takes an additional value for $varName:
You may use the wildcard '*' to:
Name | Type | Description |
---|---|---|
$varName | string | address |
&$var | mixed | some new value |
This assigns the $var to the name $varName.
Unlike Smarty's "assign()" this function takes an additional value for $varName:
You may use the wildcard '*' to:
Name | Type | Description |
---|---|---|
$varName | string | |
$filename | string |
Load a file and assign it's content as a string to the provided template var.
You may use the wildcard '*' to assign the file content to the global token %INSERT_CONTENT_HERE%
Name | Type | Description |
---|---|---|
$filename | string | name of the template file |
You may set another filename of a template to fetch.
Template files may not have a reserved extension like "htaccess", "php", "config" or the like. Files should be adressed from the root, where "index.php" is stored. If you can't access a file, the file does not exist or is not readable, an error is thrown.
This function will fetch and print the current template to the screen
Inherited From Object
Documentation generated on Sun, 11 Mar 2007 15:02:44 +0100 by phpDocumentor 1.3.1