Spec-Zone.ru › Symfony 3.2

TwigRendererEngine

class TwigRendererEngine extends AbstractRendererEngine implements TwigRendererEngineInterface

Постоянные значения

CACHE_KEY_VAR

Переменная в {@link FormView}, используемая в качестве ключа кеша.

Методы

__construct(array $defaultThemes = array(), Environment $environment = null)

Создаёт новый движок рендеринга.

setTheme(FormView $view, mixed $themes)

Устанавливает тему(ы) для рендеринга представления и его дочерних элементов.

из AbstractRendererEngine
mixed getResourceForBlockName(FormView $view, string $blockName)

Возвращает ресурс для имени блока.

из AbstractRendererEngine
mixed getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, int $hierarchyLevel)

Возвращает ресурс для иерархии блоков.

из AbstractRendererEngine
int|bool getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, int $hierarchyLevel)

Возвращает уровень иерархии, на котором можно найти ресурс.

из AbstractRendererEngine
setEnvironment(Environment $environment)
string renderBlock(FormView $view, mixed $resource, string $blockName, array $variables = array())

Рендерит блок в заданном ресурсе рендеринга.

Детали

__construct(array $defaultThemes = array(), Environment $environment = null)

Создаёт новый движок рендеринга.

Параметры

array $defaultThemes Значения по умолчанию для тем. Тип этих тем зависит от реализации.
Environment $environment

setTheme(FormView $view, mixed $themes)

Устанавливает тему(ы) для рендеринга представления и его дочерних элементов.

Параметры

FormView $view Представление, которому назначать тему(ы)
mixed $themes Тема(ы). Тип этих тем зависит от реализации.

mixed getResourceForBlockName(FormView $view, string $blockName)

Возвращает ресурс для имени блока.

Ресурс сначала ищется в темах, прикреплённых к $view, затем в темах его родительского представления и так далее, пока не будет найден ресурс.

Тип ресурса определяется реализацией. Ресурс позже передаётся в {@link renderBlock()} алгоритмом рендеринга.

Параметры

FormView $view Представление для определения используемых тем. Сначала рассматриваются темы, прикреплённые непосредственно к представлению с помощью {@link setTheme()}, затем темы его родителя и т.д.
string $blockName Имя блока для рендеринга

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

mixed Ресурс рендеринга или false, если он не найден

mixed getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, int $hierarchyLevel)

Возвращает ресурс для иерархии блоков.

Иерархия блоков — это массив, начинающийся с корня иерархии и продолжающийся с дочернего элемента этого корня, дочернего элемента этого дочернего элемента и т.д. Ниже приведён пример иерархии блоков:

formwidget textwidget url_widget

В этом примере "url_widget" — самый специфичный блок, в то время как другие блоки являются его предками в иерархии.

Второй параметр $hierarchyLevel определяет уровень иерархии, который должен быть рендерирован. Например, если $hierarchyLevel равен 2 для вышеупомянутой иерархии, движок сначала ищет блок "url_widget", а затем, если его нет, блок "text_widget" и т.д.

Тип ресурса определяется реализацией. Ресурс позже передаётся в {@link renderBlock()} алгоритмом рендеринга.

Параметры

FormView $view Представление для определения используемых тем. Сначала рассматриваются темы, прикреплённые непосредственно к представлению с помощью {@link setTheme()}, затем темы его родителя и т.д.
array $blockNameHierarchy Иерархия имён блоков, с начальным блоком в начале.
int $hierarchyLevel Уровень в иерархии, с которого следует начинать поиск. Уровень 0 указывает на корневой блок, т.е. первый элемент $blockNameHierarchy.

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

mixed Ресурс рендеринга или false, если он не найден

int|bool getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, int $hierarchyLevel)

Возвращает уровень иерархии, на котором можно найти ресурс.

Иерархия блоков — это массив, начинающийся с корня иерархии и продолжающийся с дочернего элемента этого корня, дочернего элемента этого дочернего элемента и т.д. Ниже приведён пример иерархии блоков:

formwidget textwidget url_widget

Второй параметр $hierarchyLevel определяет уровень иерархии, который должен быть рендерирован.

Если мы вызываем этот метод с уровнем иерархии 2, движок сначала ищет ресурс для блока "url_widget". Если такой ресурс существует, метод возвращает 2. В противном случае он пытается найти ресурс для блока "text_widget" (на уровне 1) и, опять же, возвращает 1, если ресурс был найден. Метод продолжает поиск ресурсов до тех пор, пока не будет достигнут корневой уровень и ничего не будет найдено. В этом случае возвращается false.

Тип ресурса определяется реализацией. Ресурс позже передаётся в {@link renderBlock()} алгоритмом рендеринга.

Параметры

FormView $view Представление для определения используемых тем. Сначала рассматриваются темы, прикреплённые непосредственно к представлению с помощью {@link setTheme()}, затем темы его родителя и т.д.
array $blockNameHierarchy Иерархия имён блоков, с начальным блоком в начале.
int $hierarchyLevel Уровень в иерархии, с которого следует начинать поиск. Уровень 0 указывает на корневой блок, т.е. первый элемент $blockNameHierarchy.

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

int|bool Уровень иерархии или false, если ресурс не был найден

setEnvironment(Environment $environment)

Параметры

Environment $environment

string renderBlock(FormView $view, mixed $resource, string $blockName, array $variables = array())

Рендерит блок в заданном ресурсе рендеринга.

Ресурс можно получить, вызвав {@link getResourceForBlock()} или {@link getResourceForBlockHierarchy()}. Тип ресурса определяется реализацией.

Параметры

FormView $view Представление для рендеринга
mixed $resource Ресурс рендеринга
string $blockName Имя блока для рендеринга
array $variables Переменные, передаваемые в шаблон

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

string HTML разметка

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Bridge/Twig/Form/TwigRendererEngine.html

Spec-Zone.ru

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