PhpEngine
class PhpEngine extends PhpEngine implements EngineInterface
Этот движок знает, как отображать шаблоны Symfony.
Методы
| __construct(TemplateNameParserInterface $parser, ContainerInterface $container, LoaderInterface $loader, GlobalVariables $globals = null) | ||
| string | render(string|TemplateReferenceInterface $name, array $parameters = array()) Отображает шаблон. | из PhpEngine |
| bool | exists(string|TemplateReferenceInterface $name) Возвращает true, если шаблон существует. | из PhpEngine |
| bool | supports(string|TemplateReferenceInterface $name) Возвращает true, если этот класс может отобразить заданный шаблон. | из PhpEngine |
| HelperInterface | offsetGet(string $name) Получает значение помощника. | из PhpEngine |
| bool | offsetExists(string $name) Возвращает true, если помощник определён. | из PhpEngine |
| offsetSet(HelperInterface $name, string $value) Устанавливает помощника. | из PhpEngine | |
| offsetUnset(string $name) Удаляет помощника. | из PhpEngine | |
| addHelpers(array $helpers) Добавляет помощников. | из PhpEngine | |
| setHelpers(array $helpers) Устанавливает помощников. | ||
| set(HelperInterface $helper, string $alias = null) Устанавливает помощника. | из PhpEngine | |
| bool | has(string $name) Возвращает true, если помощник определён. | из PhpEngine |
| HelperInterface | get(string $name) Получает значение помощника. | |
| extend(string $template) Декорирует текущий шаблон другим. | из PhpEngine | |
| string | escape(mixed $value, string $context = 'html') Экранирует строку, используя текущую кодировку. | из PhpEngine |
| setCharset(string $charset) Устанавливает кодировку. | из PhpEngine | |
| string | getCharset() Получает текущую кодировку. | из PhpEngine |
| setEscaper(string $context, callable $escaper) Добавляет экранировщик для заданного контекста. | из PhpEngine | |
| callable | getEscaper(string $context) Получает экранировщик для заданного контекста. | из PhpEngine |
| addGlobal(string $name, mixed $value) | из PhpEngine | |
| array | getGlobals() Возвращает назначенные глобальные переменные. | из PhpEngine |
| LoaderInterface | getLoader() Получает лоадер, связанный с этим движком. | из PhpEngine |
| Response | renderResponse(string $view, array $parameters = array(), Response $response = null) Отображает представление и возвращает объект Response. |
Подробности
__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 |
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 |
LoaderInterface getLoader()
Получает загрузчик, связанный с этим движком.
Значение возврата
| LoaderInterface | Экземпляр LoaderInterface |
Response renderResponse(string $view, array $parameters = array(), Response $response = null)
Отображает представление и возвращает Response.
Параметры
| string | $view | Имя представления |
| array | $parameters | Массив параметров для передачи представлению |
| Response | $response | Экземпляр Response |
Значение возврата
| Response | Экземпляр Response |
Исключения
| RuntimeException | если шаблон не может быть отображён |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Bundle/FrameworkBundle/Templating/PhpEngine.html
