TwigRendererEngine
class TwigRendererEngine extends AbstractRendererEngine implements TwigRendererEngineInterface
Постоянные значения
| CACHE_KEY_VAR | Переменная в {@link FormView}, используемая в качестве ключа кэша. |
Методы
| __construct(array $defaultThemes = array()) Создает новый движок рендеринга. | из AbstractRendererEngine | |
| setTheme(FormView $view, mixed $themes) Устанавливает тему(ы) для рендеринга представления и его дочерних элементов. | из 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 |
| setEnvironment(Twig_Environment $environment) Устанавливает среду Twig. | ||
| string | renderBlock(FormView $view, mixed $resource, string $blockName, array $variables = array()) Рендерит блок в заданном ресурсе рендеринга. |
Подробности
__construct(array $defaultThemes = array())
Создает новый движок рендеринга.
Параметры
| массив | $defaultThemes | Значения по умолчанию. Тип этих тем открыт для реализации. |
setTheme(FormView $view, mixed $themes)
Устанавливает тему(ы) для рендеринга представления и его дочерних элементов.
Параметры
| FormView | $view | Представление, которому необходимо назначить тему(ы) |
| смешанный | $themes | Тема(ы). Тип этих тем открыт для реализации. |
mixed getResourceForBlockName(FormView $view, string $blockName)
Возвращает ресурс для имени блока.
Ресурс сначала ищется в темах, прикрепленных к $view, затем в темах его родительского представления и так далее, пока не будет найден ресурс.
Тип ресурса определяется реализацией. Ресурс впоследствии передаётся {@link renderBlock()} алгоритмом рендеринга.
Параметры
| FormView | $view | Представление для определения используемых тем Сначала рассматриваются темы, прикрепленные непосредственно к представлению с помощью {@link setTheme()}, затем темы его родителя и т.д. |
| строка | $blockName | Имя блока для рендеринга |
Возвращаемое значение
| смешанный | Ресурс рендеринга или 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()}, затем темы его родителя и т.д. |
| массив | $blockNameHierarchy | Иерархия имён блоков, начиная с корневого блока. |
| целое число | $hierarchyLevel | Уровень в иерархии, с которого нужно начать поиск. Уровень 0 указывает на корневой блок, то есть первый элемент $blockNameHierarchy. |
Возвращаемое значение
| смешанный | Ресурс рендеринга или 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()}, затем темы его родителя и т.д. |
| массив | $blockNameHierarchy | Иерархия имён блоков, начиная с корневого блока. |
| целое число | $hierarchyLevel | Уровень в иерархии, с которого нужно начать поиск. Уровень 0 указывает на корневой блок, то есть первый элемент $blockNameHierarchy. |
Возвращаемое значение
| int|bool | Уровень иерархии или false, если ресурс не был найден |
setEnvironment(Twig_Environment $environment)
Устанавливает среду Twig.
Параметры
| Twig_Environment | $environment |
string renderBlock(FormView $view, mixed $resource, string $blockName, array $variables = array())
Рендерит блок в заданном ресурсе рендеринга.
Ресурс можно получить, вызвав {@link getResourceForBlock()} или {@link getResourceForBlockHierarchy()}. Тип ресурса определяется реализацией.
Параметры
| FormView | $view | Представление для рендеринга |
| смешанный | $resource | Ресурс рендеринга |
| строка | $blockName | Имя блока для рендеринга |
| массив | $variables | Переменные, передаваемые в шаблон |
Возвращаемое значение
| строка | HTML разметка |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Bridge/Twig/Form/TwigRendererEngine.html