Spec-Zone.ru › Symfony 3.4

TwigRendererEngineInterface deprecated

interface TwigRendererEngineInterface implements FormRendererEngineInterface

deprecated

since version 3.2, to be removed in 4.0.

Methods

setTheme(FormView $view, mixed $themes)

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

from FormRendererEngineInterface
mixed getResourceForBlockName(FormView $view, string $blockName)

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

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

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

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

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

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

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

from FormRendererEngineInterface
setEnvironment(Environment $environment)

Details

setTheme(FormView $view, mixed $themes)

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

Parameters

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

mixed getResourceForBlockName(FormView $view, string $blockName)

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

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

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

Parameters

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

Return Value

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()} алгоритмом рендеринга.

Parameters

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

Return Value

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()} алгоритмом рендеринга.

Parameters

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

Return Value

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

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

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

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

Parameters

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

Return Value

string HTML разметка

setEnvironment(Environment $environment)

Parameters

Environment $environment

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

Spec-Zone.ru

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