Spec-Zone.ru › Symfony 4.0

TwigRendererEngine

class TwigRendererEngine extends AbstractRendererEngine

Постоянные значения

CACHE_KEY_VAR

Переменная в {@link FormView}, используемая в качестве ключа кэша.

Методы

__construct(array $defaultThemes, Environment $environment)

Создает новый движок рендеринга.

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

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

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

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

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

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

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

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

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

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

Подробности

__construct(array $defaultThemes, Environment $environment)

Создает новый движок рендеринга.

Параметры

array $defaultThemes Значения по умолчанию для тем. Тип этих тем зависит от реализации.
Environment $environment

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/Bridge/Twig/Form/TwigRendererEngine.html

Spec-Zone.ru

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