Spec-Zone.ru › Symfony 4.0

FormRendererEngineInterface

интерфейс FormRendererEngineInterface

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

Методы

setTheme(FormView $view, mixed $themes, bool $useDefaultThemes = true)

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

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, bool $useDefaultThemes = true)

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

Параметры

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

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

Spec-Zone.ru

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