CONTENIDO_4.9.0 beta1 » \Smarty

Methods

class for the Smarty data object

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

package	Smarty
subpackage	Template

Methods

create Smarty data object

__construct(\Smarty | array $_parent, \Smarty $smarty)

Parameters

$_parent

\Smartyarray

parent template

$smarty

\Smarty

global smarty instance

appends values to template variables

append(array | string $tpl_var, mixed $value, boolean $merge, boolean $nocache) : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::append()

Parameters

$tpl_var

arraystring

the template variable name(s)

$value

mixed

the value to append

$merge

boolean

flag if array elements shall be merged

$nocache

boolean

if true any output of this variable will be not cached

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

appends values to template variables by reference

appendByRef(string $tpl_var, mixed $value, boolean $merge) : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::appendByRef()

Parameters

$tpl_var

string

the template variable name

$value

mixed

&$value the referenced value to append

$merge

boolean

flag if array elements shall be merged

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

assigns a Smarty variable

assign(array | string $tpl_var, mixed $value, boolean $nocache) : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::assign()

Parameters

$tpl_var

arraystring

the template variable name(s)

$value

mixed

the value to assign

$nocache

boolean

if true any output of this variable will be not cached

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

assigns values to template variables by reference

assignByRef(string $tpl_var, $value, boolean $nocache) : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::assignByRef()

Parameters

$tpl_var

string

the template variable name

$value

$nocache

boolean

if true any output of this variable will be not cached

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

assigns a global Smarty variable

assignGlobal(string $varname, mixed $value, boolean $nocache) : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::assignGlobal()

Parameters

$varname

string

the global variable name

$value

mixed

the value to assign

$nocache

boolean

if true any output of this variable will be not cached

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

clear all the assigned template variables.

clearAllAssign() : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::clearAllAssign()

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

clear the given assigned template variable.

clearAssign(string | array $tpl_var) : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::clearAssign()

Parameters

$tpl_var

stringarray

the template variable(s) to clear

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

Deassigns a single or all config variables

clearConfig(string $varname) : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::clearConfig()

Parameters

$varname

string

variable name or null

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

load a config file, optionally load just selected sections

configLoad(string $config_file, mixed $sections) : \Smarty_Internal_Data

Inherited

inherited_from	\Smarty_Internal_Data::configLoad()

Parameters

$config_file

string

filename

$sections

mixed

array of section names, single section or null

Returns

\Smarty_Internal_Datacurrent Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for chaining

gets a config variable

getConfigVariable(string $variable, $error_enable) : mixed

Inherited

inherited_from	\Smarty_Internal_Data::getConfigVariable()

Parameters

$variable

string

the name of the config variable

$error_enable

Returns

mixedthe value of the config variable

Returns a single or all config variables

getConfigVars(string $varname, $search_parents) : string

Inherited

inherited_from	\Smarty_Internal_Data::getConfigVars()

Parameters

$varname

string

variable name or null

$search_parents

Returns

stringvariable value or or array of variables

gets a stream variable

getStreamVariable(string $variable) : mixed

Inherited

inherited_from	\Smarty_Internal_Data::getStreamVariable()

Parameters

$variable

string

the stream of the variable

Returns

mixedthe value of the stream variable

Returns a single or all template variables

getTemplateVars(string $varname, string $_ptr, boolean $search_parents) : string

Inherited

inherited_from	\Smarty_Internal_Data::getTemplateVars()

Parameters

$varname

string

variable name or null

$_ptr

string

optional pointer to data object

$search_parents

boolean

include parent templates?

Returns

stringvariable value or or array of variables

gets the object of a Smarty variable

getVariable(string $variable, object $_ptr, boolean $search_parents, $error_enable) : object

Inherited

inherited_from	\Smarty_Internal_Data::getVariable()

Parameters

$variable

string

the name of the Smarty variable

$_ptr

object

optional pointer to data object

$search_parents

boolean

search also in parent data

$error_enable

Returns

objectthe object of the variable

Properties

$config_vars : array

Inherited

inherited_from	\Smarty_Internal_Data::$$config_vars

$parent : \Smarty_Internal_Template

Inherited

inherited_from	\Smarty_Internal_Data::$$parent

$smarty : \Smarty

$template_class : string

Inherited

inherited_from	\Smarty_Internal_Data::$$template_class

$tpl_vars : array

Inherited

inherited_from	\Smarty_Internal_Data::$$tpl_vars