Class SmartyBC

Description

Smarty Backward Compatability Wrapper Class

Located in /libs/SmartyBC.class.php (line 42)

Smarty_Internal_Data
   |
   --Smarty_Internal_TemplateBase
      |
      --Smarty
         |
         --SmartyBC
Variable Summary
string $_version
Method Summary
SmartyBC __construct ([ $options = array()])
void append_by_ref (string $tpl_var, mixed &$value, [boolean $merge = false])
void assign_by_ref (string $tpl_var, mixed &$value)
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'])
array get_config_vars ([string $name = null])
object get_registered_object (string $name)
array get_template_vars ([string $name = null])
boolean 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, [bool $cacheable = true], [mixed $cache_attrs = null])
void register_compiler_function (string $function, string $function_impl, [bool $cacheable = true])
void register_function (string $function, string $function_impl, [bool $cacheable = true], [mixed $cache_attrs = null])
void register_modifier (string $modifier, string $modifier_impl)
void register_object (string $object, object $object_impl, [array $allowed = array()], [boolean $smarty_args = true], [ $block_methods = array()], array $block_functs)
void register_outputfilter (callable $function)
void register_postfilter (callable $function)
void register_prefilter (callable $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 (callable $function)
void unregister_postfilter (callable $function)
void unregister_prefilter (callable $function)
void unregister_resource (string $type)
Variables
string $_version = self::SMARTY_VERSION (line 48)

Smarty 2 BC

  • access: public

Inherited Variables

Inherited from Smarty

Smarty::$allow_php_templates
Smarty::$autoload_filters
Smarty::$auto_literal
Smarty::$cache_dir
Smarty::$cache_id
Smarty::$cache_lifetime
Smarty::$cache_locking
Smarty::$cache_modified_check
Smarty::$caching
Smarty::$caching_type
Smarty::$compile_check
Smarty::$compile_dir
Smarty::$compile_id
Smarty::$compile_locking
Smarty::$config_booleanize
Smarty::$config_dir
Smarty::$config_overwrite
Smarty::$config_read_hidden
Smarty::$debugging
Smarty::$debugging_ctrl
Smarty::$debug_tpl
Smarty::$default_config_handler_func
Smarty::$default_config_type
Smarty::$default_modifiers
Smarty::$default_plugin_handler_func
Smarty::$default_resource_type
Smarty::$default_template_handler_func
Smarty::$direct_access_security
Smarty::$error_reporting
Smarty::$error_unassigned
Smarty::$escape_html
Smarty::$force_cache
Smarty::$force_compile
Smarty::$get_used_tags
Smarty::$global_tpl_vars
Smarty::$left_delimiter
Smarty::$locking_timeout
Smarty::$merged_templates_func
Smarty::$merge_compiled_includes
Smarty::$php_handling
Smarty::$plugins_dir
Smarty::$plugin_search_order
Smarty::$properties
Smarty::$registered_cache_resources
Smarty::$registered_classes
Smarty::$registered_filters
Smarty::$registered_objects
Smarty::$registered_plugins
Smarty::$registered_resources
Smarty::$right_delimiter
Smarty::$security_class
Smarty::$security_policy
Smarty::$smarty
Smarty::$smarty_debug_id
Smarty::$start_time
Smarty::$template_dir
Smarty::$template_functions
Smarty::$template_objects
Smarty::$use_include_path
Smarty::$use_sub_dirs
Smarty::$_current_file
Smarty::$_dir_perms
Smarty::$_file_perms
Smarty::$_muted_directories
Smarty::$_parserdebug
Smarty::$_previous_error_handler
Smarty::$_smarty_vars
Smarty::$_tag_stack

Inherited from Smarty_Internal_Data

Smarty_Internal_Data::$config_vars
Smarty_Internal_Data::$parent
Smarty_Internal_Data::$template_class
Smarty_Internal_Data::$tpl_vars
Methods
Constructor __construct (line 55)

Initialize new SmartyBC object

  • access: public
SmartyBC __construct ([ $options = array()])
  • array $options: options to set during initialization, e.g. array( 'forceCompile' => false )

Redefinition of:
Smarty::__construct()
Initialize new Smarty object
append_by_ref (line 80)

wrapper for append_by_ref

  • access: public
void append_by_ref (string $tpl_var, mixed &$value, [boolean $merge = false])
  • string $tpl_var: the template variable name
  • mixed &$value: the referenced value to append
  • boolean $merge: flag if array elements shall be merged
assign_by_ref (line 68)

wrapper for assign_by_ref

  • access: public
void assign_by_ref (string $tpl_var, mixed &$value)
  • string $tpl_var: the template variable name
  • mixed &$value: the referenced value to assign
clear_all_assign (line 346)

clear all the assigned template variables.

  • access: public
void clear_all_assign ()
clear_all_cache (line 325)

clear the entire contents of cache (all templates)

  • access: public
boolean clear_all_cache ([string $exp_time = null])
  • string $exp_time: expire time
clear_assign (line 90)

clear the given assigned template variable.

  • access: public
void clear_assign (string $tpl_var)
  • string $tpl_var: the template variable to clear
clear_cache (line 314)

clear cached content for the given template and cache id

  • access: public
boolean clear_cache ([string $tpl_file = null], [string $cache_id = null], [string $compile_id = null], [string $exp_time = null])
  • 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
clear_compiled_tpl (line 361)

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.

  • return: results of smarty_core_rm_auto()
  • access: public
boolean clear_compiled_tpl ([string $tpl_file = null], [string $compile_id = null], [string $exp_time = null])
  • string $tpl_file
  • string $compile_id
  • string $exp_time
clear_config (line 427)

clear configuration values

  • access: public
void clear_config ([string $var = null])
  • string $var
config_load (line 406)

load configuration values

  • access: public
void config_load (string $file, [string $section = null], [string $scope = 'global'])
  • string $file
  • string $section
  • string $scope
get_config_vars (line 394)

Returns an array containing config variables

  • access: public
array get_config_vars ([string $name = null])
  • string $name
get_registered_object (line 417)

return a reference to a registered object

  • access: public
object get_registered_object (string $name)
  • string $name
get_template_vars (line 383)

Returns an array containing template variables

  • access: public
array get_template_vars ([string $name = null])
  • string $name
is_cached (line 338)

test to see if valid cache exists for this template

  • access: public
boolean is_cached (string $tpl_file, [string $cache_id = null], [string $compile_id = null])
  • string $tpl_file: name of template file
  • string $cache_id
  • string $compile_id
load_filter (line 300)

load a filter of specified type and name

  • access: public
void load_filter (string $type, string $name)
  • string $type: filter type
  • string $name: filter name
register_block (line 152)

Registers block function to be used in templates

  • access: public
void register_block (string $block, string $block_impl, [bool $cacheable = true], [mixed $cache_attrs = null])
  • string $block: name of template block
  • string $block_impl: PHP function to register
  • bool $cacheable
  • mixed $cache_attrs
register_compiler_function (line 174)

Registers compiler function

  • access: public
void register_compiler_function (string $function, string $function_impl, [bool $cacheable = true])
  • string $function: name of template function
  • string $function_impl: name of PHP function to register
  • bool $cacheable
register_function (line 103)

Registers custom function to be used in templates

  • access: public
void register_function (string $function, string $function_impl, [bool $cacheable = true], [mixed $cache_attrs = null])
  • string $function: the name of the template function
  • string $function_impl: the name of the PHP function to register
  • bool $cacheable
  • mixed $cache_attrs
register_modifier (line 195)

Registers modifier to be used in templates

  • access: public
void register_modifier (string $modifier, string $modifier_impl)
  • string $modifier: name of template modifier
  • string $modifier_impl: name of PHP function to register
register_object (line 127)

Registers object to be used in templates

  • access: public
void register_object (string $object, object $object_impl, [array $allowed = array()], [boolean $smarty_args = true], [ $block_methods = array()], array $block_functs)
  • string $object: name of template object
  • object $object_impl: the referenced PHP object to register
  • array $allowed: list of allowed methods (empty = all)
  • boolean $smarty_args: smarty argument format, else traditional
  • array $block_functs: list of methods that are block format
  • $block_methods
register_outputfilter (line 279)

Registers an output filter function to apply to a template output

  • access: public
void register_outputfilter (callable $function)
  • callable $function
register_postfilter (line 258)

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

  • access: public
void register_postfilter (callable $function)
  • callable $function
register_prefilter (line 237)

Registers a prefilter function to apply to a template before compiling

  • access: public
void register_prefilter (callable $function)
  • callable $function
register_resource (line 216)

Registers a resource to fetch a template

  • access: public
void register_resource (string $type, array $functions)
  • string $type: name of resource
  • array $functions: array of functions to handle resource
template_exists (line 372)

Checks whether requested template exists.

  • access: public
boolean template_exists (string $tpl_file)
  • string $tpl_file
trigger_error (line 438)

trigger Smarty error

  • access: public
void trigger_error (string $error_msg, [integer $error_type = E_USER_WARNING])
  • string $error_msg
  • integer $error_type
unregister_block (line 162)

Unregisters block function

  • access: public
void unregister_block (string $block)
  • string $block: name of template function
unregister_compiler_function (line 184)

Unregisters compiler function

  • access: public
void unregister_compiler_function (string $function)
  • string $function: name of template function
unregister_function (line 113)

Unregisters custom function

  • access: public
void unregister_function (string $function)
  • string $function: name of template function
unregister_modifier (line 205)

Unregisters modifier

  • access: public
void unregister_modifier (string $modifier)
  • string $modifier: name of template modifier
unregister_object (line 139)

Unregisters object

  • access: public
void unregister_object (string $object)
  • string $object: name of template object
unregister_outputfilter (line 289)

Unregisters an outputfilter function

  • access: public
void unregister_outputfilter (callable $function)
  • callable $function
unregister_postfilter (line 268)

Unregisters a postfilter function

  • access: public
void unregister_postfilter (callable $function)
  • callable $function
unregister_prefilter (line 247)

Unregisters a prefilter function

  • access: public
void unregister_prefilter (callable $function)
  • callable $function
unregister_resource (line 226)

Unregisters a resource

  • access: public
void unregister_resource (string $type)
  • string $type: name of resource

Inherited Methods

Inherited From Smarty

Smarty::__construct()
Smarty::addAutoloadFilters()
Smarty::addConfigDir()
Smarty::addDefaultModifiers()
Smarty::addPluginsDir()
Smarty::addTemplateDir()
Smarty::clearAllCache()
Smarty::clearCache()
Smarty::clearCompiledTemplate()
Smarty::compileAllConfig()
Smarty::compileAllTemplates()
Smarty::createTemplate()
Smarty::disableSecurity()
Smarty::enableSecurity()
Smarty::getAutoloadFilters()
Smarty::getCacheDir()
Smarty::getCompileDir()
Smarty::getConfigDir()
Smarty::getDebugTemplate()
Smarty::getDefaultModifiers()
Smarty::getGlobal()
Smarty::getPluginsDir()
Smarty::getTags()
Smarty::getTemplateDir()
Smarty::loadPlugin()
Smarty::muteExpectedErrors()
Smarty::mutingErrorHandler()
Smarty::setAutoloadFilters()
Smarty::setCacheDir()
Smarty::setCompileDir()
Smarty::setConfigDir()
Smarty::setDebugTemplate()
Smarty::setDefaultModifiers()
Smarty::setPluginsDir()
Smarty::setTemplateDir()
Smarty::templateExists()
Smarty::testInstall()
Smarty::unmuteExpectedErrors()
Smarty::__clone()
Smarty::__destruct()
Smarty::__get()
Smarty::__set()

Inherited From Smarty_Internal_TemplateBase

Smarty_Internal_TemplateBase::createData()
Smarty_Internal_TemplateBase::display()
Smarty_Internal_TemplateBase::fetch()
Smarty_Internal_TemplateBase::getRegisteredObject()
Smarty_Internal_TemplateBase::isCached()
Smarty_Internal_TemplateBase::loadFilter()
Smarty_Internal_TemplateBase::registerCacheResource()
Smarty_Internal_TemplateBase::registerClass()
Smarty_Internal_TemplateBase::registerDefaultConfigHandler()
Smarty_Internal_TemplateBase::registerDefaultPluginHandler()
Smarty_Internal_TemplateBase::registerDefaultTemplateHandler()
Smarty_Internal_TemplateBase::registerFilter()
Smarty_Internal_TemplateBase::registerObject()
Smarty_Internal_TemplateBase::registerPlugin()
Smarty_Internal_TemplateBase::registerResource()
Smarty_Internal_TemplateBase::unregisterCacheResource()
Smarty_Internal_TemplateBase::unregisterFilter()
Smarty_Internal_TemplateBase::unregisterObject()
Smarty_Internal_TemplateBase::unregisterPlugin()
Smarty_Internal_TemplateBase::unregisterResource()
Smarty_Internal_TemplateBase::_get_filter_name()
Smarty_Internal_TemplateBase::__call()

Inherited From Smarty_Internal_Data

Smarty_Internal_Data::append()
Smarty_Internal_Data::appendByRef()
Smarty_Internal_Data::assign()
Smarty_Internal_Data::assignByRef()
Smarty_Internal_Data::assignGlobal()
Smarty_Internal_Data::clearAllAssign()
Smarty_Internal_Data::clearAssign()
Smarty_Internal_Data::clearConfig()
Smarty_Internal_Data::configLoad()
Smarty_Internal_Data::getConfigVariable()
Smarty_Internal_Data::getConfigVars()
Smarty_Internal_Data::getStreamVariable()
Smarty_Internal_Data::getTemplateVars()
Smarty_Internal_Data::getVariable()
Class Constants

Documentation generated on Sat, 24 Sep 2011 20:23:26 +0200 by phpDocumentor 1.4.1