TemplatingRendererEngine
class TemplatingRendererEngine extends AbstractRendererEngine
Постоянные значения
| CACHE_KEY_VAR | Переменная в {@link FormView}, используемая в качестве ключа кеша. |
Методы
| __construct(EngineInterface $engine, array $defaultThemes = array()) Создает новый движок рендеринга. | ||
| 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 |
| string | renderBlock(FormView $view, mixed $resource, string $blockName, array $variables = array()) Рендерит блок в заданном ресурсе рендеринга. |
Подробное описание
__construct(EngineInterface $engine, array $defaultThemes = array())
Создает новый движок рендеринга.
Параметры
| EngineInterface | $engine | |
| array | $defaultThemes | Значения по умолчанию для тем. Тип этих тем может быть любым. |
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 для вышеупомянутой иерархии, движок сначала будет искать блок "urlwidget", а затем, если он не существует, блок "textwidget" и т. д.
Тип ресурса определяется реализацией. Ресурс позже передается в {@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, движок сначала будет искать ресурс для блока "urlwidget". Если такой ресурс существует, метод возвращает 2. В противном случае он пытается найти ресурс для блока "textwidget" (на уровне 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/3.3/Symfony/Component/Form/Extension/Templating/TemplatingRendererEngine.html