Class: Smarty

Source Location: /smarty/libs/Smarty.class.php

Class Overview [line 64]


Author(s):

Version:

Copyright:

Variables

Constants

Methods


Child classes:

Smarty_Compiler
Template compiling class
Smarty_Wrapper
Smarty template wrapper. Used to retrieve a smarty object tailored for CookingSpecial use.

Inherited Variables

Inherited Constants

Inherited Methods



Class Details

[ Top ]


Class Variables

$autoload_filters = array()

[line 338]

This indicates which filters are automatically loaded into Smarty.

Smarty Configuration Section

Tags:

  • var - array of filter names

Type: array

Overrides:

[ Top ]

$cache_dir =   'cache'

[line 167]

The name of the directory for cache files.

Smarty Configuration Section

Type: string

Overrides:

[ Top ]

$cache_handler_func =  null

[line 331]

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

Smarty Configuration Section

Tags:

  • var - function name

Type: null|string

Overrides:

[ Top ]

$cache_lifetime =   3600

[line 178]

This is the number of seconds cached content will persist.

Smarty Configuration Section

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

Type: integer

Overrides:

[ Top ]

$cache_modified_check =  false

[line 188]

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

Overrides:

[ Top ]

$caching =   0

[line 160]

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

Overrides:

[ Top ]

$compiler_class =    'Smarty_Compiler'

[line 392]

The class used for compiling templates.

Type: string

Overrides:

[ Top ]

$compiler_file =     'Smarty_Compiler.class.php'

[line 385]

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

Type: string

Overrides:

[ Top ]

$compile_check =   true

[line 141]

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

Overrides:

[ Top ]

$compile_dir =   'templates_c'

[line 82]

The directory where compiled templates are located.

Smarty Configuration Section

Type: string

Overrides:

[ Top ]

$compile_id =  null

[line 291]

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

Overrides:

[ Top ]

$config_booleanize =  true

[line 354]

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

Overrides:

[ Top ]

$config_class =    'Config_File'

[line 399]

The class used to load config vars.

Type: string

Overrides:

[ Top ]

$config_dir =   'configs'

[line 89]

The directory where config files are located.

Smarty Configuration Section

Type: string

Overrides:

[ Top ]

$config_fix_newlines =  true

[line 368]

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

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

Type: boolean

Overrides:

[ Top ]

$config_overwrite =  true

[line 347]

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

Overrides:

[ Top ]

$config_read_hidden =  false

[line 362]

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

Overrides:

[ Top ]

$debugging =   false

[line 105]

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

Overrides:

[ Top ]

$debugging_ctrl =   'NONE'

[line 131]

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.

Tags:

Type: string

Overrides:

[ Top ]

$debug_tpl =   ''

[line 120]

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

Smarty Configuration Section

Type: string

Overrides:

[ Top ]

$default_modifiers = array()

[line 310]

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

Overrides:

[ Top ]

$default_resource_type =  'file'

[line 324]

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

Overrides:

[ Top ]

$default_template_handler_func =  ''

[line 377]

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

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

Tags:

  • var - function name

Type: string

Overrides:

[ Top ]

$error_reporting =   null

[line 112]

When set, smarty does uses this value as error_reporting-level.

Smarty Configuration Section

Type: boolean

Overrides:

[ Top ]

$force_compile =   false

[line 149]

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

Smarty Configuration Section

Type: boolean

Overrides:

[ Top ]

$left_delimiter =   '{'

[line 255]

The left delimiter used for the template tags.

Smarty Configuration Section

Type: string

Overrides:

[ Top ]

$php_handling =   SMARTY_PHP_PASSTHRU

[line 202]

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

Overrides:

[ Top ]

$plugins_dir = array('plugins')

[line 96]

An array of directories searched for plugins.

Smarty Configuration Section

Type: array

Overrides:

[ Top ]

$request_use_auto_globals =  true

[line 281]

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

Overrides:

[ Top ]

$request_vars_order =  'EGPCS'

[line 271]

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

Overrides:

[ Top ]

$right_delimiter =   '}'

[line 262]

The right delimiter used for the template tags.

Smarty Configuration Section

Type: string

Overrides:

[ Top ]

$secure_dir = array()

[line 221]

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

Overrides:

[ Top ]

$security =    false

[line 212]

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

Overrides:

[ Top ]

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

[line 229]

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

Smarty Configuration Section

Type: array

Overrides:

[ Top ]

$template_dir =   'templates'

[line 75]

The name of the directory where templates are located.

Smarty Configuration Section

Type: string

Overrides:

[ Top ]

$trusted_dir = array()

[line 248]

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

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

Type: array

Overrides:

[ Top ]

$use_sub_dirs =  false

[line 301]

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

Overrides:

[ Top ]


Class Methods

Smarty

Smarty Smarty( )

[line 568]

The class constructor.

Parameters:

[ Top ]

append

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

[line 612]

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

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

[line 652]

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

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

[line 580]

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

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

[line 600]

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

void clear_all_assign( )

[line 1003]

clear all the assigned template variables.

Parameters:

[ Top ]

clear_all_cache

boolean clear_all_cache( [string $exp_time = null])

[line 967]

clear the entire contents of cache (all templates)

Tags:

Parameters:

  • string $exp_time - expire time

[ Top ]

clear_assign

void clear_assign( string $tpl_var)

[line 674]

clear the given assigned template variable.

Parameters:

  • string $tpl_var - the template variable to clear

[ Top ]

clear_cache

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

[line 935]

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

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

[line 1018]

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.

Tags:

Parameters:

  • string $tpl_file -
  • string $compile_id -
  • string $exp_time -

[ Top ]

clear_config

void clear_config( [string $var = null])

[line 1345]

clear configuration values

Parameters:

  • string $var -

[ Top ]

config_load

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

[line 1318]

load configuration values

Parameters:

  • string $file -
  • string $section -
  • string $scope -

[ Top ]

display

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

[line 1103]

executes & displays the template results

Parameters:

  • string $resource_name -
  • string $cache_id -
  • string $compile_id -

[ Top ]

fetch

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

[line 1116]

executes & returns or displays the template results

Parameters:

  • string $resource_name -
  • string $cache_id -
  • string $compile_id -
  • boolean $display -

[ Top ]

get_config_vars

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

[line 1071]

Returns an array containing config variables

Parameters:

  • string $name -
  • string $type -

[ Top ]

get_registered_object

object &get_registered_object( string $name)

[line 1330]

return a reference to a registered object

Parameters:

  • string $name -

[ Top ]

get_template_vars

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

[line 1051]

Returns an array containing template variables

Parameters:

  • string $name -
  • string $type -

[ Top ]

is_cached

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

[line 981]

test to see if valid cache exists for this template

Tags:

  • return - results of _read_cache_file()

Parameters:

  • string $tpl_file - name of template file
  • string $cache_id -
  • string $compile_id -

[ Top ]

load_filter

void load_filter( string $type, string $name)

[line 909]

load a filter of specified type and name

Parameters:

  • string $type - filter type
  • string $name - filter name

[ Top ]

register_block

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

[line 741]

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

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

[line 763]

Registers compiler function

Parameters:

  • string $function - name of template function
  • string $function_impl - name of PHP function to register
  • $cacheable -

[ Top ]

register_function

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

[line 690]

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

void register_modifier( string $modifier, string $modifier_impl)

[line 785]

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

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

[line 716]

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

void register_outputfilter( callback $function)

[line 887]

Registers an output filter function to apply to a template output

Parameters:

  • callback $function -

[ Top ]

register_postfilter

void register_postfilter( callback $function)

[line 865]

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

Parameters:

  • callback $function -

[ Top ]

register_prefilter

void register_prefilter( callback $function)

[line 843]

Registers a prefilter function to apply to a template before compiling

Parameters:

  • callback $function -

[ Top ]

register_resource

void register_resource( string $type, array $functions)

[line 807]

Registers a resource to fetch a template

Parameters:

  • string $type - name of resource
  • array $functions - array of functions to handle resource

[ Top ]

template_exists

boolean template_exists( string $tpl_file)

[line 1038]

Checks whether requested template exists.

Parameters:

  • string $tpl_file -

[ Top ]

trigger_error

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

[line 1090]

trigger Smarty error

Parameters:

  • string $error_msg -
  • integer $error_type -

[ Top ]

unregister_block

void unregister_block( string $block)

[line 752]

Unregisters block function

Parameters:

  • string $block - name of template function

[ Top ]

unregister_compiler_function

void unregister_compiler_function( string $function)

[line 774]

Unregisters compiler function

Parameters:

  • string $function - name of template function

[ Top ]

unregister_function

void unregister_function( string $function)

[line 702]

Unregisters custom function

Parameters:

  • string $function - name of template function

[ Top ]

unregister_modifier

void unregister_modifier( string $modifier)

[line 796]

Unregisters modifier

Parameters:

  • string $modifier - name of template modifier

[ Top ]

unregister_object

void unregister_object( string $object)

[line 729]

Unregisters object

Parameters:

  • string $object - name of template object

[ Top ]

unregister_outputfilter

void unregister_outputfilter( callback $function)

[line 898]

Unregisters an outputfilter function

Parameters:

  • callback $function -

[ Top ]

unregister_postfilter

void unregister_postfilter( callback $function)

[line 876]

Unregisters a postfilter function

Parameters:

  • callback $function -

[ Top ]

unregister_prefilter

void unregister_prefilter( callback $function)

[line 854]

Unregisters a prefilter function

Parameters:

  • callback $function -

[ Top ]

unregister_resource

void unregister_resource( string $type)

[line 832]

Unregisters a resource

Parameters:

  • string $type - name of resource

[ Top ]

_compile_resource

boolean _compile_resource( string $resource_name, string $compile_path)

[line 1410]

compile the template

Parameters:

  • string $resource_name -
  • string $compile_path -

[ Top ]

_compile_source

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

[line 1447]

compile the given source

Parameters:

  • string $resource_name -
  • string $source_content -
  • string $compiled_content -
  • &$source_content -
  • &$compiled_content -
  • $cache_include_path -

[ Top ]

_dequote

string _dequote( string $string)

[line 1696]

Remove starting and ending quotes from the string

Parameters:

  • string $string -

[ Top ]

_eval

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

[line 1931]

wrapper for eval() retaining $this

Parameters:

  • $code -
  • $params -

[ Top ]

_fetch_resource_info

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

[line 1530]

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 -

[ Top ]

_get_auto_filename

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

[line 1736]

get a concrete filename for automagically created content

Tags:

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

Parameters:

  • string $auto_base -
  • string $auto_source -
  • string $auto_id -

[ Top ]

_get_auto_id

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

[line 1786]

returns an auto_id for auto-file-functions

Parameters:

  • string $cache_id -
  • string $compile_id -

[ Top ]

_get_compile_path

string _get_compile_path( string $resource_name)

[line 1510]

Get the compile path for this resource

Tags:

Parameters:

  • string $resource_name -

[ Top ]

_get_filter_name

string _get_filter_name( callback $function)

[line 1942]

Extracts the filter name from the given callback

Parameters:

  • callback $function -

[ Top ]

_get_plugin_filepath

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

[line 1363]

get filepath of requested plugin

Parameters:

  • string $type -
  • string $name -

[ Top ]

_include

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

[line 1917]

wrapper for include() retaining $this

Parameters:

  • $filename -
  • $once -
  • $params -

[ Top ]

_is_compiled

boolean _is_compiled( string $resource_name, string $compile_path)

[line 1377]

test if resource needs compiling

Parameters:

  • string $resource_name -
  • string $compile_path -

[ Top ]

_parse_resource_name

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

[line 1614]

parse out the type and name from the resource

Parameters:

  • string $resource_base_path -
  • string $resource_name -
  • string $resource_type -
  • &$params -

[ Top ]

_process_compiled_include_callback

string _process_compiled_include_callback( $match)

[line 1825]

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

Parameters:

  • $match -

[ Top ]

_read_file

string _read_file( string $filename)

[line 1712]

read in a file

Parameters:

  • string $filename -

[ Top ]

_run_mod_handler

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

[line 1675]

Handle modifiers

Tags:

  • return - result of modifiers

Parameters:

  • string|null $modifier_name -
  • array|null $map_array -

[ Top ]

_smarty_cache_attrs

array &_smarty_cache_attrs( $cache_serial, $count)

[line 1894]

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

not cacheable

Parameters:

  • $cache_serial -
  • $count -

[ Top ]

_smarty_include

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

[line 1844]

called for included templates

Parameters:

  • string $_smarty_include_tpl_file -
  • string $_smarty_include_vars -
  • $params -

[ Top ]

_trigger_fatal_error

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

[line 1805]

trigger Smarty plugin error

Parameters:

  • string $error_msg -
  • string $tpl_file -
  • integer $tpl_line -
  • string $file -
  • integer $line -
  • integer $error_type -

[ Top ]

_unlink

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

[line 1768]

unlink a file, possibly using expiration time

Parameters:

  • string $resource -
  • integer $exp_time -

[ Top ]


Class Constants


Documentation generated on Tue, 26 May 2009 14:50:37 -0700 by phpDocumentor 1.4.1