Двигатель рендеринга AbstractRendererEngine
класс AbstractRendererEngine реализует FormRendererEngineInterface
Реализация по умолчанию интерфейса {@link FormRendererEngineInterface}.
Константы
| CACHE_KEY_VAR | Переменная в {@link FormView}, используемая в качестве ключа кэша. |
Методы
| __construct(array $defaultThemes = array()) Создаёт новый движок рендеринга. | ||
| setTheme(FormView $view, mixed $themes, bool $useDefaultThemes = true) Устанавливает тему(ы) для рендеринга представления и его дочерних элементов. | ||
| mixed | getResourceForBlockName(FormView $view, string $blockName) Возвращает ресурс для имени блока. | |
| mixed | getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, int $hierarchyLevel) Возвращает ресурс для иерархии имён блоков. | |
| int|bool | getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, int $hierarchyLevel) Возвращает уровень иерархии, на котором можно найти ресурс. |
Подробности
__construct(array $defaultThemes = array())
Создаёт новый движок рендеринга.
Параметры
| array | $defaultThemes | Текущие темы. Тип этих тем открыт для реализации. |
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, если ресурс не был найден |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Form/AbstractRendererEngine.html