creates a data object
-
object
$parent: next higher level of Smarty variables
displays a Smarty template
void
display
([string $template = null], [mixed $cache_id = null], [mixed $compile_id = null], [object $parent = null])
-
string
$template: the resource handle of the template file or template object
-
mixed
$cache_id: cache id to be used with this template
-
mixed
$compile_id: compile id to be used with this template
-
object
$parent: next higher level of Smarty variables
fetches a rendered Smarty template
string
fetch
([string $template = null], [mixed $cache_id = null], [mixed $compile_id = null], [object $parent = null], [bool $display = false], [bool $merge_tpl_vars = true], [bool $no_output_filter = false])
-
string
$template: the resource handle of the template file or template object
-
mixed
$cache_id: cache id to be used with this template
-
mixed
$compile_id: compile id to be used with this template
-
object
$parent: next higher level of Smarty variables
-
bool
$display: true: display, false: fetch
-
bool
$merge_tpl_vars: if true parent template variables merged in to local scope
-
bool
$no_output_filter: if true do not run output filter
return a reference to a registered object
object
getRegisteredObject
(string $name)
-
string
$name: object name
test if cache is valid
boolean
isCached
([string|object $template = null], [mixed $cache_id = null], [mixed $compile_id = null], [object $parent = null])
-
string|object
$template: the resource handle of the template file or template object
-
mixed
$cache_id: cache id to be used with this template
-
mixed
$compile_id: compile id to be used with this template
-
object
$parent: next higher level of Smarty variables
load a filter of specified type and name
bool
loadFilter
(string $type, string $name)
-
string
$type: filter type
-
string
$name: filter name
Registers a cache resource to cache a template's output
-
string
$type: name of cache resource type
-
Smarty_CacheResource
$callback: instance of Smarty_CacheResource to handle output caching
Registers static classes to be used in templates
void
registerClass
( $class_name, string $class_impl, string $class)
-
string
$class: name of template class
-
string
$class_impl: the referenced PHP class to register
-
$class_name
Registers a default template handler
void
registerDefaultConfigHandler
(callable $callback)
-
callable
$callback: class/method name
Registers a default plugin handler
void
registerDefaultPluginHandler
(callable $callback)
-
callable
$callback: class/method name
Registers a default template handler
void
registerDefaultTemplateHandler
(callable $callback)
-
callable
$callback: class/method name
Registers a filter function
void
registerFilter
(string $type, callback $callback)
-
string
$type: filter type
-
callback
$callback
Registers object to be used in templates
void
registerObject
( $object_name, object $object_impl, [array $allowed = array()], [boolean $smarty_args = true], [array $block_methods = array()], string $object, 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_methods: list of block-methods
-
array
$block_functs: list of methods that are block format
-
$object_name
Registers plugin to be used in templates
void
registerPlugin
(string $type, string $tag, callback $callback, [boolean $cacheable = true], [array $cache_attr = null])
-
string
$type: plugin type
-
string
$tag: name of template tag
-
callback
$callback: PHP callback to register
-
boolean
$cacheable: if true (default) this fuction is cachable
-
array
$cache_attr: caching attributes if any
Registers a resource to fetch a template
-
string
$type: name of resource type
-
Smarty_Resource|array
$callback: or instance of Smarty_Resource, or array of callbacks to handle resource (deprecated)
Unregisters a cache resource
void
unregisterCacheResource
(string $type)
-
string
$type: name of cache resource type
Unregisters a filter function
void
unregisterFilter
(string $type, callback $callback)
-
string
$type: filter type
-
callback
$callback
unregister an object
void
unregisterObject
(string $name)
-
string
$name: object name
Unregister Plugin
void
unregisterPlugin
(string $type, string $tag)
-
string
$type: of plugin
-
string
$tag: name of plugin
Unregisters a resource
void
unregisterResource
(string $type)
-
string
$type: name of resource type
Return internal filter name
void
_get_filter_name
(callback $function_name)
Handle unknown class methods
void
__call
(string $name, array $args)
-
string
$name: unknown method-name
-
array
$args: argument array
Inherited Methods
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()