Spec-Zone.ru › Symfony 3.4

AbstractRendererEngine

class AbstractRendererEngine implements FormRendererEngineInterface

Стандартная реализация {@link FormRendererEngineInterface}.

Константы

CACHE_KEY_VAR

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

Методы

__construct(array $defaultThemes = array())

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

setTheme(FormView $view, $themes)

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

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, $themes)

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

Параметры

FormView $view
$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 для вышеуказанной иерархии, движок сначала ищет блок «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/3.4/Symfony/Component/Form/AbstractRendererEngine.html

Spec-Zone.ru

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