Methods summary
public
Smarty_Internal_Data
|
#
assign( array|string $tpl_var, mixed $value = null, boolean $nocache = false )
assigns a Smarty variable
assigns a Smarty variable
Parameters
- $tpl_var
- the template variable name(s)
- $value
- the value to assign
- $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
|
public
Smarty_Internal_Data
|
#
assignGlobal( string $varname, mixed $value = null, boolean $nocache = false )
assigns a global Smarty variable
assigns a global Smarty variable
Parameters
- $varname
- the global variable name
- $value
- the value to assign
- $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
|
public
Smarty_Internal_Data
|
#
assignByRef( string $tpl_var, & $value, boolean $nocache = false )
assigns values to template variables by reference
assigns values to template variables by reference
Parameters
- $tpl_var
- the template variable name
- $value
- $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
|
public
Smarty_Internal_Data
|
#
append( array|string $tpl_var, mixed $value = null, boolean $merge = false, boolean $nocache = false )
appends values to template variables
appends values to template variables
Parameters
- $tpl_var
- the template variable name(s)
- $value
- the value to append
- $merge
- flag if array elements shall be merged
- $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
|
public
Smarty_Internal_Data
|
#
appendByRef( string $tpl_var, mixed & $value, boolean $merge = false )
appends values to template variables by reference
appends values to template variables by reference
Parameters
- $tpl_var
- the template variable name
- $value
- $value the referenced value to append
- $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
|
public
string
|
#
getTemplateVars( string $varname = null, object $_ptr = null, boolean $search_parents = true )
Returns a single or all template variables
Returns a single or all template variables
Parameters
- $varname
- variable name or null
- $_ptr
- optional pointer to data object
- $search_parents
- include parent templates?
Returns
string variable value or or array of variables
|
public
Smarty_Internal_Data
|
#
clearAssign( string|array $tpl_var )
clear the given assigned template variable.
clear the given assigned template variable.
Parameters
- $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
|
public
Smarty_Internal_Data
|
#
clearAllAssign( )
clear all the assigned template variables.
clear all the assigned template variables.
Returns
Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
|
public
Smarty_Internal_Data
|
#
configLoad( string $config_file, mixed $sections = null )
load a config file, optionally load just selected sections
load a config file, optionally load just selected sections
Parameters
- $config_file
- filename
- $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
|
public
object
|
#
getVariable( string $variable, object $_ptr = null, boolean $search_parents = true, boolean $error_enable = true )
gets the object of a Smarty variable
gets the object of a Smarty variable
Parameters
- $variable
- the name of the Smarty variable
- $_ptr
- optional pointer to data object
- $search_parents
- search also in parent data
- $error_enable
Returns
object the object of the variable
|
public
mixed
|
#
getConfigVariable( string $variable, boolean $error_enable = true )
gets a config variable
Parameters
- $variable
- the name of the config variable
- $error_enable
Returns
mixed the value of the config variable
|
public
mixed
|
#
getStreamVariable( string $variable )
gets a stream variable
Parameters
- $variable
- the stream of the variable
Returns
mixed the value of the stream variable
Throws
|
public
string
|
#
getConfigVars( string $varname = null, boolean $search_parents = true )
Returns a single or all config variables
Returns a single or all config variables
Parameters
- $varname
- variable name or null
- $search_parents
Returns
string variable value or or array of variables
|
public
Smarty_Internal_Data
|
#
clearConfig( string $varname = null )
Deassigns a single or all config variables
Deassigns a single or all config variables
Parameters
- $varname
- variable name or null
Returns
Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
|