Spec-Zone.ru › Symfony 3.0

AbstractRendererEngine

class AbstractRendererEngine implements FormRendererEngineInterface

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

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

CACHE_KEY_VAR

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

Методы

__construct(array $defaultThemes = array())

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

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

Spec-Zone.ru

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