TemplatingRendererEngine

__construct(EngineInterface $engine, array $defaultThemes = array())

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

Параметры

EngineInterface	$engine
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, если ресурс не был найден

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 разметка