Methods

assign

This is used to assign values to the templates. You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs.

// passing name/value pairs
$smarty->assign("Name","Fred");
$smarty->assign("Address",$address);

// passing an associative array
$smarty->assign(array("city" => "Lincoln","state" => "Nebraska"));

append

This is used to append data to variables in the template. You can explicitly pass name/value pairs, or associative arrays containing the name/value pairs.

// passing name/value pairs
$smarty->append("Name","Fred");
$smarty->append("Address",$address);

// passing an associative array
$smarty->append(array("city" => "Lincoln","state" => "Nebraska"));

clear_assign

This clears the value of an assigned variable. This can be a single value, or an array of values. Array functionality was added to Smarty 1.3.0.

// clear a single variable
$smarty->clear_assign("Name");

// clear multiple variables
$smarty->clear_assign(array("Name","Address","Zip"));

clear_all_assign

This clears the values of all assigned variables.

// clear all assigned variables
$smarty->clear_all_assign();

clear_cache

This clears the cache for the specified template. If you have multiple caches for this template, you can clear a specific cache by supplying the cache id as the second parameter. See the caching section for more information. This was added to Smarty 1.3.0.

// clear the cache for a template
$smarty->clear_cache("index.tpl");

// clear the cache for a particular cache id in an multiple-cache template
$smarty->clear_cache("index.tpl","CACHEID");

clear_all_cache

This clears the entire template cache. This was added to Smarty 1.3.0.

// clear the entire cache
$smarty->clear_all_cache();

clear_compiled_tpl

This clears the compiled version of the specified template resource, or all compiled template files if one is not specified. This function is for advanced use only, not normally needed.

// clear a specific template resource
$smarty->clear_compiled_tpl("index.tpl");

// clear entire compile directory
$smarty->clear_compiled_tpl();

register_function

Use this to dynamically register template function plugins. Pass in the template function name, followed by the PHP function name that implements it.

$smarty->register_function("date_now", "print_current_date");

function print_current_date ($params) {
    extract($params);
    if(empty($format))
        $format="%b %e, %Y";
    echo strftime($format,time());
}

// now you can use this in Smarty to print the current date: {date_now}
// or, {date_now format="%Y/%m/%d"} to format it.

unregister_function

Use this to dynamically unregister template function plugin. Pass in the template function name.

// we don't want template designers to have access to system files

$smarty->unregister_function("fetch");

register_modifier

Use this to dynamically register modifier plugin. Pass in the template modifier name, followed by the PHP function that it implements it.

// let's map PHP's stripslashes function to a Smarty modifier.

$smarty->register_modifier("sslash","stripslashes");

// now you can use {$var|sslash} to strip slashes from variables

unregister_modifier

Use this to dynamically unregister modifier plugin. Pass in the template modifier name.

// we don't want template designers to strip tags from elements

$smarty->unregister_modifier("strip_tags");

register_resource

Use this to dynamically register a resource plugin with Smarty. Pass in the name of the resource and the array of PHP functions implementing it. See template resources for more information on how to setup a function for fetching templates.

$smarty->register_resource("db", array("db_get_template",
                                       "db_get_timestamp",
                                       "db_get_secure",
                                       "db_get_trusted"));

unregister_resource

Use this to dynamically unregister a resource plugin. Pass in the name of the resource.

$smarty->unregister_resource("db");

register_prefilter

Use this to dynamically register prefilters to run templates through before they are compiled. See template prefilters for more information on how to setup a prefiltering function.

unregister_prefilter

Use this to dynamically unregister a prefilter.

register_postfilter

Use this to dynamically register postfilters to run templates through after they are compiled. See template postfilters for more information on how to setup a postfiltering function.

unregister_postfilter

Use this to dynamically unregister a postfilter.

register_compiler_function

Use this to dynamically register a compiler function plugin. Pass in the compiler function name, followed by the PHP function that implements it.

unregister_compiler_function

Use this to dynamically unregister a compiler function. Pass in the name of the compiler function.

trigger_error

This function can be used to output an error message using Smarty. level parameter can be one of the values used for trigger_error() PHP function, i.e. E_USER_NOTICE, E_USER_WARNING, etc. By default it's E_USER_WARNING. This function was added to Smarty 2.0.

is_cached

This returns true if there is a valid cache for this template. This only works if caching is set to true. This was added to Smarty 1.3.0.

$smarty->caching = true;

if(!$smarty->is_cached("index.tpl")) {
    // do database calls, assign vars here
}

$smarty->display("index.tpl");

You can also pass a cache id as an an optional second parameter in case you want multiple caches for the given template.

$smarty->caching = true;

if(!$smarty->is_cached("index.tpl","FrontPage")) {
    // do database calls, assign vars here
}

$smarty->display("index.tpl","FrontPage");

get_template_vars

This gets an array of the currently assigned template vars.

// get all assigned template vars
$tpl_vars = $smarty->get_template_vars();

// take a look at them
var_dump($tpl_vars);

display

This displays the template. Supply a valid template resource type and path. As an optional second parameter, you can pass a cache id. See the caching section for more information.

As an optional third parameter, you can pass a compile id. This is in the event that you want to compile different versions of the same template, such as having separate templates compiled for different languages. This was added to Smarty 1.4.5.

include("Smarty.class.php");
$smarty = new Smarty;
$smarty->caching = true;

// only do db calls if cache doesn't exist
if(!$smarty->is_cached("index.tpl"))
{

    // dummy up some data
    $address = "245 N 50th";
    $db_data = array(
	    "City" => "Lincoln",
	    "State" => "Nebraska",
	    "Zip" = > "68502"
	    );

    $smarty->assign("Name","Fred");
    $smarty->assign("Address",$address);
    $smarty->assign($db_data);

}

// display the output
$smarty->display("index.tpl");

Use the syntax for template resources to display files outside of the $template_dir directory.

// absolute filepath
$smarty->display("/usr/local/include/templates/header.tpl");

// absolute filepath (same thing)
$smarty->display("file:/usr/local/include/templates/header.tpl");

// windows absolute filepath (MUST use "file:" prefix)
$smarty->display("file:C:/www/pub/templates/header.tpl");

// include from template resource named "db"
$smarty->display("db:header.tpl");

fetch

This returns the template output instead of displaying it. Supply a valid template resource type and path. As an optional second parameter, you can pass a cache id. See the caching section for more information.

As an optional third parameter, you can pass a compile id. This is in the event that you want to compile different versions of the same template, such as having separate templates compiled for different languages. This was added to Smarty 1.4.5.

include("Smarty.class.php");
$smarty = new Smarty;

$smarty->caching = true;

// only do db calls if cache doesn't exist
if(!$smarty->is_cached("index.tpl"))
{

    // dummy up some data
    $address = "245 N 50th";
    $db_data = array(
	    "City" => "Lincoln",
	    "State" => "Nebraska",
	    "Zip" = > "68502"
	    );

    $smarty->assign("Name","Fred");
    $smarty->assign("Address",$address);
    $smarty->assign($db_data);

}

// capture the output
$output = $smarty->fetch("index.tpl");

// do something with $output here

echo $output;