Smarty_Internal_Data Class Reference

Inheritance diagram for Smarty_Internal_Data:

Public Member Functions
	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...

Data Fields
	$template_class = 'Smarty_Internal_Template'
	$tpl_vars = array()
	$parent = null
	$config_vars = array()

Detailed Description

Definition at line 18 of file smarty_internal_data.php.

Member Function Documentation

append	(		$tpl_var,
			$value = null,
			$merge = false,
			$nocache = false
	)

appends values to template variables

Parameters

array | string	$tpl_var	the template variable name(s)
mixed	$value	the value to append
boolean	$merge	flag if array elements shall be merged
boolean	$nocache	if true any output of this variable will be not cached

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 119 of file smarty_internal_data.php.

appendByRef	(		$tpl_var,
		&	$value,
			$merge = false
	)

appends values to template variables by reference

Parameters

string	$tpl_var	the template variable name
mixed	&$value	the referenced value to append
boolean	$merge	flag if array elements shall be merged

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 179 of file smarty_internal_data.php.

assign	(		$tpl_var,
			$value = null,
			$nocache = false
	)

assigns a Smarty variable

Parameters

array | string	$tpl_var	the template variable name(s)
mixed	$value	the value to assign
boolean	$nocache	if true any output of this variable will be not cached
boolean	$scope	the scope the variable will have (local,parent or root)

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 54 of file smarty_internal_data.php.

assignByRef	(		$tpl_var,
		&	$value,
			$nocache = false
	)

assigns values to template variables by reference

Parameters

string	$tpl_var	the template variable name
	mixed	$ &$value the referenced value to assign
boolean	$nocache	if true any output of this variable will be not cached

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 100 of file smarty_internal_data.php.

assignGlobal	(		$varname,
			$value = null,
			$nocache = false
	)

assigns a global Smarty variable

Parameters

string	$varname	the global variable name
mixed	$value	the value to assign
boolean	$nocache	if true any output of this variable will be not cached

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 79 of file smarty_internal_data.php.

clearAllAssign

(

)

clear all the assigned template variables.

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 268 of file smarty_internal_data.php.

clearAssign

(

$tpl_var

)

clear the given assigned template variable.

Parameters

string | array

$tpl_var

the template variable(s) to clear

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 251 of file smarty_internal_data.php.

clearConfig

(

$varname = null

)

Deassigns a single or all config variables.

Parameters

string

$varname

variable name or null

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 411 of file smarty_internal_data.php.

configLoad	(		$config_file,
			$sections = null
	)

load a config file, optionally load just selected sections

Parameters

string	$config_file	filename
mixed	$sections	array of section names, single section or null

Returns

Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Definition at line 281 of file smarty_internal_data.php.

getConfigVariable	(		$variable,
			$error_enable = true
	)

gets a config variable

Parameters

string

$variable

the name of the config variable

Returns

mixed the value of the config variable

Definition at line 330 of file smarty_internal_data.php.

getConfigVars	(		$varname = null,
			$search_parents = true
	)

Returns a single or all config variables.

Parameters

string

$varname

variable name or null

Returns

string variable value or or array of variables

Definition at line 379 of file smarty_internal_data.php.

getStreamVariable

(

$variable

)

gets a stream variable

Parameters

string

$variable

the stream of the variable

Returns

mixed the value of the stream variable

Definition at line 354 of file smarty_internal_data.php.

getTemplateVars	(		$varname = null,
			$_ptr = null,
			$search_parents = true
	)

Returns a single or all template variables.

Parameters

string	$varname	variable name or null
string	$_ptr	optional pointer to data object
boolean	$search_parents	include parent templates?

Returns

string variable value or or array of variables

Definition at line 208 of file smarty_internal_data.php.

getVariable	(		$variable,
			$_ptr = null,
			$search_parents = true,
			$error_enable = true
	)

gets the object of a Smarty variable

Parameters

string	$variable	the name of the Smarty variable
object	$_ptr	optional pointer to data object
boolean	$search_parents	search also in parent data

Returns

object the object of the variable

Definition at line 297 of file smarty_internal_data.php.

Field Documentation

$config_vars = array()

Definition at line 43 of file smarty_internal_data.php.

$parent = null

Definition at line 37 of file smarty_internal_data.php.

$template_class = 'Smarty_Internal_Template'

Definition at line 25 of file smarty_internal_data.php.

$tpl_vars = array()

Definition at line 31 of file smarty_internal_data.php.

---

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

• lib/templateEngines/smarty/sysplugins/smarty_internal_data.php