Class Smarty_Internal_Template

Main class with template data structures and methods

Smarty_Internal_Template

Package: Smarty\Template
Author: Uwe Tews
Located at tpl/smarty/sysplugins/smarty_internal_template.php

Methods summary

`public`	# `__construct( string $template_resource, Smarty $smarty, Smarty_Internal_Data $_parent = null, mixed $_cache_id = null, mixed $_compile_id = null, boolean $_caching = null, integer $_cache_lifetime = null )` Create template data object Some of the global Smarty settings copied to template scope It load the required template resources and caching plugins Create template data object Some of the global Smarty settings copied to template scope It load the required template resources and caching plugins Parameters `$template_resource` template resource string `$smarty` Smarty instance `$_parent` back pointer to parent object with variables or null `$_cache_id` cache id or null `$_compile_id` compile id or null `$_caching` use caching? `$_cache_lifetime` cache life-time in seconds Throws `SmartyException` Overrides `Smarty_Internal_Data::__construct`
`public string`	# `render( boolean $no_output_filter = true, null\|boolean $display = null )` render template render template Parameters `$no_output_filter` if true do not run output filter `$display` true: display, false: fetch null: sub-template Returns string Throws `SmartyException`
`public`	# `_subTemplateRender( string $template, mixed $cache_id, mixed $compile_id, integer $caching, integer $cache_lifetime, array $data, integer $scope, boolean $forceTplCache, string $uid = null, string $content_func = null )` Runtime function to render sub-template Runtime function to render sub-template Parameters `$template` template name `$cache_id` cache id `$compile_id` compile id `$caching` cache mode `$cache_lifetime` life time of cache data `$data` passed parameter template variables `$scope` scope in which {include} should execute `$forceTplCache` cache template object `$uid` file dependency uid `$content_func` function name
`public`	# `_subTemplateRegister( )` Get called sub-templates and save call count Get called sub-templates and save call count
`public boolean`	# `_isParentTemplate( )` Check if parent is template object Check if parent is template object Returns boolean true if parent is template
`public`	# `_assignInScope( string $varName, mixed $value, boolean $nocache = false, integer $scope = 0 )` Assign variable in scope Assign variable in scope Parameters `$varName` variable name `$value` value `$nocache` nocache flag `$scope` scope into which variable shall be assigned
`public boolean`	# `_decodeProperties( Smarty_Internal_Template $tpl, array $properties, boolean $cache = false )` This function is executed automatically when a compiled or cached template file is included - Decode saved properties from compiled template and cache files - Check if compiled or cache file is valid This function is executed automatically when a compiled or cached template file is included - Decode saved properties from compiled template and cache files - Check if compiled or cache file is valid Parameters `$tpl` `$properties` special template properties `$cache` flag if called from cache file Returns boolean flag if compiled or cache file is valid Throws `SmartyException`
`public`	# `compileTemplateSource( )` Compiles the template If the template is not evaluated the compiled template is saved on disk Compiles the template If the template is not evaluated the compiled template is saved on disk
`public boolean`	# `writeCachedContent( string $content )` Writes the content to cache resource Writes the content to cache resource Parameters `$content` Returns boolean
`public string`	# `_getTemplateId( )` Get unique template id Get unique template id Returns string
`public`	# `capture_error( )` runtime error not matching capture tags runtime error not matching capture tags
`public`	# `loadCompiled( boolean $force = false )` Load compiled object Load compiled object Parameters `$force` force new compiled object
`public`	# `loadCached( boolean $force = false )` Load cached object Load cached object Parameters `$force` force new cached object
`public`	# `_loadInheritance( )` Load inheritance object Load inheritance object
`public`	# `_cleanUp( )` Unload inheritance object Unload inheritance object
`public`	# `loadCompiler( )` Load compiler object Load compiler object Throws `SmartyException`
`public mixed`	# `__call( string $name, array $args )` Handle unknown class methods Handle unknown class methods Parameters `$name` unknown method-name `$args` argument array Returns mixed Throws `SmartyException` Overrides `Smarty_Internal_Data::__call`
`public`	# `__set( string $property_name, mixed $value )` set Smarty property in template context set Smarty property in template context Parameters `$property_name` property name `$value` value Throws `SmartyException`
`public mixed\|Smarty_Template_Cached`	# `__get( string $property_name )` get Smarty property in template context get Smarty property in template context Parameters `$property_name` property name Returns mixed\|`Smarty_Template_Cached` Throws `SmartyException`
`public`	# `__destruct( )` Template data object destructor Template data object destructor

Methods inherited from Smarty_Internal_TemplateBase

display(), fetch(), isCached(), loadFilter(), registerFilter(), registerObject(), registerPlugin(), setCacheId(), setCacheLifetime(), setCaching(), setCompileId()

Methods inherited from Smarty_Internal_Data

_mergeVars(), append(), appendByRef(), assign(), assignByRef(), assignGlobal(), getTemplateVars(), getVariable()

Magic methods summary

`public boolean`	# `mustCompile( )` Returns boolean

Magic methods inherited from Smarty_Internal_Data

clearAllAssign(), clearAssign(), clearConfig(), configLoad(), getConfigVars(), getGlobal(), getStreamVariable()

Properties summary

`public integer`	`$_objType` This object type (Smarty = 1, template = 2, data = 4) This object type (Smarty = 1, template = 2, data = 4)	# `2`
`public Smarty`	`$smarty` Global smarty instance Global smarty instance	# `null`
`public Smarty_Template_Source\|Smarty_Template_Config`	`$source` Source instance Source instance	# `null`
`public Smarty_Internal_Runtime_Inheritance`	`$inheritance` Inheritance runtime extension Inheritance runtime extension	# `null`
`public string`	`$template_resource` Template resource Template resource	# `null`
`public boolean`	`$mustCompile` flag if compiled template is invalid and must be (re)compiled flag if compiled template is invalid and must be (re)compiled	# `null`
`public null\|string`	`$templateId` Template Id Template Id	# `null`
`public integer`	`$scope` Scope in which variables shall be assigned Scope in which variables shall be assigned	# `0`
`public boolean`	`$isRenderingCache` Flag which is set while rending a cache file Flag which is set while rending a cache file	# `false`
`public callback[]`	`$startRenderCallbacks` Callbacks called before rendering template Callbacks called before rendering template	# `array()`
`public callback[]`	`$endRenderCallbacks` Callbacks called after rendering template Callbacks called after rendering template	# `array()`

Properties inherited from Smarty_Internal_TemplateBase

$_cache, $cache_id, $cache_lifetime, $caching, $compile_id

Properties inherited from Smarty_Internal_Data

$config_vars, $ext, $parent, $template_class, $tpl_vars

Magic properties

`public Smarty_Template_Compiled`	`$compiled`
`public Smarty_Template_Cached`	`$cached`
`public Smarty_Internal_TemplateCompilerBase`	`$compiler` The following methods will be dynamically loaded by the extension handler when they are called. They are located in a corresponding Smarty_Internal_Method_xxxx class

Magic properties inherited from Smarty_Internal_TemplateBase

$smarty

Magic properties inherited from Smarty_Internal_Data

$scope

Classes

Exceptions

Functions

Class Smarty_Internal_Template

Methods summary

Parameters

Throws

Overrides

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Parameters

Throws

Parameters

Returns

Throws

Overrides

Parameters

Throws

Parameters

Returns

Throws

Methods inherited from Smarty_Internal_TemplateBase

Methods inherited from Smarty_Internal_Data

Magic methods summary

Returns

Magic methods inherited from Smarty_Internal_TemplateBase

Magic methods inherited from Smarty_Internal_Data

Properties summary

Properties inherited from Smarty_Internal_TemplateBase

Properties inherited from Smarty_Internal_Data

Magic properties

Magic properties inherited from Smarty_Internal_TemplateBase

Magic properties inherited from Smarty_Internal_Data