[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/libraries/Smarty/libs/sysplugins/ -> smarty_internal_data.php (summary)

Smarty Internal Plugin Data This file contains the basic classes and methodes for template and variable creation

Author: Uwe Tews
File Size: 551 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 4 classes

Smarty_Internal_Data:: (14 methods):
  assign()
  assignGlobal()
  assignByRef()
  append()
  appendByRef()
  getTemplateVars()
  clearAssign()
  clearAllAssign()
  configLoad()
  getVariable()
  getConfigVariable()
  getStreamVariable()
  getConfigVars()
  clearConfig()

Smarty_Data:: (1 method):
  __construct()

Smarty_Variable:: (2 methods):
  __construct()
  __toString()

Undefined_Smarty_Variable:: (2 methods):
  __get()
  __toString()


Class: Smarty_Internal_Data  - X-Ref

Base class with template and variable methodes

assign($tpl_var, $value = null, $nocache = false)   X-Ref
assigns a Smarty variable

param: array|string $tpl_var the template variable name(s)
param: mixed        $value   the value to assign
param: boolean      $nocache if true any output of this variable will be not cached
param: boolean $scope the scope the variable will have  (local,parent or root)
return: Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

assignGlobal($varname, $value = null, $nocache = false)   X-Ref
assigns a global Smarty variable

param: string $varname the global variable name
param: mixed  $value   the value to assign
param: boolean $nocache if true any output of this variable will be not cached
return: Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

assignByRef($tpl_var, &$value, $nocache = false)   X-Ref
assigns values to template variables by reference

param: string $tpl_var the template variable name
param: mixed $ &$value the referenced value to assign
param: boolean $nocache if true any output of this variable will be not cached
return: Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

append($tpl_var, $value = null, $merge = false, $nocache = false)   X-Ref
appends values to template variables

param: array|string $tpl_var the template variable name(s)
param: mixed        $value   the value to append
param: boolean      $merge   flag if array elements shall be merged
param: boolean $nocache if true any output of this variable will be not cached
return: Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

appendByRef($tpl_var, &$value, $merge = false)   X-Ref
appends values to template variables by reference

param: string $tpl_var the template variable name
param: mixed  &$value  the referenced value to append
param: boolean $merge  flag if array elements shall be merged
return: Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

getTemplateVars($varname = null, $_ptr = null, $search_parents = true)   X-Ref
Returns a single or all template variables

param: string  $varname        variable name or null
param: string  $_ptr           optional pointer to data object
param: boolean $search_parents include parent templates?
return: string variable value or or array of variables

clearAssign($tpl_var)   X-Ref
clear the given assigned template variable.

param: string|array $tpl_var the template variable(s) to clear
return: Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

clearAllAssign()   X-Ref
clear all the assigned template variables.

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

configLoad($config_file, $sections = null)   X-Ref
load a config file, optionally load just selected sections

param: string $config_file filename
param: mixed  $sections    array of section names, single section or null
return: Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

getVariable($variable, $_ptr = null, $search_parents = true, $error_enable = true)   X-Ref
gets the object of a Smarty variable

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

getConfigVariable($variable, $error_enable = true)   X-Ref
gets  a config variable

param: string $variable the name of the config variable
return: mixed the value of the config variable

getStreamVariable($variable)   X-Ref
gets  a stream variable

param: string $variable the stream of the variable
return: mixed the value of the stream variable

getConfigVars($varname = null, $search_parents = true)   X-Ref
Returns a single or all config variables

param: string $varname variable name or null
return: string variable value or or array of variables

clearConfig($varname = null)   X-Ref
Deassigns a single or all config variables

param: string $varname variable name or null
return: Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Class: Smarty_Data  - X-Ref

class for the Smarty data object

The Smarty data object will hold Smarty variables in the current scope

__construct($_parent = null, $smarty = null)   X-Ref
create Smarty data object

param: Smarty|array $_parent  parent template
param: Smarty       $smarty   global smarty instance

Class: Smarty_Variable  - X-Ref

class for the Smarty variable object

This class defines the Smarty variable object

__construct($value = null, $nocache = false, $scope = Smarty::SCOPE_LOCAL)   X-Ref
create Smarty variable object

param: mixed   $value   the value to assign
param: boolean $nocache if true any output of this variable will be not cached
param: int     $scope   the scope the variable will have  (local,parent or root)

__toString()   X-Ref
<<magic>> String conversion

return: string

Class: Undefined_Smarty_Variable  - X-Ref

class for undefined variable object

This class defines an object for undefined variable handling

__get($name)   X-Ref
Returns FALSE for 'nocache' and NULL otherwise.

param: string $name
return: bool

__toString()   X-Ref
Always returns an empty string.

return: string



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1