Docs For Class Smarty

Description

Located in File: /phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php

Classes extended from Smarty:

Smarty_Compiler: Template compiling class

Class Variables

Summary:

array $autoload_filters

string $cache_dir

null|string $cache_handler_func

integer $cache_lifetime

boolean $cache_modified_check

integer $caching

string $compiler_class

string $compiler_file

boolean $compile_check

string $compile_dir

string $compile_id

boolean $config_booleanize

string $config_class

string $config_dir

boolean $config_fix_newlines

boolean $config_overwrite

boolean $config_read_hidden

boolean $debugging

string $debugging_ctrl

string $debug_tpl

array $default_modifiers

array $default_resource_type

string $default_template_handler_func

boolean $force_compile

array $global_assign

string $left_delimiter

integer $php_handling

array $plugins_dir

boolean $request_use_auto_globals

string $request_vars_order

string $right_delimiter

array $secure_dir

boolean $security

array $security_settings

string $template_dir

array $trusted_dir

null $undefined

boolean $use_sub_dirs

$autoload_filters = array() (line 357)

Data type : array

This indicates which filters are automatically loaded into Smarty.

Smarty Configuration Section

var: - array of filter names

$cache_dir = 'cache' (line 169)

Data type : string

The name of the directory for cache files.

Smarty Configuration Section

$cache_handler_func = null (line 333)

Data type : null|string

The function used for cache file handling. If not set, built-in caching is used.

Smarty Configuration Section

var: - function name

$cache_lifetime = 3600 (line 180)

Data type : integer

This is the number of seconds cached content will persist.

Smarty Configuration Section

0 = always regenerate cache
-1 = never expires

$cache_modified_check = false (line 190)

Data type : boolean

Only used when $caching is enabled. If true, then If-Modified-Since headers are respected with cached content, and appropriate HTTP headers are sent.

Smarty Configuration Section This way repeated hits to a cached page do not send the entire page to the client every time.

$caching = 0 (line 162)

Data type : integer

This enables template caching.

Smarty Configuration Section

0 = no caching
1 = use class cache_lifetime value
2 = use cache_lifetime in cache file

$compiler_class = 'Smarty_Compiler' (line 411)

Data type : string

The class used for compiling templates.

$compiler_file = 'Smarty_Compiler.class.php' (line 404)

Data type : string

The file that contains the compiler class. This can a full pathname, or relative to the php_include path.

$compile_check = true (line 143)

Data type : boolean

This tells Smarty whether to check for recompiling or not. Recompiling does not need to happen unless a template or config file is changed.

Smarty Configuration Section Typically you enable this during development, and disable for production.

$compile_dir = 'templates_c' (line 91)

Data type : string

The directory where compiled templates are located.

Smarty Configuration Section

$compile_id = null (line 293)

Data type : string

Set this if you want different sets of compiled files for the same templates. This is useful for things like different languages.

Smarty Configuration Section Instead of creating separate sets of templates per language, you set different compile_ids like 'en' and 'de'.

$config_booleanize = true (line 373)

Data type : boolean

This tells whether or not to automatically booleanize config file variables.

If enabled, then the strings "on", "true", and "yes" are treated as boolean true, and "off", "false" and "no" are treated as boolean false.

$config_class = 'Config_File' (line 418)

Data type : string

The class used to load config vars.

$config_dir = 'configs' (line 98)

Data type : string

The directory where config files are located.

Smarty Configuration Section

$config_fix_newlines = true (line 387)

Data type : boolean

This tells whether or not automatically fix newlines in config files.

It basically converts \r (mac) or \r\n (dos) to \n

$config_overwrite = true (line 366)

Data type : boolean

This tells if config file vars of the same name overwrite each other or not.

if disabled, same name variables are accumulated in an array.

$config_read_hidden = false (line 381)

Data type : boolean

This tells whether hidden sections [.foobar] are readable from the tempalates or not. Normally you would never allow this since that is the point behind hidden sections: the application can access them, but the templates cannot.

$debugging = false (line 114)

Data type : boolean

If debugging is enabled, a debug console window will display when the page loads (make sure your browser allows unrequested popup windows)

Smarty Configuration Section

$debugging_ctrl = 'NONE' (line 133)

Data type : string

This determines if debugging is enable-able from the browser.

Smarty Configuration Section

NONE => no debugging control allowed
URL => enable debugging when SMARTY_DEBUG is found in the URL.

link: - http://www.foo.dom/index.php?SMARTY_DEBUG

$debug_tpl = '' (line 122)

Data type : string

This is the path to the debug console template. If not set, the default one will be used.

Smarty Configuration Section

$default_modifiers = array() (line 312)

Data type : array

This is a list of the modifiers to apply to all template variables.

Smarty Configuration Section Put each modifier in a separate array element in the order you want them applied. example:

array('escape:"htmlall"');

$default_resource_type = 'file' (line 326)

Data type : array

This is the resource type to be used when not specified

Smarty Configuration Section at the beginning of the resource path. examples: $smarty->display('file:index.tpl'); $smarty->display('db:index.tpl'); $smarty->display('index.tpl'); // will use default resource type {include file="file:index.tpl"} {include file="db:index.tpl"} {include file="index.tpl"} {* will use default resource type *}

$default_template_handler_func = '' (line 396)

Data type : string

If a template cannot be found, this PHP function will be executed.

Useful for creating templates on-the-fly or other special action.

var: - function name

$force_compile = false (line 151)

Data type : boolean

This forces templates to compile every time. Useful for development or debugging.

Smarty Configuration Section

$global_assign = array('HTTP_SERVER_VARS' => array('SCRIPT_NAME')) (line 343)

Data type : array

These are the variables from the globals array that are assigned to all templates automatically. This isn't really necessary any more, you can use the $smarty var to access them directly.

Smarty Configuration Section

usedby: - Smarty::Smarty() - uses assign() to assign each corresponding value from $GLOBALS to the template vars

$left_delimiter = '{' (line 257)

Data type : string

The left delimiter used for the template tags.

Smarty Configuration Section

$php_handling = SMARTY_PHP_PASSTHRU (line 204)

Data type : integer

This determines how Smarty handles "<?php ... ?>" tags in templates.

Smarty Configuration Section possible values:

SMARTY_PHP_PASSTHRU -> print tags as plain text
SMARTY_PHP_QUOTE -> escape tags as entities
SMARTY_PHP_REMOVE -> remove php tags
SMARTY_PHP_ALLOW -> execute php tags

$plugins_dir = array('plugins') (line 105)

Data type : array

An array of directories searched for plugins.

Smarty Configuration Section

$request_use_auto_globals = false (line 283)

Data type : boolean

Indicates wether $HTTP_*_VARS[] (request_use_auto_globals=false)

Smarty Configuration Section are uses as request-vars or $_*[]-vars. note: if request_use_auto_globals is true, then $request_vars_order has no effect, but the php-ini-value "gpc_order"

$request_vars_order = "EGPCS" (line 273)

Data type : string

The order in which request variables are registered, similar to variables_order in php.ini E = Environment, G = GET, P = POST, C = Cookies, S = Server

Smarty Configuration Section

$right_delimiter = '}' (line 264)

Data type : string

The right delimiter used for the template tags.

Smarty Configuration Section

$secure_dir = array() (line 223)

Data type : array

This is the list of template directories that are considered secure. This is used only if $security is enabled. One directory per array element. $template_dir is in this list implicitly.

Smarty Configuration Section

$security = false (line 214)

Data type : boolean

This enables template security. When enabled, many things are restricted

Smarty Configuration Section in the templates that normally would go unchecked. This is useful when untrusted parties are editing templates and you want a reasonable level of security. (no direct execution of PHP in templates for example)

$security_settings = array(
'PHP_HANDLING' => false,
'IF_FUNCS' => array('array', 'list',
'isset', 'empty',
'count', 'sizeof',
'in_array', 'is_array',
'true','false'),'INCLUDE_ANY'=>false,'PHP_TAGS'=>false,'MODIFIER_FUNCS'=>array('count'),'ALLOW_CONSTANTS'=>false) (line 231)

Data type : array

These are the security settings for Smarty. They are used only when $security is enabled.

Smarty Configuration Section

$template_dir = 'templates' (line 84)

Data type : string

The name of the directory where templates are located.

Smarty Configuration Section

$trusted_dir = array() (line 250)

Data type : array

This is an array of directories where trusted php scripts reside.

Smarty Configuration Section $security is disabled during their inclusion/execution.

$undefined = null (line 350)

Data type : null

The value of "undefined". Leave it alone :-)

Smarty Configuration Section

$use_sub_dirs = true (line 303)

Data type : boolean

This tells Smarty whether or not to use sub dirs in the cache/ and templates_c/ directories. sub directories better organized, but may not work well with PHP safe mode enabled.

Smarty Configuration Section

Class Constants

Summary:

Method Detail

Summary:

Smarty Smarty ()

void append (array|string $tpl_var, [mixed $value = null], [ $merge = false])

void append_by_ref (string $tpl_var, &$value, [ $merge = false], mixed $value)

void assign (array|string $tpl_var, [mixed $value = null])

void assign_by_ref (string $tpl_var, &$value, mixed $value)

void clear_all_assign ()

boolean clear_all_cache ([string $exp_time = null])

void clear_assign (string $tpl_var)

boolean clear_cache ([string $tpl_file = null], [string $cache_id = null], [string $compile_id = null], [string $exp_time = null])

boolean clear_compiled_tpl ([string $tpl_file = null], [string $compile_id = null], [string $exp_time = null])

void clear_config ([string $var = null])

void config_load (string $file, [string $section = null], [string $scope = 'global'])

void display (string $resource_name, [string $cache_id = null], [string $compile_id = null])

void fetch (string $resource_name, [string $cache_id = null], [string $compile_id = null], [boolean $display = false])

array &get_config_vars ([string $name = null], string $type)

object &get_registered_object (string $name)

array &get_template_vars ([string $name = null], string $type)

string|false is_cached (string $tpl_file, [string $cache_id = null], [string $compile_id = null])

void load_filter (string $type, string $name)

void register_block (string $block, string $block_impl, [ $cacheable = true], [ $cache_attrs = null])

void register_compiler_function (string $function, string $function_impl, [ $cacheable = true])

void register_function (string $function, string $function_impl, [ $cacheable = true], [ $cache_attrs = null])

void register_modifier (string $modifier, string $modifier_impl)

void register_object (string $object, object &$object_impl, [null|array $allowed = array()], [boolean $smarty_args = true], [ $block_methods = array()], null|array $block_functs)

void register_outputfilter (string $function)

void register_postfilter (string $function)

void register_prefilter (string $function)

void register_resource (string $type, array $functions)

boolean template_exists (string $tpl_file)

void trigger_error (string $error_msg, [integer $error_type = E_USER_WARNING])

void unregister_block (string $block)

void unregister_compiler_function (string $function)

void unregister_function (string $function)

void unregister_modifier (string $modifier)

void unregister_object (string $object)

void unregister_outputfilter (string $function)

void unregister_postfilter (string $function)

void unregister_prefilter (string $function)

void unregister_resource (string $type)

boolean _compile_resource (string $resource_name, string $compile_path)

boolean _compile_source (string $resource_name, &$source_content, &$compiled_content, [ $cache_include_path = null], string $source_content, string $compiled_content)

string _dequote (string $string)

mixed _eval ( $code, [ $params = null])

boolean _fetch_resource_info ( &$params, string $resource_name, string $source_content, integer $resource_timestamp, boolean $get_source, boolean $quiet)

string _get_auto_filename (string $auto_base, [string $auto_source = null], [string $auto_id = null])

string|null _get_auto_id ([string $cache_id = null], [string $compile_id = null])

string _get_compile_path (string $resource_name)

string|false _get_plugin_filepath (string $type, string $name)

mixed _include ( $filename, [ $once = false], [ $params = null])

boolean _is_compiled (string $resource_name, string $compile_path)

boolean _parse_resource_name ( &$params, string $resource_base_path, string $resource_name, string $resource_type)

string _process_compiled_include_callback ( $match)

string _read_file (string $filename, [integer $start = null], [integer $lines = null])

string _run_mod_handler (string|null $modifier_name, array|null $map_array)

array &_smarty_cache_attrs ( $cache_serial, $count)

void _smarty_include ( $params, string $_smarty_include_tpl_file, string $_smarty_include_vars)

void _trigger_fatal_error (string $error_msg, [string $tpl_file = null], [integer $tpl_line = null], [string $file = null], [integer $line = null], [integer $error_type = E_USER_ERROR])

void _unlink (string $resource, [integer $exp_time = null])

Constructor Smarty (line 597)

Smarty Smarty( )

The class constructor.

Info

uses - Smarty::$global_assign - uses assign() to assign each corresponding value from $GLOBALS to the template vars

Method append (line 657)

void append( array|string $tpl_var, [mixed $value = null], [ $merge = false])

appends values to template variables

Parameters

array|string $tpl_var: the template variable name(s)
mixed $value: the value to append
$merge:

Info

Method append_by_ref (line 697)

void append_by_ref( string $tpl_var, &$value, [ $merge = false], mixed $value)

appends values to template variables by reference

Parameters

string $tpl_var: the template variable name
mixed $value: the referenced value to append
&$value:
$merge:

Info

Method assign (line 625)

void assign( array|string $tpl_var, [mixed $value = null])

assigns values to template variables

Parameters

array|string $tpl_var: the template variable name(s)
mixed $value: the value to assign

Info

Method assign_by_ref (line 645)

void assign_by_ref( string $tpl_var, &$value, mixed $value)

assigns values to template variables by reference

Parameters

string $tpl_var: the template variable name
mixed $value: the referenced value to assign
&$value:

Info

Method clear_all_assign (line 1062)

void clear_all_assign( )

clear all the assigned template variables.

Info

Method clear_all_cache (line 1015)

boolean clear_all_cache( [string $exp_time = null])

clear the entire contents of cache (all templates)

Parameters

string $exp_time: expire time

Info

return - results of smarty_core_rm_auto()

Method clear_assign (line 719)

void clear_assign( string $tpl_var)

clear the given assigned template variable.

Parameters

string $tpl_var: the template variable to clear

Info

Method clear_cache (line 983)

boolean clear_cache( [string $tpl_file = null], [string $cache_id = null], [string $compile_id = null], [string $exp_time = null])

clear cached content for the given template and cache id

Parameters

string $tpl_file: name of template file
string $cache_id: name of cache_id
string $compile_id: name of compile_id
string $exp_time: expiration time

Info

Method clear_compiled_tpl (line 1077)

boolean clear_compiled_tpl( [string $tpl_file = null], [string $compile_id = null], [string $exp_time = null])

clears compiled version of specified template resource, or all compiled template files if one is not specified.

This function is for advanced use only, not normally needed.

Parameters

string $tpl_file:
string $compile_id:
string $exp_time:

Info

return - results of smarty_core_rm_auto()

Method clear_config (line 1381)

void clear_config( [string $var = null])

clear configuration values

Parameters

string $var:

Info

Method config_load (line 1354)

void config_load( string $file, [string $section = null], [string $scope = 'global'])

load configuration values

Parameters

string $file:
string $section:
string $scope:

Info

Method display (line 1155)

void display( string $resource_name, [string $cache_id = null], [string $compile_id = null])

executes & displays the template results

Parameters

string $resource_name:
string $cache_id:
string $compile_id:

Info

Method fetch (line 1168)

void fetch( string $resource_name, [string $cache_id = null], [string $compile_id = null], [boolean $display = false])

executes & returns or displays the template results

Parameters

string $resource_name:
string $cache_id:
string $compile_id:
boolean $display:

Info

Method get_config_vars (line 1127)

array &get_config_vars( [string $name = null], string $type)

Returns an array containing config variables

Parameters

string $name:
string $type:

Info

Method get_registered_object (line 1366)

object &get_registered_object( string $name)

return a reference to a registered object

Parameters

string $name:

Info

Method get_template_vars (line 1110)

array &get_template_vars( [string $name = null], string $type)

Returns an array containing template variables

Parameters

string $name:
string $type:

Info

Method is_cached (line 1040)

string|false is_cached( string $tpl_file, [string $cache_id = null], [string $compile_id = null])

test to see if valid cache exists for this template

Parameters

string $tpl_file: name of template file
string $cache_id:
string $compile_id:

Info

return - results of _read_cache_file()

Method load_filter (line 957)

void load_filter( string $type, string $name)

load a filter of specified type and name

Parameters

string $type: filter type
string $name: filter name

Info

Method register_block (line 786)

void register_block( string $block, string $block_impl, [ $cacheable = true], [ $cache_attrs = null])

Registers block function to be used in templates

Parameters

string $block: name of template block
string $block_impl: PHP function to register
$cacheable:
$cache_attrs:

Info

Method register_compiler_function (line 808)

void register_compiler_function( string $function, string $function_impl, [ $cacheable = true])

Registers compiler function

Parameters

string $function: name of template function
string $function_impl: name of PHP function to register
$cacheable:

Info

Method register_function (line 735)

void register_function( string $function, string $function_impl, [ $cacheable = true], [ $cache_attrs = null])

Registers custom function to be used in templates

Parameters

string $function: the name of the template function
string $function_impl: the name of the PHP function to register
$cacheable:
$cache_attrs:

Info

Method register_modifier (line 830)

void register_modifier( string $modifier, string $modifier_impl)

Registers modifier to be used in templates

Parameters

string $modifier: name of template modifier
string $modifier_impl: name of PHP function to register

Info

Method register_object (line 761)

void register_object( string $object, object &$object_impl, [null|array $allowed = array()], [boolean $smarty_args = true], [ $block_methods = array()], null|array $block_functs)

Registers object to be used in templates

Parameters

string $object: name of template object
object &$object_impl: the referenced PHP object to register
null|array $allowed: list of allowed methods (empty = all)
boolean $smarty_args: smarty argument format, else traditional
null|array $block_functs: list of methods that are block format
$block_methods:

Info

Method register_outputfilter (line 934)

void register_outputfilter( string $function)

Registers an output filter function to apply to a template output

Parameters

string $function: name of PHP function

Info

Method register_postfilter (line 911)

void register_postfilter( string $function)

Registers a postfilter function to apply to a compiled template after compilation

Parameters

string $function: name of PHP function to register

Info

Method register_prefilter (line 888)

void register_prefilter( string $function)

Registers a prefilter function to apply to a template before compiling

Parameters

string $function: name of PHP function to register

Info

Method register_resource (line 852)

void register_resource( string $type, array $functions)

Registers a resource to fetch a template

Parameters

string $type: name of resource
array $functions: array of functions to handle resource

Info

Method template_exists (line 1097)

boolean template_exists( string $tpl_file)

Checks whether requested template exists.

Parameters

string $tpl_file:

Info

Method trigger_error (line 1142)

void trigger_error( string $error_msg, [integer $error_type = E_USER_WARNING])

trigger Smarty error

Parameters

string $error_msg:
integer $error_type:

Info

Method unregister_block (line 797)

void unregister_block( string $block)

Unregisters block function

Parameters

string $block: name of template function

Info

Method unregister_compiler_function (line 819)

void unregister_compiler_function( string $function)

Unregisters compiler function

Parameters

string $function: name of template function

Info

Method unregister_function (line 747)

void unregister_function( string $function)

Unregisters custom function

Parameters

string $function: name of template function

Info

Method unregister_modifier (line 841)

void unregister_modifier( string $modifier)

Unregisters modifier

Parameters

string $modifier: name of template modifier

Info

Method unregister_object (line 774)

void unregister_object( string $object)

Unregisters object

Parameters

string $object: name of template object

Info

Method unregister_outputfilter (line 946)

void unregister_outputfilter( string $function)

Unregisters an outputfilter function

Parameters

string $function: name of PHP function

Info

Method unregister_postfilter (line 923)

void unregister_postfilter( string $function)

Unregisters a postfilter function

Parameters

string $function: name of PHP function

Info

Method unregister_prefilter (line 900)

void unregister_prefilter( string $function)

Unregisters a prefilter function

Parameters

string $function: name of PHP function

Info

Method unregister_resource (line 877)

void unregister_resource( string $type)

Unregisters a resource

Parameters

string $type: name of resource

Info

Method _compile_resource (line 1446)

boolean _compile_resource( string $resource_name, string $compile_path)

compile the template

Parameters

string $resource_name:
string $compile_path:

Info

Method _compile_source (line 1485)

boolean _compile_source( string $resource_name, &$source_content, &$compiled_content, [ $cache_include_path = null], string $source_content, string $compiled_content)

compile the given source

Parameters

string $resource_name:
string $source_content:
string $compiled_content:
&$source_content:
&$compiled_content:
$cache_include_path:

Info

Method _dequote (line 1732)

string _dequote( string $string)

Remove starting and ending quotes from the string

Parameters

string $string:

Info

Method _eval (line 2000)

mixed _eval( $code, [ $params = null])

wrapper for eval() retaining $this

Parameters

$code:
$params:

Info

Method _fetch_resource_info (line 1565)

boolean _fetch_resource_info( &$params, string $resource_name, string $source_content, integer $resource_timestamp, boolean $get_source, boolean $quiet)

fetch the template info. Gets timestamp, and source if get_source is true

sets $source_content to the source of the template, and $resource_timestamp to its time stamp

Parameters

string $resource_name:
string $source_content:
integer $resource_timestamp:
boolean $get_source:
boolean $quiet:
&$params:

Info

Method _get_auto_filename (line 1796)

string _get_auto_filename( string $auto_base, [string $auto_source = null], [string $auto_id = null])

get a concrete filename for automagically created content

Parameters

string $auto_base:
string $auto_source:
string $auto_id:

Info

staticvar - string|null 1:
staticvar - string|null $_cache_info:

Method _get_auto_id (line 1854)

string|null _get_auto_id( [string $cache_id = null], [string $compile_id = null])

returns an auto_id for auto-file-functions

Parameters

string $cache_id:
string $compile_id:

Info

Method _get_compile_path (line 1545)

string _get_compile_path( string $resource_name)

Get the compile path for this resource

Parameters

string $resource_name:

Info

return - results of _get_auto_filename()

Method _get_plugin_filepath (line 1399)

string|false _get_plugin_filepath( string $type, string $name)

get filepath of requested plugin

Parameters

string $type:
string $name:

Info

Method _include (line 1986)

mixed _include( $filename, [ $once = false], [ $params = null])

wrapper for include() retaining $this

Parameters

$filename:
$once:
$params:

Info

Method _is_compiled (line 1413)

boolean _is_compiled( string $resource_name, string $compile_path)

test if resource needs compiling

Parameters

string $resource_name:
string $compile_path:

Info

Method _parse_resource_name (line 1647)

boolean _parse_resource_name( &$params, string $resource_base_path, string $resource_name, string $resource_type)

parse out the type and name from the resource

Parameters

string $resource_base_path:
string $resource_name:
string $resource_type:
&$params:

Info

Method _process_compiled_include_callback (line 1894)

string _process_compiled_include_callback( $match)

callback function for preg_replace, to call a non-cacheable block

Parameters

$match:

Info

Method _read_file (line 1751)

string _read_file( string $filename, [integer $start = null], [integer $lines = null])

read in a file from line $start for $lines.

read the entire file if $start and $lines are null.

Parameters

string $filename:
integer $start:
integer $lines:

Info

Method _run_mod_handler (line 1711)

string _run_mod_handler( string|null $modifier_name, array|null $map_array)

Handle modifiers

Parameters

string|null $modifier_name:
array|null $map_array:

Info

return - result of modifiers

Method _smarty_cache_attrs (line 1963)

array &_smarty_cache_attrs( $cache_serial, $count)

get or set an array of cached attributes for function that is

not cacheable

Parameters

$cache_serial:
$count:

Info

Method _smarty_include (line 1913)

void _smarty_include( $params, string $_smarty_include_tpl_file, string $_smarty_include_vars)

called for included templates

Parameters

string $_smarty_include_tpl_file:
string $_smarty_include_vars:
$params:

Info

Method _trigger_fatal_error (line 1873)

void _trigger_fatal_error( string $error_msg, [string $tpl_file = null], [integer $tpl_line = null], [string $file = null], [integer $line = null], [integer $error_type = E_USER_ERROR])

trigger Smarty plugin error

Parameters

string $error_msg:
string $tpl_file:
integer $tpl_line:
string $file:
integer $line:
integer $error_type:

Info

Method _unlink (line 1836)

void _unlink( string $resource, [integer $exp_time = null])

unlink a file, possibly using expiration time

Parameters

string $resource:
integer $exp_time: