Class Smarty_Internal_TemplateBase

Class with shared smarty/template methods

Smarty_Internal_TemplateBase

Direct known subclasses

Smarty, Smarty_Internal_Template

Abstract
Package: Smarty\Template
Author: Uwe Tews
Located at tpl/smarty/sysplugins/smarty_internal_templatebase.php

Methods summary

`public string`	# `fetch( string $template = null, mixed $cache_id = null, mixed $compile_id = null, object $parent = null )` fetches a rendered Smarty template 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 string 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 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
`public boolean`	# `isCached( null\|string\|Smarty_Internal_Template $template = null, mixed $cache_id = null, mixed $compile_id = null, object $parent = null )` test if cache is valid 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 boolean cache status Link http://www.smarty.net/docs/en/api.is.cached.tpl Api Smarty::isCached()
`public Smarty\|Smarty_Internal_Template`	# `registerPlugin( string $type, string $name, callable $callback, boolean $cacheable = true, mixed $cache_attr = null )` Registers plugin to be used in templates 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 Returns `Smarty`\|`Smarty_Internal_Template` Throws `SmartyException` when the plugin tag is invalid Link http://www.smarty.net/docs/en/api.register.plugin.tpl Api Smarty::registerPlugin()
`public boolean`	# `loadFilter( string $type, string $name )` load a filter of specified type and name load a filter of specified type and name Parameters `$type` filter type `$name` filter name Returns boolean Throws `SmartyException` if filter could not be loaded Link http://www.smarty.net/docs/en/api.load.filter.tpl Api Smarty::loadFilter()
`public Smarty\|Smarty_Internal_Template`	# `registerFilter( string $type, callable $callback, string\|null $name = null )` Registers a filter function Registers a filter function Parameters `$type` filter type `$callback` `$name` optional filter name Returns `Smarty`\|`Smarty_Internal_Template` Throws `SmartyException` Link http://www.smarty.net/docs/en/api.register.filter.tpl Api Smarty::registerFilter()
`public Smarty\|Smarty_Internal_Template`	# `registerObject( string $object_name, object $object, array $allowed_methods_properties = array(), boolean $format = true, array $block_methods = array() )` Registers object to be used in templates Registers object to be used in templates Parameters `$object_name` `$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 Returns `Smarty`\|`Smarty_Internal_Template` Throws `SmartyException` Link http://www.smarty.net/docs/en/api.register.object.tpl Api Smarty::registerObject()
`public`	# `setCaching( boolean $caching )` Parameters `$caching`
`public`	# `setCacheLifetime( integer $cache_lifetime )` Parameters `$cache_lifetime`
`public`	# `setCompileId( string $compile_id )` Parameters `$compile_id`
`public`	# `setCacheId( string $cache_id )` Parameters `$cache_id`

Methods inherited from Smarty_Internal_Data

__call(), __construct(), _mergeVars(), append(), appendByRef(), assign(), assignByRef(), assignGlobal(), getTemplateVars(), getVariable()

Magic methods summary

`public Smarty_Internal_TemplateBase`	# `addAutoloadFilters( mixed $filters, string $type = null )` Parameters `$filters` `$type` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `addDefaultModifier( mixed $modifiers )` Parameters `$modifiers` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `createData( Smarty_Internal_Data $parent = null, string $name = null )` Parameters `$parent` `$name` Returns `Smarty_Internal_TemplateBase`
`public array`	# `getAutoloadFilters( string $type = null )` Parameters `$type` Returns array
`public string`	# `getDebugTemplate( )` Returns string
`public array`	# `getDefaultModifier( )` Returns array
`public array`	# `getTags( mixed $template = null )` Parameters `$template` Returns array
`public object`	# `getRegisteredObject( string $object_name )` Parameters `$object_name` Returns object
`public Smarty_Internal_TemplateBase`	# `registerCacheResource( string $name, Smarty_CacheResource $resource_handler )` Parameters `$name` `$resource_handler` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `registerClass( string $class_name, string $class_impl )` Parameters `$class_name` `$class_impl` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `registerDefaultConfigHandler( callable $callback )` Parameters `$callback` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `registerDefaultPluginHandler( callable $callback )` Parameters `$callback` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `registerDefaultTemplateHandler( callable $callback )` Parameters `$callback` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `registerResource( string $name, mixed $resource_handler )` Parameters `$name` `$resource_handler` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `setAutoloadFilters( mixed $filters, string $type = null )` Parameters `$filters` `$type` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `setDebugTemplate( string $tpl_name )` Parameters `$tpl_name` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `setDefaultModifier( mixed $modifiers )` Parameters `$modifiers` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `unloadFilter( string $type, string $name )` Parameters `$type` `$name` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `unregisterCacheResource( string $name )` Parameters `$name` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `unregisterObject( string $object_name )` Parameters `$object_name` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `unregisterPlugin( string $type, string $name )` Parameters `$type` `$name` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `unregisterFilter( string $type, mixed $callback )` Parameters `$type` `$callback` Returns `Smarty_Internal_TemplateBase`
`public Smarty_Internal_TemplateBase`	# `unregisterResource( string $name )` Parameters `$name` Returns `Smarty_Internal_TemplateBase`

Magic methods inherited from Smarty_Internal_Data

clearAllAssign(), clearAssign(), clearConfig(), configLoad(), getConfigVars(), getGlobal(), getStreamVariable()

Properties summary

`public string`	`$cache_id` Set this if you want different sets of cache files for the same templates. Set this if you want different sets of cache files for the same templates.	# `null`
`public string`	`$compile_id` Set this if you want different sets of compiled files for the same templates. Set this if you want different sets of compiled files for the same templates.	# `null`
`public boolean`	`$caching` caching enabled caching enabled	# `false`
`public integer`	`$cache_lifetime` cache lifetime in seconds cache lifetime in seconds	# `3600`
`public array()`	`$_cache` universal cache universal cache	# `array()`

Properties inherited from Smarty_Internal_Data

$_objType, $config_vars, $ext, $parent, $template_class, $tpl_vars

Magic properties

`public Smarty`	`$smarty` The following methods will be dynamically loaded by the extension handler when they are called. They are located in a corresponding Smarty_Internal_Method_xxxx class

Magic properties inherited from Smarty_Internal_Data

$scope

Classes

Exceptions

Functions

Class Smarty_Internal_TemplateBase

Direct known subclasses

Methods summary

Parameters

Returns

Throws

Parameters

Parameters

Returns

Link

Api

Parameters

Returns

Throws

Link

Api

Parameters

Returns

Throws

Link

Api

Parameters

Returns

Throws

Link

Api

Parameters

Returns

Throws

Link

Api

Parameters

Parameters

Parameters

Parameters

Methods inherited from Smarty_Internal_Data

Magic methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns