API Documentation
\
Box
Brainy
Compiler
Constructs
Helpers
Wrappers
Exceptions
Resources
Runtime
Templates

\Box\Brainy\TemplatesTemplateData

Summary

Methods
Properties
Constants
assign()
assignGlobal()
getTemplateVars()
clearAssign()
clearAllAssign()
getVariable()
cloneDataFrom()
applyDataFrom()
No public properties found
No constants found
assignSingleVar()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

assign()

assign(array|string  $var, mixed|null|void  $value = null, integer|void  $scope = -1) : \Box\Brainy\Templates\TemplateData

Assigns $value to the variable in $var. If an associative array is passed as the only parameter, it is a mapping of variables to assign to the values to assign to them.

Parameters

array|string $var

the template variable name(s)
mixed|null|void $value

the value to assign
integer|void $scope

the scope to associate with the Smarty_Variable instance

Returns

\Box\Brainy\Templates\TemplateData —

current TemplateData (or Smarty or Template) instance for chaining

assignGlobal()

assignGlobal(string  $varname, mixed  $value = null) : \Box\Brainy\Templates\TemplateData

Assigns a global Smarty variable to the global scope.

Parameters

string $varname

the global variable name
mixed $value

the value to assign

Returns

\Box\Brainy\Templates\TemplateData —

current TemplateData (or Smarty or Template) instance for chaining

getTemplateVars()

getTemplateVars(string  $varname = null, \Box\Brainy\Templates\TemplateData  $ptr = null, boolean  $search_parents = true) : string|array

Returns a single or all assigned template variables

Parameters

string $varname

Name of variable to process, or null to return all
\Box\Brainy\Templates\TemplateData $ptr

Optional reference to data object
boolean $search_parents

Whether to include results from parent scopes

Returns

string|array —

variable value or or array of variables

clearAssign()

clearAssign(string|array<mixed,string>  $varName) : \Box\Brainy\Templates\TemplateData

Clear the given assigned template variable.

Parameters

string|array<mixed,string> $varName

The template variable(s) to clear

Returns

\Box\Brainy\Templates\TemplateData —

current TemplateData (or Smarty or Template) instance for chaining

clearAllAssign()

clearAllAssign() : \Box\Brainy\Templates\TemplateData

Clear all the assigned template variables.

Returns

\Box\Brainy\Templates\TemplateData —

current TemplateData instance for chaining

getVariable()

getVariable(string  $variable, \Box\Brainy\Templates\TemplateData|null  $_ptr = null, boolean  $search_parents = true, boolean  $error_enable = true) : mixed

Return the contents of an assigned variable.

Parameters

string $variable

the name of the Smarty variable
\Box\Brainy\Templates\TemplateData|null $_ptr

Optional reference to the data object
boolean $search_parents

Whether to search in the parent scope
boolean $error_enable

Whether to raise an error when the variable is not found.

Returns

mixed —

The contents of the variable.

cloneDataFrom()

cloneDataFrom(\Box\Brainy\Templates\TemplateData  $source, boolean|void  $override = true) : void

Copies each variable from the source into this object, creating new `Variable` objects along the way.

Parameters

\Box\Brainy\Templates\TemplateData $source
boolean|void $override

Whether to override existing values

applyDataFrom()

applyDataFrom(array  $source, boolean|void  $override = true) : void

Applies all of the data to the current object

Parameters

array $source
boolean|void $override

Whether to override existing values

assignSingleVar()

assignSingleVar(string  $var, mixed  $value, integer  $scope = -1) : void

Assigns $value to the variale $var.

Parameters

string $var

the template variable name
mixed $value

the value to assign
integer $scope

the scope to associate with the Smarty_Variable