Docs For Class Smarty_Internal

Description

Base class with template and variable methodes

Located in /libs/sysplugins/smarty_internal_data.php (line 18)

Direct descendents

Class	Description
Smarty_Data	class for the Smarty data object
Smarty_Internal_Debug	Smarty Internal Plugin Debug Class
Smarty_Internal_TemplateBase	Class with shared template methodes

Variable Summary

array $config_vars

Smarty_Internal_Template $parent

string $template_class

array $tpl_vars

Method Summary

Smarty_Internal_Data append (array|string $tpl_var, [mixed $value = null], [boolean $merge = false], [boolean $nocache = false])

Smarty_Internal_Data appendByRef (string $tpl_var, mixed &$value, [boolean $merge = false])

Smarty_Internal_Data assign (array|string $tpl_var, [mixed $value = null], [boolean $nocache = false], boolean $scope)

Smarty_Internal_Data assignByRef (string $tpl_var, &$value, [boolean $nocache = false], mixed $)

Smarty_Internal_Data assignGlobal (string $varname, [mixed $value = null], [boolean $nocache = false])

Smarty_Internal_Data clearAllAssign ()

Smarty_Internal_Data clearAssign (string|array $tpl_var)

Smarty_Internal_Data clearConfig ([string $varname = null])

Smarty_Internal_Data configLoad (string $config_file, [mixed $sections = null])

mixed getConfigVariable (string $variable, [ $error_enable = true])

string getConfigVars ([string $varname = null], [ $search_parents = true])

mixed getStreamVariable (string $variable)

string getTemplateVars ([string $varname = null], [string $_ptr = null], [boolean $search_parents = true])

object the getVariable (string $variable, [object $_ptr = null], [boolean $search_parents = true], [ $error_enable = true])

Variables

array $config_vars = array() (line 43)

configuration settings

access: public

Smarty_Internal_Template $parent = null (line 37)

parent template (if any)

access: public

string $template_class = 'Smarty_Internal_Template' (line 25)

name of class used for templates

access: public

array $tpl_vars = array() (line 31)

template variables

access: public

Methods

append (line 119)

appends values to template variables

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data append (array|string $tpl_var, [mixed $value = null], [boolean $merge = false], [boolean $nocache = false])

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

appendByRef (line 179)

appends values to template variables by reference

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data appendByRef (string $tpl_var, mixed &$value, [boolean $merge = false])

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

assign (line 54)

assigns a Smarty variable

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data assign (array|string $tpl_var, [mixed $value = null], [boolean $nocache = false], boolean $scope)

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)

assignByRef (line 100)

assigns values to template variables by reference

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data assignByRef (string $tpl_var, &$value, [boolean $nocache = false], mixed $)

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
&$value

assignGlobal (line 79)

assigns a global Smarty variable

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data assignGlobal (string $varname, [mixed $value = null], [boolean $nocache = false])

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

clearAllAssign (line 268)

clear all the assigned template variables.

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data clearAllAssign ()

clearAssign (line 251)

clear the given assigned template variable.

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data clearAssign (string|array $tpl_var)

string|array $tpl_var: the template variable(s) to clear

clearConfig (line 411)

Deassigns a single or all config variables

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data clearConfig ([string $varname = null])

string $varname: variable name or null

configLoad (line 281)

load a config file, optionally load just selected sections

return: current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining
access: public

Smarty_Internal_Data configLoad (string $config_file, [mixed $sections = null])

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

getConfigVariable (line 330)

gets a config variable

return: the value of the config variable
access: public

mixed getConfigVariable (string $variable, [ $error_enable = true])

string $variable: the name of the config variable
$error_enable

getConfigVars (line 379)

Returns a single or all config variables

return: variable value or or array of variables
access: public

string getConfigVars ([string $varname = null], [ $search_parents = true])

string $varname: variable name or null
$search_parents

getStreamVariable (line 354)

gets a stream variable

return: the value of the stream variable
access: public

mixed getStreamVariable (string $variable)

string $variable: the stream of the variable

getTemplateVars (line 208)

Returns a single or all template variables

return: variable value or or array of variables
access: public

string getTemplateVars ([string $varname = null], [string $_ptr = null], [boolean $search_parents = true])

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

getVariable (line 297)

gets the object of a Smarty variable

return: object of the variable
access: public

object the getVariable (string $variable, [object $_ptr = null], [boolean $search_parents = true], [ $error_enable = true])

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

Class Smarty_Internal_Data