Spec-Zone.ru › Symfony 3.0

PhpEngine

class PhpEngine implements EngineInterface, ArrayAccess

PhpEngine — это движок, способный обрабатывать PHP-шаблоны.

Методы

__construct(TemplateNameParserInterface $parser, LoaderInterface $loader, array $helpers = array())

Конструктор.

string render(string|TemplateReferenceInterface $name, array $parameters = array())

Отображает шаблон.

bool exists(string|TemplateReferenceInterface $name)

Возвращает true, если шаблон существует.

bool supports(string|TemplateReferenceInterface $name)

Возвращает true, если этот класс может отобразить заданный шаблон.

HelperInterface offsetGet(string $name)

Получает значение помощника.

bool offsetExists(string $name)

Возвращает true, если помощник определён.

offsetSet(HelperInterface $name, string $value)

Устанавливает помощника.

offsetUnset(string $name)

Удаляет помощника.

addHelpers(array $helpers)

Добавляет помощников.

setHelpers(array $helpers)

Устанавливает помощников.

set(HelperInterface $helper, string $alias = null)

Устанавливает помощника.

bool has(string $name)

Возвращает true, если помощник определён.

HelperInterface get(string $name)

Получает значение помощника.

extend(string $template)

Декорирует текущий шаблон другим.

string escape(mixed $value, string $context = 'html')

Экранирует строку, используя текущую кодировку.

setCharset(string $charset)

Устанавливает кодировку.

string getCharset()

Получает текущую кодировку.

setEscaper(string $context, callable $escaper)

Добавляет экранировщик для заданного контекста.

callable getEscaper(string $context)

Получает экранировщик для заданного контекста.

addGlobal(string $name, mixed $value)
array getGlobals()

Возвращает назначенные глобальные переменные.

LoaderInterface getLoader()

Получает загрузчик, связанный с этим движком.

Подробности

__construct(TemplateNameParserInterface $parser, LoaderInterface $loader, array $helpers = array())

Конструктор.

Параметры

TemplateNameParserInterface $parser Экземпляр TemplateNameParserInterface
LoaderInterface $loader Экземпляр загрузчика
array $helpers Массив экземпляров помощников

string render(string|TemplateReferenceInterface $name, array $parameters = array())

Отображает шаблон.

Параметры

string|TemplateReferenceInterface $name Имя шаблона или экземпляр TemplateReferenceInterface
array $parameters Массив параметров, передаваемых шаблону

Возвращаемое значение

string Отображенный шаблон в виде строки

Исключения

RuntimeException если шаблон не может быть отображен

bool exists(string|TemplateReferenceInterface $name)

Возвращает true, если шаблон существует.

Параметры

string|TemplateReferenceInterface $name Имя шаблона или экземпляр TemplateReferenceInterface

Возвращаемое значение

bool true, если шаблон существует, иначе false

Исключения

RuntimeException если движок не может обработать имя шаблона

bool supports(string|TemplateReferenceInterface $name)

Возвращает true, если этот класс может отобразить заданный шаблон.

Параметры

string|TemplateReferenceInterface $name Имя шаблона или экземпляр TemplateReferenceInterface

Возвращаемое значение

bool true, если этот класс поддерживает данный шаблон, иначе false

HelperInterface offsetGet(string $name)

Получает значение помощника.

Параметры

string $name Имя помощника

Возвращаемое значение

HelperInterface Значение помощника

Исключения

InvalidArgumentException если помощник не определен

bool offsetExists(string $name)

Возвращает true, если помощник определен.

Параметры

string $name Имя помощника

Возвращаемое значение

bool true, если помощник определен, иначе false

offsetSet(HelperInterface $name, string $value)

Устанавливает помощника.

Параметры

HelperInterface $name Экземпляр помощника
string $value Псевдоним

offsetUnset(string $name)

Удаляет помощника.

Параметры

string $name Имя помощника

Исключения

LogicException

addHelpers(array $helpers)

Добавляет помощников.

Параметры

array $helpers Массив помощников

setHelpers(array $helpers)

Устанавливает помощников.

Параметры

array $helpers Массив помощников

set(HelperInterface $helper, string $alias = null)

Устанавливает помощника.

Параметры

HelperInterface $helper Экземпляр помощника
string $alias Псевдоним

bool has(string $name)

Возвращает true, если помощник определен.

Параметры

string $name Имя помощника

Возвращаемое значение

bool true, если помощник определен, иначе false

HelperInterface get(string $name)

Получает значение помощника.

Параметры

string $name Имя помощника

Возвращаемое значение

HelperInterface Экземпляр помощника

Исключения

InvalidArgumentException если помощник не определен

extend(string $template)

Декорирует текущий шаблон другим шаблоном.

Параметры

string $template Логическое имя декоратора

string escape(mixed $value, string $context = 'html')

Экранирует строку, используя текущий кодировку.

Параметры

mixed $value Переменная для экранирования
string $context Название контекста

Возвращаемое значение

string Экранированное значение

setCharset(string $charset)

Устанавливает кодировку.

Параметры

string $charset Кодировка

string getCharset()

Получает текущую кодировку.

Возвращаемое значение

string Текущая кодировка

setEscaper(string $context, callable $escaper)

Добавляет экранировщик для данного контекста.

Параметры

string $context Контекст экранировщика (html, js, ...)
callable $escaper PHP вызываемый объект

callable getEscaper(string $context)

Получает экранировщик для данного контекста.

Параметры

string $context Название контекста

Возвращаемое значение

callable $escaper PHP вызываемый объект

Исключения

InvalidArgumentException

addGlobal(string $name, mixed $value)

Параметры

string $name
mixed $value

array getGlobals()

Возвращает назначенные глобальные переменные.

Возвращаемое значение

array

LoaderInterface getLoader()

Получает загрузчик, связанный с этим движком.

Возвращаемое значение

LoaderInterface Экземпляр LoaderInterface

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Templating/PhpEngine.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API