Spec-Zone.ru › Symfony 4.0

TwigRendererEngineInterface deprecated

interface TwigRendererEngineInterface implements FormRendererEngineInterface

deprecated

since version 3.2, to be removed in 4.0.

Методы

setTheme(FormView $view, mixed $themes)

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

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

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

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

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

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

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

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

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

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

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(Environment $environment)

Параметры

Environment $environment

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

Spec-Zone.ru

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