Class Smarty_Internal_TemplateBase

`abstract`
`extends`	`Smarty_Internal_Data`

Class with shared smarty/template methods

Smarty_Internal_Data
- Smarty_Internal_TemplateBase
  - Smarty
    - SmartyBC
      - XoopsTpl
  - Smarty_Internal_Template

Located at class\libraries\vendor\smarty\smarty\libs\sysplugins\smarty_internal_templatebase.php

Methods


					
	public

fetch(string $template = null, mixed $cache_id = null, mixed $compile_id = null, object $parent = null): string

fetches a rendered Smarty template

Parameters

`$template`	the resource handle of the template file or template object
`$cache_id`	cache id to be used with this template
`$compile_id`	compile id to be used with this template
`$parent`	next higher level of Smarty variables

Returns

rendered template output

Throws

`Exception`
`SmartyException`


					
	public

display(string $template = null, mixed $cache_id = null, mixed $compile_id = null, object $parent = null)

displays a Smarty template

Parameters

`$template`	the resource handle of the template file or template object
`$cache_id`	cache id to be used with this template
`$compile_id`	compile id to be used with this template
`$parent`	next higher level of Smarty variables

Throws

`Exception`
`SmartyException`


					
	public

isCached(
	null|string|Smarty_Internal_Template $template = null,
	mixed $cache_id = null,
	mixed $compile_id = null,
	object $parent = null,
): bool

test if cache is valid

Parameters

`$template`	the resource handle of the template file or template object
`$cache_id`	cache id to be used with this template
`$compile_id`	compile id to be used with this template
`$parent`	next higher level of Smarty variables

Returns

cache status

Throws

`Exception`
`SmartyException`


					
	public

registerPlugin(
	string $type,
	string $name,
	callable $callback,
	bool $cacheable = true,
	mixed $cache_attr = null,
): Smarty|Smarty_Internal_Template

Registers plugin to be used in templates

Parameters

`$type`	plugin type
`$name`	name of template tag
`$callback`	PHP callback to register
`$cacheable`	if true (default) this function is cache able
`$cache_attr`	caching attributes if any

Throws

SmartyException


					
	public

loadFilter(string $type, string $name): bool

load a filter of specified type and name

Parameters

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

Throws

SmartyException


					
	public

registerFilter(string $type, callable $callback, string|null $name = null): Smarty|Smarty_Internal_Template

Registers a filter function

Parameters

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

Throws

SmartyException


					
	public

registerObject(
	string $object_name,
	object $object,
	array $allowed_methods_properties = [],
	bool $format = true,
	array $block_methods = [],
): Smarty|Smarty_Internal_Template

Registers object to be used in templates

Parameters

`$object`	the referenced PHP object to register
`$allowed_methods_properties`	list of allowed methods (empty = all)
`$format`	smarty argument format, else traditional
`$block_methods`	list of block-methods

Throws

SmartyException


					
	public

setCompileCheck(int $compile_check)


					
	public

setCaching(int $caching)


					
	public

setCacheLifetime(int $cache_lifetime)


					
	public

setCompileId(string $compile_id)

Overriden by

XoopsTpl::setCompileId()


					
	public

setCacheId(string $cache_id)


					
	public

addAutoloadFilters(mixed $filters, string $type = null): Smarty_Internal_TemplateBase


					
	public

addDefaultModifiers(mixed $modifiers): Smarty_Internal_TemplateBase


					
	public

addLiterals(mixed $literals): Smarty_Internal_TemplateBase


					
	public

createData(Smarty_Internal_Data $parent = null, string $name = null): Smarty_Internal_TemplateBase


					
	public

getAutoloadFilters(string $type = null): array


					
	public

getDebugTemplate(): string


					
	public

getDefaultModifier(): array


					
	public

getLiterals(): array


					
	public

getTags(mixed $template = null): array


					
	public

getRegisteredObject(string $object_name): object


					
	public

registerCacheResource(string $name, Smarty_CacheResource $resource_handler): Smarty_Internal_TemplateBase


					
	public

registerClass(string $class_name, string $class_impl): Smarty_Internal_TemplateBase


					
	public

registerDefaultConfigHandler(callback $callback): Smarty_Internal_TemplateBase


					
	public

registerDefaultPluginHandler(callback $callback): Smarty_Internal_TemplateBase


					
	public

registerDefaultTemplateHandler(callback $callback): Smarty_Internal_TemplateBase


					
	public

registerResource(string $name, mixed $resource_handler): Smarty_Internal_TemplateBase


					
	public

setAutoloadFilters(mixed $filters, string $type = null): Smarty_Internal_TemplateBase


					
	public

setDebugTemplate(string $tpl_name): Smarty_Internal_TemplateBase


					
	public

setDefaultModifiers(mixed $modifiers): Smarty_Internal_TemplateBase


					
	public

setLiterals(mixed $literals): Smarty_Internal_TemplateBase


					
	public

unloadFilter(string $type, string $name): Smarty_Internal_TemplateBase


					
	public

unregisterCacheResource(string $name): Smarty_Internal_TemplateBase


					
	public

unregisterObject(string $object_name): Smarty_Internal_TemplateBase


					
	public

unregisterPlugin(string $type, string $name): Smarty_Internal_TemplateBase


					
	public

unregisterFilter(string $type, mixed $callback): Smarty_Internal_TemplateBase


					
	public

unregisterResource(string $name): Smarty_Internal_TemplateBase

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

Properties
`public`	`string`	`$cache_id = null`	#
`public`	`string`	`$compile_id = null`	#
`public`	`int`	`$caching = Smarty::CACHING_OFF`	#
`public`	`int`	`$compile_check = Smarty::COMPILECHECK_ON`	#
`public`	`integer`	`$cache_lifetime = 3600`	#
`public`	`array`	`$tplFunctions = []`	#
`public`		`$_cache = []` universal cache universal cache	#
`public`	`int`	`$_objType`	#

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

Namespaces

Classes

Interfaces

Exceptions

Functions

Class Smarty_Internal_TemplateBase

Parameters

Returns

Throws

Parameters

Throws

Parameters

Returns

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Overriden by