PhpEngine
class PhpEngine implements EngineInterface, ArrayAccess
PhpEngine — движок, способный обрабатывать PHP-шаблоны.
Методы
| __construct(TemplateNameParserInterface $parser, LoaderInterface $loader, array $helpers = array()) | ||
| строка | render(строка|TemplateReferenceInterface $name, array $parameters = array()) Обрабатывает шаблон. | |
| bool | exists(строка|TemplateReferenceInterface $name) Возвращает true, если шаблон существует. | |
| bool | supports(строка|TemplateReferenceInterface $name) Возвращает true, если этот класс может обработать указанный шаблон. | |
| HelperInterface | offsetGet(строка $name) Получает значение помощника. | |
| bool | offsetExists(строка $name) Возвращает true, если помощник определен. | |
| offsetSet(HelperInterface $name, строка $value) Устанавливает помощника. | ||
| offsetUnset(строка $name) Удаляет помощника. | ||
| addHelpers(array $helpers) Добавляет несколько помощников. | ||
| setHelpers(array $helpers) Устанавливает помощников. | ||
| set(HelperInterface $helper, строка $alias = null) Устанавливает помощника. | ||
| bool | has(строка $name) Возвращает true, если помощник определен. | |
| HelperInterface | get(строка $name) Получает значение помощника. | |
| extend(строка $template) Декорирует текущий шаблон другим. | ||
| строка | escape(смешанный тип $value, строка $context = 'html') Экранирует строку, используя текущую кодировку. | |
| setCharset(строка $charset) Устанавливает кодировку. | ||
| строка | getCharset() Получает текущую кодировку. | |
| setEscaper(строка $context, вызываемая функция $escaper) Добавляет экранировщик для заданного контекста. | ||
| вызываемая функция | getEscaper(строка $context) Получает экранировщик для заданного контекста. | |
| addGlobal(строка $name, смешанный тип $value) | ||
| массив | getGlobals() Возвращает назначенные глобальные переменные. | |
| строка | convertEncoding(строка $string, строка $to, строка $from) устарело Преобразует строку из одной кодировки в другую. | |
| LoaderInterface | getLoader() Получает загрузчик, связанный с этим движком. |
Подробности
__construct(TemplateNameParserInterface $parser, LoaderInterface $loader, array $helpers = array())
Параметры
| TemplateNameParserInterface | $parser | Экземпляр TemplateNameParserInterface |
| LoaderInterface | $loader | Экземпляр загрузчика |
| array | $helpers | Массив экземпляров помощников |
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 |
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 |
string convertEncoding(string $string, string $to, string $from) deprecated
deprecated
Преобразует строку из одной кодировки в другую.
Параметры
| string | $string | Строка для преобразования |
| string | $to | Кодировка назначения |
| string | $from | Исходная кодировка |
Возвращаемое значение
| string | Строка с новой кодировкой |
LoaderInterface getLoader()
Получает загрузчик, связанный с этим движком.
Значение возврата
| LoaderInterface | Экземпляр LoaderInterface |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Templating/PhpEngine.html
