PHP Класс Box\Brainy\Templates\Template

Наследование: extends TemplateBase
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$compile_id string $compile_id
$compiled
$properties array special compiled template properties
$required_plugins array required plugins
$source
$template_resource string Full template resource

Открытые методы

Метод Описание
__construct ( string $tplResource, Box\Brainy\Brainy $brainy, Template $parent = null, mixed $compileID = null, boolean | void $suppressData = false ) Create template data object
compileTemplateSource ( ) : string Compiles the template
createTemplateCodeFrame ( string $content = '' ) : string Create code frame for compiled and cached templates
decodeProperties ( array $properties ) : boolean This function is executed automatically when a compiled or cached template file is included
getScopePointer ( integer $scope ) : mixed Get parent or root of template parent chain
mustCompile ( ) : boolean Returns if the current template must be compiled by the Smarty compiler
recompileAndLoadCopy ( ) : void Recompiles the template and also writes a copy of the compiled code to a temporary destination to load from. This is so that stale compiled code will be refreshed in HHVM, which does not support requiring the same file twice even if it has been changed.
writeFile ( string $_filepath, string $_contents, Box\Brainy\Brainy $smarty ) : boolean Writes file in a safe way to disk

Описание методов

__construct() публичный Метод

Some of the global Smarty settings copied to template scope It load the required template resources and cacher plugins
public __construct ( string $tplResource, Box\Brainy\Brainy $brainy, Template $parent = null, mixed $compileID = null, boolean | void $suppressData = false )
$tplResource string template resource string
$brainy Box\Brainy\Brainy Brainy instance
$parent Template back pointer to parent object with variables or null
$compileID mixed compile id or null
$suppressData boolean | void Prevents data from being copied into the variable scope

compileTemplateSource() публичный Метод

Compiles the template
public compileTemplateSource ( ) : string
Результат string The compiled template source

createTemplateCodeFrame() публичный Метод

Create code frame for compiled and cached templates
public createTemplateCodeFrame ( string $content = '' ) : string
$content string optional template content
Результат string

decodeProperties() публичный Метод

This function is executed automatically when a compiled or cached template file is included
public decodeProperties ( array $properties ) : boolean
$properties array special template properties
Результат boolean flag if compiled or cache file is valid

getScopePointer() публичный Метод

Get parent or root of template parent chain
public getScopePointer ( integer $scope ) : mixed
$scope integer pqrent or root scope
Результат mixed object

mustCompile() публичный Метод

It does compare the timestamps of template source and the compiled templates
public mustCompile ( ) : boolean
Результат boolean true if the template must be compiled

recompileAndLoadCopy() публичный Метод

Recompiles the template and also writes a copy of the compiled code to a temporary destination to load from. This is so that stale compiled code will be refreshed in HHVM, which does not support requiring the same file twice even if it has been changed.
public recompileAndLoadCopy ( ) : void
Результат void

writeFile() публичный статический Метод

Writes file in a safe way to disk
public static writeFile ( string $_filepath, string $_contents, Box\Brainy\Brainy $smarty ) : boolean
$_filepath string complete filepath
$_contents string file content
$smarty Box\Brainy\Brainy smarty instance
Результат boolean true

Описание свойств

$compile_id публичное свойство

$compile_id
public string $compile_id
Результат string

$compiled публичное свойство

public $compiled

$properties публичное свойство

special compiled template properties
public array $properties
Результат array

$required_plugins публичное свойство

required plugins
public array $required_plugins
Результат array

$source публичное свойство

public $source

$template_resource публичное свойство

Full template resource
public string $template_resource
Результат string