Smarty
[ class tree: Smarty ] [ index: Smarty ] [ all elements ]

Class: Smarty

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Smarty-2.6.0/libs/Smarty.class.php

Class Overview




Variables

Methods


Child classes:

Smarty_Compiler
Template compiling class

Inherited Variables

Inherited Methods


Class Details

[line 73]


[ Top ]


Class Variables

$autoload_filters = array()

[line 357]

This indicates which filters are automatically loaded into Smarty.

Smarty Configuration Section

  • Var: array of filter names

Type:   array


[ Top ]

$cache_dir =   'cache'

[line 169]

The name of the directory for cache files.

Smarty Configuration Section


Type:   string


[ Top ]

$cache_handler_func =  null

[line 333]

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

Smarty Configuration Section

  • Var: function name

Type:   null|string


[ Top ]

$cache_lifetime =   3600

[line 180]

This is the number of seconds cached content will persist.

Smarty Configuration Section

  • 0 = always regenerate cache
  • -1 = never expires


Type:   integer


[ Top ]

$cache_modified_check =  false

[line 190]

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.


Type:   boolean


[ Top ]

$caching =   0

[line 162]

This enables template caching.

Smarty Configuration Section

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


Type:   integer


[ Top ]

$compiler_class =    'Smarty_Compiler'

[line 411]

The class used for compiling templates.

Type:   string


[ Top ]

$compiler_file =     'Smarty_Compiler.class.php'

[line 404]

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

Type:   string


[ Top ]

$compile_check =   true

[line 143]

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.


Type:   boolean


[ Top ]

$compile_dir =   'templates_c'

[line 91]

The directory where compiled templates are located.

Smarty Configuration Section


Type:   string


[ Top ]

$compile_id =  null

[line 293]

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'.


Type:   string


[ Top ]

$config_booleanize =  true

[line 373]

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.


Type:   boolean


[ Top ]

$config_class =    'Config_File'

[line 418]

The class used to load config vars.

Type:   string


[ Top ]

$config_dir =   'configs'

[line 98]

The directory where config files are located.

Smarty Configuration Section


Type:   string


[ Top ]

$config_fix_newlines =  true

[line 387]

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

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


Type:   boolean


[ Top ]

$config_overwrite =  true

[line 366]

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.


Type:   boolean


[ Top ]

$config_read_hidden =  false

[line 381]

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.

Type:   boolean


[ Top ]

$debugging =   false

[line 114]

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


Type:   boolean


[ Top ]

$debugging_ctrl =   'NONE'

[line 133]

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.


Type:   string


[ Top ]

$debug_tpl =   ''

[line 122]

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

Smarty Configuration Section


Type:   string


[ Top ]

$default_modifiers = array()

[line 312]

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:

  1. array('escape:"htmlall"');


Type:   array


[ Top ]

$default_resource_type =  'file'

[line 326]

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 *}


Type:   array


[ Top ]

$default_template_handler_func =  ''

[line 396]

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

Type:   string


[ Top ]

$force_compile =   false

[line 151]

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

Smarty Configuration Section


Type:   boolean


[ Top ]

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

[line 343]

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


Type:   array


[ Top ]

$left_delimiter =   '{'

[line 257]

The left delimiter used for the template tags.

Smarty Configuration Section


Type:   string


[ Top ]

$php_handling =   SMARTY_PHP_PASSTHRU

[line 204]

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


Type:   integer


[ Top ]

$plugins_dir = array('plugins')

[line 105]

An array of directories searched for plugins.

Smarty Configuration Section


Type:   array


[ Top ]

$request_use_auto_globals =  false

[line 283]

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"


Type:   boolean


[ Top ]

$request_vars_order =  "EGPCS"

[line 273]

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


Type:   string


[ Top ]

$right_delimiter =   '}'

[line 264]

The right delimiter used for the template tags.

Smarty Configuration Section


Type:   string


[ Top ]

$secure_dir = array()

[line 223]

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


Type:   array


[ Top ]

$security =    false

[line 214]

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)


Type:   boolean


[ Top ]

$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]

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

Smarty Configuration Section


Type:   array


[ Top ]

$template_dir =   'templates'

[line 84]

The name of the directory where templates are located.

Smarty Configuration Section


Type:   string


[ Top ]

$trusted_dir = array()

[line 250]

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

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


Type:   array


[ Top ]

$undefined =   null

[line 350]

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

Smarty Configuration Section


Type:   null


[ Top ]

$use_sub_dirs =  true

[line 303]

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


Type:   boolean


[ Top ]



Method Detail

Smarty (Constructor)   [line 597]

Smarty Smarty( )

The class constructor.

[ Top ]

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   — 

[ Top ]

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   — 

[ Top ]

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

[ Top ]

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   — 

[ Top ]

clear_all_assign   [line 1062]

void clear_all_assign( )

clear all the assigned template variables.

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

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   — 

[ Top ]

clear_config   [line 1381]

void clear_config( [string $var = null])

clear configuration values

Parameters:

string   $var   — 

[ Top ]

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   — 

[ Top ]

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   — 

[ Top ]

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   — 

[ Top ]

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   — 

[ Top ]

get_registered_object   [line 1366]

object &get_registered_object( string $name)

return a reference to a registered object

Parameters:

string   $name   — 

[ Top ]

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   — 

[ Top ]

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
  • Return: results of _read_cache_file()

Parameters:

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

[ Top ]

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

[ Top ]

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   — 

[ Top ]

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   — 

[ Top ]

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   — 

[ Top ]

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

[ Top ]

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   — 

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

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

[ Top ]

template_exists   [line 1097]

boolean template_exists( string $tpl_file)

Checks whether requested template exists.

Parameters:

string   $tpl_file   — 

[ Top ]

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   — 

[ Top ]

unregister_block   [line 797]

void unregister_block( string $block)

Unregisters block function

Parameters:

string   $block   —  name of template function

[ Top ]

unregister_compiler_function   [line 819]

void unregister_compiler_function( string $function)

Unregisters compiler function

Parameters:

string   $function   —  name of template function

[ Top ]

unregister_function   [line 747]

void unregister_function( string $function)

Unregisters custom function

Parameters:

string   $function   —  name of template function

[ Top ]

unregister_modifier   [line 841]

void unregister_modifier( string $modifier)

Unregisters modifier

Parameters:

string   $modifier   —  name of template modifier

[ Top ]

unregister_object   [line 774]

void unregister_object( string $object)

Unregisters object

Parameters:

string   $object   —  name of template object

[ Top ]

unregister_outputfilter   [line 946]

void unregister_outputfilter( string $function)

Unregisters an outputfilter function

Parameters:

string   $function   —  name of PHP function

[ Top ]

unregister_postfilter   [line 923]

void unregister_postfilter( string $function)

Unregisters a postfilter function

Parameters:

string   $function   —  name of PHP function

[ Top ]

unregister_prefilter   [line 900]

void unregister_prefilter( string $function)

Unregisters a prefilter function

Parameters:

string   $function   —  name of PHP function

[ Top ]

unregister_resource   [line 877]

void unregister_resource( string $type)

Unregisters a resource

Parameters:

string   $type   —  name of resource

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:50:33 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.