Class XoopsTpl

`extends`	`SmartyBC`

Template engine

Smarty_Internal_Data
- Smarty_Internal_TemplateBase
  - Smarty
    - SmartyBC
      - XoopsTpl

Located at class\template.php

Methods


					
	public

__construct()

XoopsTpl constructor.

XoopsTpl constructor.

Overrides

SmartyBC::__construct()

#


					
	public

fetchFromData(string $tplSource, bool $display = false, null $vars = null): string

Renders output from template data

Renders output from template data

Parameters

`$tplSource`	The template to render
`$display`	If rendered text should be output or returned

Returns

Rendered output if $display was false

#


					
	public

xoopsTouch(mixed $resourceName): bool

XoopsTpl::touch

XoopsTpl::touch

#


					
	public

_get_auto_id(string $cache_id = null, string $compile_id = null): string|null

returns an auto_id for auto-file-functions

returns an auto_id for auto-file-functions

#


					
	public

setCompileId(mixed $module_dirname = null, mixed $theme_set = null, mixed $template_set = null): void

XoopsTpl::setCompileId()

XoopsTpl::setCompileId()

Overrides

Smarty_Internal_TemplateBase::setCompileId()

#


					
	public

xoopsClearCache(mixed $module_dirname = null, mixed $theme_set = null, mixed $template_set = null): bool

XoopsTpl::clearCache()

XoopsTpl::clearCache()

#


					
	public

xoops_setTemplateDir($dirname)

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

xoops_getTemplateDir(): string

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

xoops_setDebugging(bool $flag = false)

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

xoops_setCaching(int $num = 0)

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

xoops_setCompileDir($dirname)

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

xoops_setCacheDir($dirname)

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

xoops_canUpdateFromFile(): bool

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

xoops_fetchFromData($data): string

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

xoops_setCacheTime(int $num = 0)

Deprecated

DO NOT USE THESE METHODS, ACCESS THE CORRESPONDING PROPERTIES INSTEAD

#


					
	public

assign_by_ref(string $tpl_var, mixed &$value)

deprecated assign_by_ref

deprecated assign_by_ref

Parameters

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

Overrides

SmartyBC::assign_by_ref()

#


					
	public

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

deprecated append_by_ref

deprecated append_by_ref

Parameters

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

Overrides

SmartyBC::append_by_ref()

#


					
	public

clear_assign(string $tpl_var)

deprecated clear_assign

deprecated clear_assign

Parameters

$tpl_var

the template variable to clear

Overrides

SmartyBC::clear_assign()

#


					
	public

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

deprecated register_function

deprecated register_function

Parameters

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

Throws

SmartyException

Overrides

SmartyBC::register_function()

#


					
	public

unregister_function(string $function)

deprecated unregister_function

deprecated unregister_function

Parameters

$function

name of template function

Overrides

SmartyBC::unregister_function()

#


					
	public

unregister_object(string $object)

deprecated unregister_object

deprecated unregister_object

Parameters

$object

name of template object

Overrides

SmartyBC::unregister_object()

#


					
	public

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

deprecated register_block

deprecated register_block

Parameters

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

Throws

SmartyException

Overrides

SmartyBC::register_block()

#


					
	public

unregister_block(string $block)

deprecated unregister_block

deprecated unregister_block

Parameters

$block

name of template function

Overrides

SmartyBC::unregister_block()

#


					
	public

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

deprecated register_compiler_function

deprecated register_compiler_function

Parameters

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

Throws

SmartyException

Overrides

SmartyBC::register_compiler_function()

#


					
	public

unregister_compiler_function(string $function)

deprecated unregister_compiler_function

deprecated unregister_compiler_function

Parameters

$function

name of template function

Overrides

SmartyBC::unregister_compiler_function()

#


					
	public

register_modifier(string $modifier, string $modifier_impl)

deprecated register_modifier

deprecated register_modifier

Parameters

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

Throws

SmartyException

Overrides

SmartyBC::register_modifier()

#


					
	public

unregister_modifier(string $modifier)

deprecated unregister_modifier

deprecated unregister_modifier

Parameters

$modifier

name of template modifier

Overrides

SmartyBC::unregister_modifier()

#


					
	public

register_resource(string $type, array $functions)

deprecated register_resource

deprecated register_resource

Parameters

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

Overrides

SmartyBC::register_resource()

#


					
	public

unregister_resource(string $type)

deprecated unregister_resource

deprecated unregister_resource

Parameters

$type

name of resource

Overrides

SmartyBC::unregister_resource()

#


					
	public

register_prefilter(callable $function)

deprecated register_prefilter

deprecated register_prefilter

Throws

SmartyException

Overrides

SmartyBC::register_prefilter()

#


					
	public

unregister_prefilter(callable $function)

deprecated unregister_prefilter

deprecated unregister_prefilter

Overrides

SmartyBC::unregister_prefilter()

#


					
	public

register_postfilter(callable $function)

deprecated register_postfilter

deprecated register_postfilter

Throws

SmartyException

Overrides

SmartyBC::register_postfilter()

#


					
	public

unregister_postfilter(callable $function)

deprecated unregister_postfilter

deprecated unregister_postfilter

Overrides

SmartyBC::unregister_postfilter()

#


					
	public

register_outputfilter(callable $function)

deprecated register_outputfilter

deprecated register_outputfilter

Throws

SmartyException

Overrides

SmartyBC::register_outputfilter()

#


					
	public

unregister_outputfilter(callable $function)

deprecated unregister_outputfilter

deprecated unregister_outputfilter

Overrides

SmartyBC::unregister_outputfilter()

#


					
	public

load_filter(string $type, string $name)

deprecated load_filter

deprecated load_filter

Parameters

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

Throws

SmartyException

Overrides

SmartyBC::load_filter()

#


					
	public

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

deprecated clear_cache

deprecated clear_cache

Parameters

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

Overrides

SmartyBC::clear_cache()

#


					
	public

clear_all_cache(string $exp_time = null): boolean

deprecated clear_all_cache

deprecated clear_all_cache

Parameters

$exp_time

expire time

Overrides

SmartyBC::clear_all_cache()

#


					
	public

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

deprecated is_cached

deprecated is_cached

Parameters

$tpl_file

name of template file

Throws

`Exception`
`SmartyException`

Overrides

SmartyBC::is_cached()

#


					
	public

clear_all_assign()

deprecated clear_all_assign

deprecated clear_all_assign

Overrides

SmartyBC::clear_all_assign()

#


					
	public

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

deprecated clear_compiled_tpl

deprecated clear_compiled_tpl

Returns

results of {@link smarty_core_rm_auto()}

Overrides

SmartyBC::clear_compiled_tpl()

#


					
	public

template_exists(string $tpl_file): bool

deprecated template_exists

deprecated template_exists

Throws

SmartyException

Overrides

SmartyBC::template_exists()

#


					
	public

get_template_vars(string $name = null): array

deprecated get_template_vars

deprecated get_template_vars

Overrides

SmartyBC::get_template_vars()

#


					
	public

get_config_vars(string $name = null): array

deprecated get_config_vars

deprecated get_config_vars

Overrides

SmartyBC::get_config_vars()

#


					
	public

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

deprecated config_load

deprecated config_load

Overrides

SmartyBC::config_load()

#


					
	public

get_registered_object(string $name): object

deprecated get_registered_object

deprecated get_registered_object

Overrides

SmartyBC::get_registered_object()

#


					
	public

clear_config(string $var = null)

deprecated clear_config

deprecated clear_config

Overrides

SmartyBC::clear_config()

#

Methods inherited from SmartyBC
`trigger_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_Internal_TemplateBase

fetch(), display(), isCached(), registerPlugin(), loadFilter(), registerFilter(), registerObject(), setCompileCheck(), setCaching(), setCacheLifetime(), 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

Properties
`public`	`xos_opal_Theme`	`$currentTheme`	#

Properties inherited from SmartyBC
`$_version, $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_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`