Inheritance diagram for Smarty_Internal_TemplateBase:

Public Member Functions
	fetch ($template=null, $cache_id=null, $compile_id=null, $parent=null, $display=false, $merge_tpl_vars=true, $no_output_filter=false)
	fetches a rendered Smarty template More...

	display ($template=null, $cache_id=null, $compile_id=null, $parent=null)
	displays a Smarty template More...

	isCached ($template=null, $cache_id=null, $compile_id=null, $parent=null)
	test if cache is valid More...

	createData ($parent=null)
	creates a data object More...

	registerPlugin ($type, $tag, $callback, $cacheable=true, $cache_attr=null)
	Registers plugin to be used in templates. More...

	unregisterPlugin ($type, $tag)
	Unregister Plugin. More...

	registerResource ($type, $callback)
	Registers a resource to fetch a template. More...

	unregisterResource ($type)
	Unregisters a resource. More...

	registerCacheResource ($type, Smarty_CacheResource $callback)
	Registers a cache resource to cache a template's output. More...

	unregisterCacheResource ($type)
	Unregisters a cache resource. More...

	registerObject ($object_name, $object_impl, $allowed=array(), $smarty_args=true, $block_methods=array())
	Registers object to be used in templates. More...

	getRegisteredObject ($name)
	return a reference to a registered object More...

	unregisterObject ($name)
	unregister an object More...

	registerClass ($class_name, $class_impl)
	Registers static classes to be used in templates. More...

	registerDefaultPluginHandler ($callback)
	Registers a default plugin handler. More...

	registerDefaultTemplateHandler ($callback)
	Registers a default template handler. More...

	registerDefaultConfigHandler ($callback)
	Registers a default template handler. More...

	registerFilter ($type, $callback)
	Registers a filter function. More...

	unregisterFilter ($type, $callback)
	Unregisters a filter function. More...

	_get_filter_name ($function_name)
	Return internal filter name. More...

	loadFilter ($type, $name)
	load a filter of specified type and name More...

	unloadFilter ($type, $name)
	unload a filter of specified type and name More...

	__call ($name, $args)
	Handle unknown class methods. More...

Public Member Functions inherited from Smarty_Internal_Data
	assign ($tpl_var, $value=null, $nocache=false)
	assigns a Smarty variable More...

	assignGlobal ($varname, $value=null, $nocache=false)
	assigns a global Smarty variable More...

	assignByRef ($tpl_var, &$value, $nocache=false)
	assigns values to template variables by reference More...

	append ($tpl_var, $value=null, $merge=false, $nocache=false)
	appends values to template variables More...

	appendByRef ($tpl_var, &$value, $merge=false)
	appends values to template variables by reference More...

	getTemplateVars ($varname=null, $_ptr=null, $search_parents=true)
	Returns a single or all template variables. More...

	clearAssign ($tpl_var)
	clear the given assigned template variable. More...

	clearAllAssign ()
	clear all the assigned template variables. More...

	configLoad ($config_file, $sections=null)
	load a config file, optionally load just selected sections More...

	getVariable ($variable, $_ptr=null, $search_parents=true, $error_enable=true)
	gets the object of a Smarty variable More...

	getConfigVariable ($variable, $error_enable=true)
	gets a config variable More...

	getStreamVariable ($variable)
	gets a stream variable More...

	getConfigVars ($varname=null, $search_parents=true)
	Returns a single or all config variables. More...

	clearConfig ($varname=null)
	Deassigns a single or all config variables. More...

Additional Inherited Members
Data Fields inherited from Smarty_Internal_Data
	$template_class = 'Smarty_Internal_Template'

	$tpl_vars = array()

	$parent = null

	$config_vars = array()

Detailed Description

Definition at line 18 of file smarty_internal_templatebase.php.

Member Function Documentation

__call	(	$name,
		$args
	)

Handle unknown class methods.

Parameters

string	$name	unknown method-name
array	$args	argument array

Definition at line 756 of file smarty_internal_templatebase.php.

_get_filter_name ( $function_name )

Return internal filter name.

Parameters

callback $function_name

Returns: string internal filter name

Definition at line 689 of file smarty_internal_templatebase.php.

createData ( $parent = null )

creates a data object

Parameters

object $parent next higher level of Smarty variables

Returns: Smarty_Data data object

Definition at line 410 of file smarty_internal_templatebase.php.

display	(	$template = `null`,
		$cache_id = `null`,
		$compile_id = `null`,
		$parent = `null`
	)

displays a Smarty template

Parameters

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

Definition at line 374 of file smarty_internal_templatebase.php.

fetch	(	$template = `null`,
		$cache_id = `null`,
		$compile_id = `null`,
		$parent = `null`,
		$display = `false`,
		$merge_tpl_vars = `true`,
		$no_output_filter = `false`
	)

fetches a rendered Smarty template

Parameters

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

Returns: string rendered template output

Definition at line 32 of file smarty_internal_templatebase.php.

getRegisteredObject ( $name )

return a reference to a registered object

Parameters

string $name object name

Returns: object

Exceptions

SmartyException if no such object is found

Definition at line 554 of file smarty_internal_templatebase.php.

isCached	(	$template = `null`,
		$cache_id = `null`,
		$compile_id = `null`,
		$parent = `null`
	)

test if cache is valid

Parameters

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

Returns: boolean cache status

Definition at line 389 of file smarty_internal_templatebase.php.

loadFilter	(	$type,
		$name
	)

load a filter of specified type and name

Parameters

string	$type	filter type
string	$name	filter name

Exceptions

SmartyException if filter could not be loaded

Definition at line 707 of file smarty_internal_templatebase.php.

registerCacheResource	(		$type,
		Smarty_CacheResource	$callback
	)

Registers a cache resource to cache a template's output.

Parameters

string	$type	name of cache resource type
Smarty_CacheResource	$callback	instance of Smarty_CacheResource to handle output caching

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 490 of file smarty_internal_templatebase.php.

registerClass	(	$class_name,
		$class_impl
	)

Registers static classes to be used in templates.

Parameters

string	$class	name of template class
string	$class_impl	the referenced PHP class to register

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Exceptions

SmartyException if $class_impl does not refer to an existing class

Definition at line 588 of file smarty_internal_templatebase.php.

registerDefaultConfigHandler ( $callback )

Registers a default template handler.

Parameters

callable $callback class/method name

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Exceptions

SmartyException if $callback is not callable

Definition at line 642 of file smarty_internal_templatebase.php.

registerDefaultPluginHandler ( $callback )

Registers a default plugin handler.

Parameters

callable $callback class/method name

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Exceptions

SmartyException if $callback is not callable

Definition at line 606 of file smarty_internal_templatebase.php.

registerDefaultTemplateHandler ( $callback )

Registers a default template handler.

Parameters

callable $callback class/method name

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Exceptions

SmartyException if $callback is not callable

Definition at line 624 of file smarty_internal_templatebase.php.

registerFilter	(	$type,
		$callback
	)

Registers a filter function.

Parameters

string	$type	filter type
callback	$callback

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 660 of file smarty_internal_templatebase.php.

registerObject	(	$object_name,
		$object_impl,
		$allowed = `array()`,
		$smarty_args = `true`,
		$block_methods = `array()`
	)

Registers object to be used in templates.

Parameters

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

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Exceptions

SmartyException if any of the methods in $allowed or $block_methods are invalid

Definition at line 523 of file smarty_internal_templatebase.php.

registerPlugin	(	$type,
		$tag,
		$callback,
		$cacheable = `true`,
		$cache_attr = `null`
	)

Registers plugin to be used in templates.

Parameters

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

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Exceptions

SmartyException when the plugin tag is invalid

Definition at line 426 of file smarty_internal_templatebase.php.

registerResource	(	$type,
		$callback
	)

Registers a resource to fetch a template.

Parameters

string	$type	name of resource type
Smarty_Resource \| array	$callback	or instance of Smarty_Resource, or array of callbacks to handle resource (deprecated)

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 462 of file smarty_internal_templatebase.php.

unloadFilter	(	$type,
		$name
	)

unload a filter of specified type and name

Parameters

string	$type	filter type
string	$name	filter name

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 730 of file smarty_internal_templatebase.php.

unregisterCacheResource ( $type )

Unregisters a cache resource.

Parameters

string $type name of cache resource type

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 502 of file smarty_internal_templatebase.php.

unregisterFilter	(	$type,
		$callback
	)

Unregisters a filter function.

Parameters

string	$type	filter type
callback	$callback

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 673 of file smarty_internal_templatebase.php.

unregisterObject ( $name )

unregister an object

Parameters

string $name object name

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 571 of file smarty_internal_templatebase.php.

unregisterPlugin	(	$type,
		$tag
	)

Unregister Plugin.

Parameters

string	$type	of plugin
string	$tag	name of plugin

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 446 of file smarty_internal_templatebase.php.

unregisterResource ( $type )

Unregisters a resource.

Parameters

string $type name of resource type

Returns: Smarty_Internal_Templatebase current Smarty_Internal_Templatebase (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 474 of file smarty_internal_templatebase.php.

The documentation for this class was generated from the following file:

lib/templateEngines/smarty/sysplugins/smarty_internal_templatebase.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation