PhpEngine

__construct(TemplateNameParserInterface $parser, ContainerInterface $container, LoaderInterface $loader, GlobalVariables $globals = null)

Параметры

TemplateNameParserInterface	$parser	Экземпляр TemplateNameParserInterface
ContainerInterface	$container
LoaderInterface	$loader	Экземпляр загрузчика
GlobalVariables	$globals

string render(string|TemplateReferenceInterface $name, array $parameters = array())

Отображает шаблон.

Параметры

string|TemplateReferenceInterface	$name	Имя шаблона или экземпляр TemplateReferenceInterface
array	$parameters	Массив параметров для передачи шаблону

Возвращаемое значение

string

Отображенный шаблон в виде строки

Исключения

RuntimeException

если шаблон не может быть отображен

bool exists(string|TemplateReferenceInterface $name)

Возвращает true, если шаблон существует.

Параметры

string|TemplateReferenceInterface

$name

Имя шаблона или экземпляр TemplateReferenceInterface

Возвращаемое значение

bool	true, если шаблон существует, в противном случае false

Исключения

RuntimeException

если движок не может обработать имя шаблона

bool supports(string|TemplateReferenceInterface $name)

Возвращает true, если этот класс может отобразить данный шаблон.

Параметры

string|TemplateReferenceInterface

$name

Имя шаблона или экземпляр TemplateReferenceInterface

Возвращаемое значение

bool	true, если этот класс поддерживает данный шаблон, в противном случае false

protected string|false evaluate(Storage $template, array $parameters = array())

Оценивает шаблон.

Параметры

Storage	$template	Шаблон для отображения
array	$parameters	Массив параметров для передачи шаблону

Возвращаемое значение

string|false

Оцененный шаблон или false, если движок не может отобразить шаблон

Исключения

InvalidArgumentException

HelperInterface offsetGet(string $name)

Получает значение помощника.

Параметры

string

$name

Имя помощника

Возвращаемое значение

HelperInterface

Значение помощника

Исключения

InvalidArgumentException

если помощник не определен

bool offsetExists(string $name)

Возвращает true, если помощник определен.

Параметры

string

$name

Имя помощника

Возвращаемое значение

bool	true, если помощник определен, в противном случае false

offsetSet(HelperInterface $name, string $value)

Устанавливает помощника.

Параметры

HelperInterface	$name	Экземпляр помощника
string	$value	Псевдоним

offsetUnset(string $name)

Удаляет помощника.

Параметры

string

$name

Имя помощника

Исключения

LogicException

addHelpers(array $helpers)

Добавляет помощников.

Параметры

array

$helpers

Массив помощников

setHelpers(array $helpers)

Устанавливает помощников.

Параметры

array

$helpers

Массив помощников

set(HelperInterface $helper, string $alias = null)

Устанавливает помощника.

Параметры

HelperInterface	$helper	Экземпляр помощника
string	$alias	Псевдоним

bool has(string $name)

Возвращает true, если помощник определен.

Параметры

string

$name

Имя помощника

Возвращаемое значение

bool	true, если помощник определен, в противном случае false

HelperInterface get(string $name)

Получает значение помощника.

Параметры

string

$name

Имя помощника

Возвращаемое значение

HelperInterface

Экземпляр помощника

Исключения

InvalidArgumentException

если помощник не определен

extend(string $template)

Декорирует текущий шаблон другим.

Параметры

string

$template

Логическое имя декоратора

string escape(mixed $value, string $context = 'html')

Экранирует строку, используя текущий набор символов.

Параметры

mixed	$value	Переменная для экранирования
string	$context	Имя контекста

Возвращаемое значение

string

Экранированное значение

setCharset(string $charset)

Устанавливает кодировку.

Параметры

string

$charset

Кодировка

string getCharset()

Получает текущую кодировку.

Возвращаемое значение

string

Текущая кодировка

setEscaper(string $context, callable $escaper)

Добавляет экранировщик для данного контекста.

Параметры

string	$context	Контекст экранировщика (html, js, ...)
callable	$escaper	PHP вызываемый объект

callable getEscaper(string $context)

Получает экранировщик для данного контекста.

Параметры

string

$context

Имя контекста

Значение возвращаемого значения

callable

$escaper PHP вызываемый объект

Исключения

InvalidArgumentException

addGlobal(string $name, mixed $value)

Параметры

string	$name
mixed	$value

array getGlobals()

Возвращает назначенные глобальные переменные.

Значение возвращаемого значения

array

protected initializeEscapers()

Инициализирует встроенные средства экранирования.

Каждая функция определяет способ применения преобразования к строке, переданной ей. Цель заключается в том, чтобы строка была «экранирована» так, чтобы она подходила для формата, в котором она отображается.

Например, строка: «Необходимо ввести имя пользователя и пароль.\n» Если это отображать как HTML, целесообразно преобразовать амперсанд в '&' и апостроф в '&aps;'. Однако если она будет использоваться как строка в JavaScript для отображения в окне alert, правильнее оставить строку как есть, но выполнить c-экранирование апострофа и новой строки.

Для каждой функции есть определение, чтобы избежать проблем с неправильно указанными строками.

LoaderInterface getLoader()

Получает загрузчик, связанный с этим движком.

Значение возвращаемого значения

LoaderInterface

Экземпляр LoaderInterface

protected Storage load(string|TemplateReferenceInterface $name)

Загружает указанный шаблон.

Параметры

string|TemplateReferenceInterface

$name

Имя шаблона или экземпляр TemplateReferenceInterface

Значение возвращаемого значения

Storage

Экземпляр Storage

Исключения

InvalidArgumentException

если шаблон не найден

Response renderResponse(string $view, array $parameters = array(), Response $response = null)

Отображает представление и возвращает Response.

Параметры

string	$view	Имя представления
array	$parameters	Массив параметров для передачи представлению
Response	$response	Экземпляр Response

Значение возвращаемого значения

Response

Экземпляр Response

Исключения

RuntimeException

если шаблон не может быть отображен