Public Member Functions | |
Smarty () | |
assign ($tpl_var, $value=null) | |
assign_by_ref ($tpl_var, &$value) | |
append ($tpl_var, $value=null, $merge=false) | |
append_by_ref ($tpl_var, &$value, $merge=false) | |
clear_assign ($tpl_var) | |
register_function ($function, $function_impl, $cacheable=true, $cache_attrs=null) | |
unregister_function ($function) | |
register_object ($object, &$object_impl, $allowed=array(), $smarty_args=true, $block_methods=array()) | |
unregister_object ($object) | |
register_block ($block, $block_impl, $cacheable=true, $cache_attrs=null) | |
unregister_block ($block) | |
register_compiler_function ($function, $function_impl, $cacheable=true) | |
unregister_compiler_function ($function) | |
register_modifier ($modifier, $modifier_impl) | |
unregister_modifier ($modifier) | |
register_resource ($type, $functions) | |
unregister_resource ($type) | |
register_prefilter ($function) | |
unregister_prefilter ($function) | |
register_postfilter ($function) | |
unregister_postfilter ($function) | |
register_outputfilter ($function) | |
unregister_outputfilter ($function) | |
load_filter ($type, $name) | |
clear_cache ($tpl_file=null, $cache_id=null, $compile_id=null, $exp_time=null) | |
clear_all_cache ($exp_time=null) | |
is_cached ($tpl_file, $cache_id=null, $compile_id=null) | |
clear_all_assign () | |
clear_compiled_tpl ($tpl_file=null, $compile_id=null, $exp_time=null) | |
template_exists ($tpl_file) | |
& | get_template_vars ($name=null) |
& | get_config_vars ($name=null) |
trigger_error ($error_msg, $error_type=E_USER_WARNING) | |
display ($resource_name, $cache_id=null, $compile_id=null) | |
fetch ($resource_name, $cache_id=null, $compile_id=null, $display=false) | |
config_load ($file, $section=null, $scope= 'global') | |
& | get_registered_object ($name) |
clear_config ($var=null) | |
_get_plugin_filepath ($type, $name) | |
_is_compiled ($resource_name, $compile_path) | |
_compile_resource ($resource_name, $compile_path) | |
_compile_source ($resource_name, &$source_content, &$compiled_content, $cache_include_path=null) | |
_get_compile_path ($resource_name) | |
_fetch_resource_info (&$params) | |
_parse_resource_name (&$params) | |
_run_mod_handler () | |
_dequote ($string) | |
_read_file ($filename) | |
_get_auto_filename ($auto_base, $auto_source=null, $auto_id=null) | |
_unlink ($resource, $exp_time=null) | |
_get_auto_id ($cache_id=null, $compile_id=null) | |
_trigger_fatal_error ($error_msg, $tpl_file=null, $tpl_line=null, $file=null, $line=null, $error_type=E_USER_ERROR) | |
_process_compiled_include_callback ($match) | |
_smarty_include ($params) | |
& | _smarty_cache_attrs ($cache_serial, $count) |
_include ($filename, $once=false, $params=null) | |
_eval ($code, $params=null) | |
Data Fields | |
$template_dir = 'templates' | |
$compile_dir = 'templates_c' | |
$config_dir = 'configs' | |
$plugins_dir = array('plugins') | |
$debugging = false | |
$error_reporting = null | |
$debug_tpl = '' | |
$debugging_ctrl = 'NONE' | |
$compile_check = true | |
$force_compile = false | |
$caching = 0 | |
$cache_dir = 'cache' | |
$cache_lifetime = 3600 | |
$cache_modified_check = false | |
$php_handling = SMARTY_PHP_PASSTHRU | |
$security = false | |
$secure_dir = array() | |
$security_settings | |
$trusted_dir = array() | |
$left_delimiter = '{' | |
$right_delimiter = '}' | |
$request_vars_order = 'EGPCS' | |
$request_use_auto_globals = true | |
$compile_id = null | |
$use_sub_dirs = false | |
$default_modifiers = array() | |
$default_resource_type = 'file' | |
$cache_handler_func = null | |
$autoload_filters = array() | |
$config_overwrite = true | |
$config_booleanize = true | |
$config_read_hidden = false | |
$config_fix_newlines = true | |
$default_template_handler_func = '' | |
$compiler_file = 'Smarty_Compiler.class.php' | |
$compiler_class = 'Smarty_Compiler' | |
$config_class = 'Config_File' | |
$_tpl_vars = array() | |
$_smarty_vars = null | |
$_sections = array() | |
$_foreach = array() | |
$_tag_stack = array() | |
$_conf_obj = null | |
$_config = array(array('vars' => array(), 'files' => array())) | |
$_smarty_md5 = 'f8d698aea36fcbead2b9d5359ffca76f' | |
$_version = '2.6.10' | |
$_inclusion_depth = 0 | |
$_compile_id = null | |
$_smarty_debug_id = 'SMARTY_DEBUG' | |
$_smarty_debug_info = array() | |
$_cache_info = array() | |
$_file_perms = 0644 | |
$_dir_perms = 0771 | |
$_reg_objects = array() | |
$_plugins | |
$_cache_serials = array() | |
$_cache_include = null | |
$_cache_including = false |
Definition at line 64 of file Smarty.class.src.php.
_compile_resource | ( | $ | resource_name, |
$ | compile_path | ||
) |
compile the template
string | $resource_name | |
string | $compile_path |
Definition at line 1406 of file Smarty.class.src.php.
_compile_source | ( | $ | resource_name, |
&$ | source_content, | ||
&$ | compiled_content, | ||
$ | cache_include_path = null |
||
) |
compile the given source
string | $resource_name | |
string | $source_content | |
string | $compiled_content |
Definition at line 1443 of file Smarty.class.src.php.
_dequote | ( | $ | string ) |
Remove starting and ending quotes from the string
string | $string |
Definition at line 1692 of file Smarty.class.src.php.
_eval | ( | $ | code, |
$ | params = null |
||
) |
wrapper for eval() retaining $this
Definition at line 1942 of file Smarty.class.src.php.
_fetch_resource_info | ( | &$ | params ) |
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
string | $resource_name | |
string | $source_content | |
integer | $resource_timestamp | |
boolean | $get_source | |
boolean | $quiet |
Definition at line 1526 of file Smarty.class.src.php.
_get_auto_filename | ( | $ | auto_base, |
$ | auto_source = null , |
||
$ | auto_id = null |
||
) |
get a concrete filename for automagically created content
string | $auto_base | |
string | $auto_source | |
string | $auto_id |
Definition at line 1747 of file Smarty.class.src.php.
_get_auto_id | ( | $ | cache_id = null , |
$ | compile_id = null |
||
) |
returns an auto_id for auto-file-functions
string | $cache_id | |
string | $compile_id |
Definition at line 1797 of file Smarty.class.src.php.
_get_compile_path | ( | $ | resource_name ) |
Get the compile path for this resource
string | $resource_name |
Definition at line 1506 of file Smarty.class.src.php.
_get_plugin_filepath | ( | $ | type, |
$ | name | ||
) |
get filepath of requested plugin
string | $type | |
string | $name |
Definition at line 1359 of file Smarty.class.src.php.
_include | ( | $ | filename, |
$ | once = false , |
||
$ | params = null |
||
) |
wrapper for include() retaining $this
Definition at line 1928 of file Smarty.class.src.php.
_is_compiled | ( | $ | resource_name, |
$ | compile_path | ||
) |
test if resource needs compiling
string | $resource_name | |
string | $compile_path |
Definition at line 1373 of file Smarty.class.src.php.
_parse_resource_name | ( | &$ | params ) |
parse out the type and name from the resource
string | $resource_base_path | |
string | $resource_name | |
string | $resource_type | |
string | $resource_name |
Definition at line 1610 of file Smarty.class.src.php.
_process_compiled_include_callback | ( | $ | match ) |
callback function for preg_replace, to call a non-cacheable block
Definition at line 1836 of file Smarty.class.src.php.
_read_file | ( | $ | filename ) |
read in a file
string | $filename |
Definition at line 1720 of file Smarty.class.src.php.
_run_mod_handler | ( | ) |
Handle modifiers
string | null | $modifier_name | |
array | null | $map_array |
Definition at line 1671 of file Smarty.class.src.php.
& _smarty_cache_attrs | ( | $ | cache_serial, |
$ | count | ||
) |
get or set an array of cached attributes for function that is not cacheable
Definition at line 1905 of file Smarty.class.src.php.
_smarty_include | ( | $ | params ) |
called for included templates
string | $_smarty_include_tpl_file | |
string | $_smarty_include_vars |
Definition at line 1855 of file Smarty.class.src.php.
_trigger_fatal_error | ( | $ | error_msg, |
$ | tpl_file = null , |
||
$ | tpl_line = null , |
||
$ | file = null , |
||
$ | line = null , |
||
$ | error_type = E_USER_ERROR |
||
) |
trigger Smarty plugin error
string | $error_msg | |
string | $tpl_file | |
integer | $tpl_line | |
string | $file | |
integer | $line | |
integer | $error_type |
Definition at line 1816 of file Smarty.class.src.php.
_unlink | ( | $ | resource, |
$ | exp_time = null |
||
) |
unlink a file, possibly using expiration time
string | $resource | |
integer | $exp_time |
Definition at line 1779 of file Smarty.class.src.php.
append | ( | $ | tpl_var, |
$ | value = null , |
||
$ | merge = false |
||
) |
appends values to template variables
array | string | $tpl_var | the template variable name(s) |
mixed | $value | the value to append |
Definition at line 612 of file Smarty.class.src.php.
append_by_ref | ( | $ | tpl_var, |
&$ | value, | ||
$ | merge = false |
||
) |
appends values to template variables by reference
string | $tpl_var | the template variable name |
mixed | $value | the referenced value to append |
Definition at line 652 of file Smarty.class.src.php.
assign | ( | $ | tpl_var, |
$ | value = null |
||
) |
assigns values to template variables
array | string | $tpl_var | the template variable name(s) |
mixed | $value | the value to assign |
Definition at line 580 of file Smarty.class.src.php.
assign_by_ref | ( | $ | tpl_var, |
&$ | value | ||
) |
assigns values to template variables by reference
string | $tpl_var | the template variable name |
mixed | $value | the referenced value to assign |
Definition at line 600 of file Smarty.class.src.php.
clear_all_assign | ( | ) |
clear all the assigned template variables.
Definition at line 1006 of file Smarty.class.src.php.
clear_all_cache | ( | $ | exp_time = null ) |
clear the entire contents of cache (all templates)
string | $exp_time | expire time |
Definition at line 970 of file Smarty.class.src.php.
clear_assign | ( | $ | tpl_var ) |
clear the given assigned template variable.
string | $tpl_var | the template variable to clear |
Definition at line 674 of file Smarty.class.src.php.
clear_cache | ( | $ | tpl_file = null , |
$ | cache_id = null , |
||
$ | compile_id = null , |
||
$ | exp_time = null |
||
) |
clear cached content for the given template and cache id
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 |
Definition at line 938 of file Smarty.class.src.php.
clear_compiled_tpl | ( | $ | tpl_file = null , |
$ | compile_id = null , |
||
$ | 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.
string | $tpl_file | |
string | $compile_id | |
string | $exp_time |
Definition at line 1021 of file Smarty.class.src.php.
clear_config | ( | $ | var = null ) |
clear configuration values
string | $var |
Definition at line 1341 of file Smarty.class.src.php.
config_load | ( | $ | file, |
$ | section = null , |
||
$ | scope = 'global' |
||
) |
load configuration values
string | $file | |
string | $section | |
string | $scope |
Definition at line 1314 of file Smarty.class.src.php.
display | ( | $ | resource_name, |
$ | cache_id = null , |
||
$ | compile_id = null |
||
) |
executes & displays the template results
string | $resource_name | |
string | $cache_id | |
string | $compile_id |
Definition at line 1099 of file Smarty.class.src.php.
fetch | ( | $ | resource_name, |
$ | cache_id = null , |
||
$ | compile_id = null , |
||
$ | display = false |
||
) |
executes & returns or displays the template results
string | $resource_name | |
string | $cache_id | |
string | $compile_id | |
boolean | $display |
Definition at line 1112 of file Smarty.class.src.php.
& get_config_vars | ( | $ | name = null ) |
Returns an array containing config variables
string | $name | |
string | $type |
Definition at line 1071 of file Smarty.class.src.php.
& get_registered_object | ( | $ | name ) |
return a reference to a registered object
string | $name |
Definition at line 1326 of file Smarty.class.src.php.
& get_template_vars | ( | $ | name = null ) |
Returns an array containing template variables
string | $name | |
string | $type |
Definition at line 1054 of file Smarty.class.src.php.
is_cached | ( | $ | tpl_file, |
$ | cache_id = null , |
||
$ | compile_id = null |
||
) |
test to see if valid cache exists for this template
string | $tpl_file | name of template file |
string | $cache_id | |
string | $compile_id |
Definition at line 984 of file Smarty.class.src.php.
load_filter | ( | $ | type, |
$ | name | ||
) |
load a filter of specified type and name
string | $type | filter type |
string | $name | filter name |
Definition at line 912 of file Smarty.class.src.php.
register_block | ( | $ | block, |
$ | block_impl, | ||
$ | cacheable = true , |
||
$ | cache_attrs = null |
||
) |
Registers block function to be used in templates
string | $block | name of template block |
string | $block_impl | PHP function to register |
Definition at line 741 of file Smarty.class.src.php.
register_compiler_function | ( | $ | function, |
$ | function_impl, | ||
$ | cacheable = true |
||
) |
Registers compiler function
string | $function | name of template function |
string | $function_impl | name of PHP function to register |
Definition at line 763 of file Smarty.class.src.php.
register_function | ( | $ | function, |
$ | function_impl, | ||
$ | cacheable = true , |
||
$ | cache_attrs = null |
||
) |
Registers custom function to be used in templates
string | $function | the name of the template function |
string | $function_impl | the name of the PHP function to register |
Definition at line 690 of file Smarty.class.src.php.
register_modifier | ( | $ | modifier, |
$ | modifier_impl | ||
) |
Registers modifier to be used in templates
string | $modifier | name of template modifier |
string | $modifier_impl | name of PHP function to register |
Definition at line 785 of file Smarty.class.src.php.
register_object | ( | $ | object, |
&$ | object_impl, | ||
$ | allowed = array() , |
||
$ | smarty_args = true , |
||
$ | block_methods = array() |
||
) |
Registers object to be used in templates
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 |
Definition at line 716 of file Smarty.class.src.php.
register_outputfilter | ( | $ | function ) |
Registers an output filter function to apply to a template output
string | $function | name of PHP function |
Definition at line 889 of file Smarty.class.src.php.
register_postfilter | ( | $ | function ) |
Registers a postfilter function to apply to a compiled template after compilation
string | $function | name of PHP function to register |
Definition at line 866 of file Smarty.class.src.php.
register_prefilter | ( | $ | function ) |
Registers a prefilter function to apply to a template before compiling
string | $function | name of PHP function to register |
Definition at line 843 of file Smarty.class.src.php.
register_resource | ( | $ | type, |
$ | functions | ||
) |
Registers a resource to fetch a template
string | $type | name of resource |
array | $functions | array of functions to handle resource |
Definition at line 807 of file Smarty.class.src.php.
Smarty | ( | ) |
#@- The class constructor.
Definition at line 568 of file Smarty.class.src.php.
template_exists | ( | $ | tpl_file ) |
Checks whether requested template exists.
string | $tpl_file |
Definition at line 1041 of file Smarty.class.src.php.
trigger_error | ( | $ | error_msg, |
$ | error_type = E_USER_WARNING |
||
) |
trigger Smarty error
string | $error_msg | |
integer | $error_type |
Definition at line 1086 of file Smarty.class.src.php.
unregister_block | ( | $ | block ) |
Unregisters block function
string | $block | name of template function |
Definition at line 752 of file Smarty.class.src.php.
unregister_compiler_function | ( | $ | function ) |
Unregisters compiler function
string | $function | name of template function |
Definition at line 774 of file Smarty.class.src.php.
unregister_function | ( | $ | function ) |
Unregisters custom function
string | $function | name of template function |
Definition at line 702 of file Smarty.class.src.php.
unregister_modifier | ( | $ | modifier ) |
Unregisters modifier
string | $modifier | name of template modifier |
Definition at line 796 of file Smarty.class.src.php.
unregister_object | ( | $ | object ) |
Unregisters object
string | $object | name of template object |
Definition at line 729 of file Smarty.class.src.php.
unregister_outputfilter | ( | $ | function ) |
Unregisters an outputfilter function
string | $function | name of PHP function |
Definition at line 901 of file Smarty.class.src.php.
unregister_postfilter | ( | $ | function ) |
Unregisters a postfilter function
string | $function | name of PHP function |
Definition at line 878 of file Smarty.class.src.php.
unregister_prefilter | ( | $ | function ) |
Unregisters a prefilter function
string | $function | name of PHP function |
Definition at line 855 of file Smarty.class.src.php.
unregister_resource | ( | $ | type ) |
Unregisters a resource
string | $type | name of resource |
Definition at line 832 of file Smarty.class.src.php.
$_plugins |
array( 'modifier' => array(), 'function' => array(), 'block' => array(), 'compiler' => array(), 'prefilter' => array(), 'postfilter' => array(), 'outputfilter' => array(), 'resource' => array(), 'insert' => array())
Definition at line 530 of file Smarty.class.src.php.
$config_booleanize = true |
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.
Definition at line 354 of file Smarty.class.src.php.
$config_fix_newlines = true |
This tells whether or not automatically fix newlines in config files. It basically converts (mac) or
(dos) to
Definition at line 368 of file Smarty.class.src.php.
$config_overwrite = true |
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.
Definition at line 347 of file Smarty.class.src.php.
$config_read_hidden = false |
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.
Definition at line 362 of file Smarty.class.src.php.
$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 )
Definition at line 229 of file Smarty.class.src.php.