Class SmartyBC

`extends`	`Smarty`

Smarty Backward Compatibility Wrapper Class

Smarty_Internal_Data
- Smarty_Internal_TemplateBase
  - Smarty
    - SmartyBC
      - XoopsTpl

Located at class\libraries\vendor\smarty\smarty\libs\SmartyBC.class.php

Methods


					
	public

__construct()

Initialize new SmartyBC object

Overrides

Smarty::__construct()

Overriden by

XoopsTpl::__construct()


					
	public

assign_by_ref(string $tpl_var, mixed &$value)

wrapper for assign_by_ref

Parameters

`$tpl_var`	the template variable name
`$value`	the referenced value to assign

Overriden by

XoopsTpl::assign_by_ref()


					
	public

append_by_ref(string $tpl_var, mixed &$value, boolean $merge = false)

wrapper for append_by_ref

Parameters

`$tpl_var`	the template variable name
`$value`	the referenced value to append
`$merge`	flag if array elements shall be merged

Overriden by

XoopsTpl::append_by_ref()


					
	public

clear_assign(string $tpl_var)

clear the given assigned template variable.

Parameters

$tpl_var

the template variable to clear

Overriden by

XoopsTpl::clear_assign()


					
	public

register_function(string $function, string $function_impl, bool $cacheable = true, mixed $cache_attrs = null)

Registers custom function to be used in templates

Parameters

`$function`	the name of the template function
`$function_impl`	the name of the PHP function to register

Throws

SmartyException

Overriden by

XoopsTpl::register_function()


					
	public

unregister_function(string $function)

Unregister custom function

Parameters

$function

name of template function

Overriden by

XoopsTpl::unregister_function()


					
	public

unregister_object(string $object)

Unregister object

Parameters

$object

name of template object

Overriden by

XoopsTpl::unregister_object()


					
	public

register_block(string $block, string $block_impl, bool $cacheable = true, mixed $cache_attrs = null)

Registers block function to be used in templates

Parameters

`$block`	name of template block
`$block_impl`	PHP function to register

Throws

SmartyException

Overriden by

XoopsTpl::register_block()


					
	public

unregister_block(string $block)

Unregister block function

Parameters

$block

name of template function

Overriden by

XoopsTpl::unregister_block()


					
	public

register_compiler_function(string $function, string $function_impl, bool $cacheable = true)

Registers compiler function

Parameters

`$function`	name of template function
`$function_impl`	name of PHP function to register

Throws

SmartyException

Overriden by

XoopsTpl::register_compiler_function()


					
	public

unregister_compiler_function(string $function)

Unregister compiler function

Parameters

$function

name of template function

Overriden by

XoopsTpl::unregister_compiler_function()


					
	public

register_modifier(string $modifier, string $modifier_impl)

Registers modifier to be used in templates

Parameters

`$modifier`	name of template modifier
`$modifier_impl`	name of PHP function to register

Throws

SmartyException

Overriden by

XoopsTpl::register_modifier()


					
	public

unregister_modifier(string $modifier)

Unregister modifier

Parameters

$modifier

name of template modifier

Overriden by

XoopsTpl::unregister_modifier()


					
	public

register_resource(string $type, array $functions)

Registers a resource to fetch a template

Parameters

`$type`	name of resource
`$functions`	array of functions to handle resource

Overriden by

XoopsTpl::register_resource()


					
	public

unregister_resource(string $type)

Unregister a resource

Parameters

$type

name of resource

Overriden by

XoopsTpl::unregister_resource()


					
	public

register_prefilter(callable $function)

Registers a prefilter function to apply to a template before compiling

Throws

SmartyException

Overriden by

XoopsTpl::register_prefilter()


					
	public

unregister_prefilter(callable $function)

Unregister a prefilter function

Overriden by

XoopsTpl::unregister_prefilter()


					
	public

register_postfilter(callable $function)

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

Throws

SmartyException

Overriden by

XoopsTpl::register_postfilter()


					
	public

unregister_postfilter(callable $function)

Unregister a postfilter function

Overriden by

XoopsTpl::unregister_postfilter()


					
	public

register_outputfilter(callable $function)

Registers an output filter function to apply to a template output

Throws

SmartyException

Overriden by

XoopsTpl::register_outputfilter()


					
	public

unregister_outputfilter(callable $function)

Unregister an outputfilter function

Overriden by

XoopsTpl::unregister_outputfilter()


					
	public

load_filter(string $type, string $name)

load a filter of specified type and name

Parameters

`$type`	filter type
`$name`	filter name

Throws

SmartyException

Overriden by

XoopsTpl::load_filter()


					
	public

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

clear cached content for the given template and cache id

Parameters

`$tpl_file`	name of template file
`$cache_id`	name of cache_id
`$compile_id`	name of compile_id
`$exp_time`	expiration time

Overriden by

XoopsTpl::clear_cache()


					
	public

clear_all_cache(string $exp_time = null): boolean

clear the entire contents of cache (all templates)

Parameters

$exp_time

expire time

Overriden by

XoopsTpl::clear_all_cache()


					
	public

is_cached(string $tpl_file, string $cache_id = null, string $compile_id = null): bool

test to see if valid cache exists for this template

Parameters

$tpl_file

name of template file

Throws

`Exception`
`SmartyException`

Overriden by

XoopsTpl::is_cached()


					
	public

clear_all_assign()

clear all the assigned template variables.

Overriden by

XoopsTpl::clear_all_assign()


					
	public

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

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

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.

Returns

results of {@link smarty_core_rm_auto()}

Overriden by

XoopsTpl::clear_compiled_tpl()


					
	public

template_exists(string $tpl_file): bool

Checks whether requested template exists.

Throws

SmartyException

Overriden by

XoopsTpl::template_exists()


					
	public

get_template_vars(string $name = null): array

Returns an array containing template variables

Overriden by

XoopsTpl::get_template_vars()


					
	public

get_config_vars(string $name = null): array

Returns an array containing config variables

Overriden by

XoopsTpl::get_config_vars()


					
	public

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

load configuration values

Overriden by

XoopsTpl::config_load()


					
	public

get_registered_object(string $name): object

return a reference to a registered object

Overriden by

XoopsTpl::get_registered_object()


					
	public

clear_config(string $var = null)

clear configuration values

Overriden by

XoopsTpl::clear_config()


					
	public

trigger_error(string $error_msg, integer $error_type = E_USER_WARNING)

trigger Smarty error

Methods inherited from Smarty
muteExpectedErrors(), unmuteExpectedErrors(), templateExists(), enableSecurity(), disableSecurity(), addTemplateDir(), getTemplateDir(), setTemplateDir(), addConfigDir(), getConfigDir(), setConfigDir(), addPluginsDir(), getPluginsDir(), setPluginsDir(), getCompileDir(), setCompileDir(), getCacheDir(), setCacheDir(), createTemplate(), loadPlugin(), _getTemplateId(), _realpath(), _clearTemplateCache(), setUseSubDirs(), setErrorReporting(), setEscapeHtml(), getAutoLiteral(), setAutoLiteral(), setForceCompile(), setMergeCompiledIncludes(), getLeftDelimiter(), setLeftDelimiter(), getRightDelimiter(), setRightDelimiter(), setDebugging(), setConfigOverwrite(), setConfigBooleanize(), setConfigReadHidden(), setCompileLocking(), setDefaultResourceType(), setCachingType(), testInstall(), _getSmartyObj(), __get(), __set(), clearAllCache(), clearCache(), compileAllTemplates(), compileAllConfig(), clearCompiledTemplate()

Methods inherited from Smarty

muteExpectedErrors(), unmuteExpectedErrors(), templateExists(), enableSecurity(), disableSecurity(), addTemplateDir(), getTemplateDir(), setTemplateDir(), addConfigDir(), getConfigDir(), setConfigDir(), addPluginsDir(), getPluginsDir(), setPluginsDir(), getCompileDir(), setCompileDir(), getCacheDir(), setCacheDir(), createTemplate(), loadPlugin(), _getTemplateId(), _realpath(), _clearTemplateCache(), setUseSubDirs(), setErrorReporting(), setEscapeHtml(), getAutoLiteral(), setAutoLiteral(), setForceCompile(), setMergeCompiledIncludes(), getLeftDelimiter(), setLeftDelimiter(), getRightDelimiter(), setRightDelimiter(), setDebugging(), setConfigOverwrite(), setConfigBooleanize(), setConfigReadHidden(), setCompileLocking(), setDefaultResourceType(), setCachingType(), testInstall(), _getSmartyObj(), __get(), __set(), clearAllCache(), clearCache(), compileAllTemplates(), compileAllConfig(), clearCompiledTemplate()

Methods inherited from Smarty_Internal_TemplateBase
fetch(), display(), isCached(), registerPlugin(), loadFilter(), registerFilter(), registerObject(), setCompileCheck(), setCaching(), setCacheLifetime(), setCompileId(), setCacheId(), addAutoloadFilters(), addDefaultModifiers(), addLiterals(), createData(), getAutoloadFilters(), getDebugTemplate(), getDefaultModifier(), getLiterals(), getTags(), getRegisteredObject(), registerCacheResource(), registerClass(), registerDefaultConfigHandler(), registerDefaultPluginHandler(), registerDefaultTemplateHandler(), registerResource(), setAutoloadFilters(), setDebugTemplate(), setDefaultModifiers(), setLiterals(), unloadFilter(), unregisterCacheResource(), unregisterObject(), unregisterPlugin(), unregisterFilter(), unregisterResource()

Methods inherited from Smarty_Internal_TemplateBase

fetch(), display(), isCached(), registerPlugin(), loadFilter(), registerFilter(), registerObject(), setCompileCheck(), setCaching(), setCacheLifetime(), setCompileId(), setCacheId(), addAutoloadFilters(), addDefaultModifiers(), addLiterals(), createData(), getAutoloadFilters(), getDebugTemplate(), getDefaultModifier(), getLiterals(), getTags(), getRegisteredObject(), registerCacheResource(), registerClass(), registerDefaultConfigHandler(), registerDefaultPluginHandler(), registerDefaultTemplateHandler(), registerResource(), setAutoloadFilters(), setDebugTemplate(), setDefaultModifiers(), setLiterals(), unloadFilter(), unregisterCacheResource(), unregisterObject(), unregisterPlugin(), unregisterFilter(), unregisterResource()

Methods inherited from Smarty_Internal_Data
`assign(), append(), assignGlobal(), appendByRef(), assignByRef(), getTemplateVars(), getVariable(), _mergeVars(), _isDataObj(), _isTplObj(), _isSmartyObj(), __call(), _getConfigVariable(), getConfigVariable(), getConfigVars(), getGlobal(), getStreamVariable(), clearAssign(), clearAllAssign(), clearConfig(), configLoad()`

Constants inherited from Smarty
`SMARTY_VERSION, SCOPE_LOCAL, SCOPE_PARENT, SCOPE_TPL_ROOT, SCOPE_ROOT, SCOPE_SMARTY, SCOPE_GLOBAL, CACHING_OFF, CACHING_LIFETIME_CURRENT, CACHING_LIFETIME_SAVED, CLEAR_EXPIRED, COMPILECHECK_OFF, COMPILECHECK_ON, COMPILECHECK_CACHEMISS, DEBUG_OFF, DEBUG_ON, DEBUG_INDIVIDUAL, PHP_PASSTHRU, PHP_QUOTE, PHP_REMOVE, PHP_ALLOW, FILTER_POST, FILTER_PRE, FILTER_OUTPUT, FILTER_VARIABLE, PLUGIN_FUNCTION, PLUGIN_BLOCK, PLUGIN_COMPILER, PLUGIN_MODIFIER, PLUGIN_MODIFIERCOMPILER`

Constants inherited from Smarty

SMARTY_VERSION, SCOPE_LOCAL, SCOPE_PARENT, SCOPE_TPL_ROOT, SCOPE_ROOT, SCOPE_SMARTY, SCOPE_GLOBAL, CACHING_OFF, CACHING_LIFETIME_CURRENT, CACHING_LIFETIME_SAVED, CLEAR_EXPIRED, COMPILECHECK_OFF, COMPILECHECK_ON, COMPILECHECK_CACHEMISS, DEBUG_OFF, DEBUG_ON, DEBUG_INDIVIDUAL, PHP_PASSTHRU, PHP_QUOTE, PHP_REMOVE, PHP_ALLOW, FILTER_POST, FILTER_PRE, FILTER_OUTPUT, FILTER_VARIABLE, PLUGIN_FUNCTION, PLUGIN_BLOCK, PLUGIN_COMPILER, PLUGIN_MODIFIER, PLUGIN_MODIFIERCOMPILER

Properties
`public`	`string`	`$_version = self::SMARTY_VERSION`	#
`public`	`array`	`$trusted_dir = []`	#

Properties inherited from Smarty
$global_tpl_vars, $_MBSTRING, $_CHARSET, $_DATE_FORMAT, $_UTF8_MODIFIER, $_IS_WINDOWS, $auto_literal, $error_unassigned, $use_include_path, $_templateDirNormalized, $_joined_template_dir, $_configDirNormalized, $_joined_config_dir, $default_template_handler_func, $default_config_handler_func, $default_plugin_handler_func, $_compileDirNormalized, $_pluginsDirNormalized, $_cacheDirNormalized, $force_compile, $use_sub_dirs, $allow_ambiguous_resources, $merge_compiled_includes, $extends_recursion, $force_cache, $left_delimiter, $right_delimiter, $literals, $security_class, $security_policy, $php_handling, $allow_php_templates, $debugging, $debugging_ctrl, $smarty_debug_id, $debug_tpl, $error_reporting, $config_overwrite, $config_booleanize, $config_read_hidden, $compile_locking, $cache_locking, $locking_timeout, $default_resource_type, $caching_type, $default_config_type, $cache_modified_check, $registered_plugins, $registered_objects, $registered_classes, $registered_filters, $registered_resources, $registered_cache_resources, $autoload_filters, $default_modifiers, $escape_html, $start_time, $_current_file, $_parserdebug, $_objType, $_debug, $template_dir, $_processedTemplateDir, $config_dir, $_processedConfigDir, $compile_dir, $plugins_dir, $cache_dir, $obsoleteProperties, $accessMap

Properties inherited from Smarty

$global_tpl_vars, $_MBSTRING, $_CHARSET, $_DATE_FORMAT, $_UTF8_MODIFIER, $_IS_WINDOWS, $auto_literal, $error_unassigned, $use_include_path, $_templateDirNormalized, $_joined_template_dir, $_configDirNormalized, $_joined_config_dir, $default_template_handler_func, $default_config_handler_func, $default_plugin_handler_func, $_compileDirNormalized, $_pluginsDirNormalized, $_cacheDirNormalized, $force_compile, $use_sub_dirs, $allow_ambiguous_resources, $merge_compiled_includes, $extends_recursion, $force_cache, $left_delimiter, $right_delimiter, $literals, $security_class, $security_policy, $php_handling, $allow_php_templates, $debugging, $debugging_ctrl, $smarty_debug_id, $debug_tpl, $error_reporting, $config_overwrite, $config_booleanize, $config_read_hidden, $compile_locking, $cache_locking, $locking_timeout, $default_resource_type, $caching_type, $default_config_type, $cache_modified_check, $registered_plugins, $registered_objects, $registered_classes, $registered_filters, $registered_resources, $registered_cache_resources, $autoload_filters, $default_modifiers, $escape_html, $start_time, $_current_file, $_parserdebug, $_objType, $_debug, $template_dir, $_processedTemplateDir, $config_dir, $_processedConfigDir, $compile_dir, $plugins_dir, $cache_dir, $obsoleteProperties, $accessMap

Properties inherited from Smarty_Internal_TemplateBase
`$cache_id, $compile_id, $caching, $compile_check, $cache_lifetime, $tplFunctions, $_cache,`

Properties inherited from Smarty_Internal_Data
`$template_class, $tpl_vars, $parent, $config_vars, $ext, $scope, $smarty`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class SmartyBC

Overrides

Overriden by

Parameters

Overriden by

Parameters

Overriden by

Parameters

Overriden by

Parameters

Throws

Overriden by

Parameters

Overriden by

Parameters

Overriden by

Parameters

Throws

Overriden by

Parameters

Overriden by

Parameters

Throws

Overriden by

Parameters

Overriden by

Parameters

Throws

Overriden by

Parameters

Overriden by

Parameters

Overriden by

Parameters

Overriden by

Throws

Overriden by

Overriden by

Throws

Overriden by

Overriden by

Throws

Overriden by

Overriden by

Parameters

Throws

Overriden by

Parameters

Overriden by

Parameters

Overriden by

Parameters

Throws

Overriden by

Overriden by

Returns

Overriden by

Throws

Overriden by

Overriden by

Overriden by

Overriden by

Overriden by

Overriden by