Class Smarty_Internal_Data

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
Method Summary
void append (array|string $tpl_var, [mixed $value = null], [boolean $merge = false], [boolean $nocache = false])
void appendByRef (string $tpl_var, mixed &$value, [boolean $merge = false])
void assign (array|string $tpl_var, [mixed $value = null], [boolean $nocache = false], boolean $scope)
void assignByRef (string $tpl_var,  &$value, [boolean $nocache = false], mixed $)
void assignGlobal (string $varname, [mixed $value = null], [boolean $nocache = false])
void clearAllAssign ()
void clearAssign (string|array $tpl_var)
void clearConfig ([string $varname = null])
void 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 114)

appends values to template variables

  • access: public
void 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 171)

appends values to template variables by reference

  • access: public
void 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 53)

assigns a Smarty variable

  • access: public
void 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 98)

assigns values to template variables by reference

  • access: public
void 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 85)

assigns a global Smarty variable

  • access: public
void 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 254)

clear all the assigned template variables.

  • access: public
void clearAllAssign ()
clearAssign (line 240)

clear the given assigned template variable.

  • access: public
void clearAssign (string|array $tpl_var)
  • string|array $tpl_var: the template variable(s) to clear
clearConfig (line 393)

Deassigns a single or all config variables

  • access: public
void clearConfig ([string $varname = null])
  • string $varname: variable name or null
configLoad (line 265)

load a config file, optionally load just selected sections

  • access: public
void configLoad (string $config_file, [mixed $sections = null])
  • string $config_file: filename
  • mixed $sections: array of section names, single section or null
getConfigVariable (line 313)

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 362)

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 337)

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 198)

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 280)

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

Documentation generated on Sat, 24 Sep 2011 20:23:52 +0200 by phpDocumentor 1.4.1