Spec-Zone.ru › Symfony 3.0

TwigRendererEngineInterface

интерфейс TwigRendererEngineInterface реализует FormRendererEngineInterface

Методы

setTheme(FormView $view, mixed $themes)

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

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

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

из FormRendererEngineInterface
mixed getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, integer $hierarchyLevel)

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

из FormRendererEngineInterface
integer|Boolean getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, integer $hierarchyLevel)

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

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

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

из FormRendererEngineInterface
setEnvironment(Twig_Environment $environment)

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

Детали

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, integer $hierarchyLevel)

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

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

formwidget textwidget url_widget

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

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

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

Параметры

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

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

mixed Ресурс рендерера или false, если не был найден.

integer|Boolean getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, integer $hierarchyLevel)

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

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

formwidget textwidget url_widget

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

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

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

Параметры

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

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

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

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 разметка.

setEnvironment(Twig_Environment $environment)

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

Параметры

Twig_Environment $environment

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

Spec-Zone.ru

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