Spec-Zone.ru › Symfony 3.0

FormRendererEngineInterface

interface FormRendererEngineInterface

Адаптер для отрисовки шаблонов форм с помощью определенного движка шаблонов.

Методы

setTheme(FormView $view, mixed $themes)

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

mixed getResourceForBlockName(FormView $view, string $blockName)

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

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

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

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

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

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

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

Подробности

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, если ресурс не был найден.

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.0/Symfony/Component/Form/FormRendererEngineInterface.html

Spec-Zone.ru

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