EngineInterface
interface EngineInterface
EngineInterface — это интерфейс, который должен реализовывать каждый движок.
Все методы полагаются на имя шаблона. Имя шаблона — это «логическое» имя шаблона, и как таковое оно не ссылается на путь в файловой системе (на самом деле, шаблон может храниться где угодно, например, в базе данных).
Методы должны принимать любое имя. Если имя не является экземпляром TemplateReferenceInterface, следует использовать TemplateNameParserInterface для преобразования имени в экземпляр TemplateReferenceInterface.
Каждый загрузчик шаблонов использует логическое имя шаблона для поиска шаблона.
Методы
| string | render(string|TemplateReferenceInterface $name, array $parameters = array()) Отображает шаблон. | |
| bool | exists(string|TemplateReferenceInterface $name) Возвращает true, если шаблон существует. | |
| bool | supports(string|TemplateReferenceInterface $name) Возвращает true, если данный класс может отобразить указанный шаблон. |
Подробности
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Templating/EngineInterface.html