FragmentHandler
class FragmentHandler
Отображает URI, представляющий фрагмент ресурса.
Этот класс обрабатывает отображение фрагментов ресурсов, которые включены в основной ресурс. Обработка отображения выполняется специализированными рендерерами.
Этот слушатель работает в двух режимах:
- Совместимость с версией 2.3, где необходимо вызывать setRequest всякий раз, когда запрос изменяется.
- Режим 2.4+ где необходимо передать экземпляр RequestStack в конструктор.
Методы
| __construct(RequestStack $requestStack = null, FragmentRendererInterface[] $renderers = array(), bool $debug = false) RequestStack станет обязательным в версии 3.0. | ||
| addRenderer(FragmentRendererInterface $renderer) Добавляет рендерер. | ||
| setRequest(Request $request = null) устарело Устанавливает текущий запрос. | ||
| string|null | render(string|ControllerReference $uri, string $renderer = 'inline', array $options = array()) Отображает URI и возвращает содержимое ответа. |
Детали
__construct(RequestStack $requestStack = null, FragmentRendererInterface[] $renderers = array(), bool $debug = false)
RequestStack станет обязательным в версии 3.0.
Параметры
| RequestStack | $requestStack | Стек запросов, который управляет жизненным циклом запросов |
| FragmentRendererInterface[] | $renderers | Массив экземпляров FragmentRendererInterface |
| bool | $debug | Включен ли режим отладки |
addRenderer(FragmentRendererInterface $renderer)
Добавляет рендерер.
Параметры
| FragmentRendererInterface | $renderer |
setRequest(Request $request = null) устарело
устарело
Устанавливает текущий запрос.
Этот метод использовался для синхронизации запроса, но поскольку HttpKernel теперь делает это автоматически, его не следует вызывать напрямую. Он поддерживается как public для обратной совместимости с версией 2.3.
Параметры
| Request | $request | Экземпляр Request |
string|null render(string|ControllerReference $uri, string $renderer = 'inline', array $options = array())
Отображает URI и возвращает содержимое ответа.
Доступные опции:
- ignore_errors: true для возврата пустой строки в случае ошибки
Параметры
| string|ControllerReference | $uri | URI в виде строки или экземпляр ControllerReference |
| string | $renderer | Имя рендерера |
| array | $options | Массив опций |
Возвращаемое значение
| string|null | Содержимое ответа или null, когда ответ передается потоком |
Исключения
| InvalidArgumentException | когда рендерер не существует |
| LogicException | когда не обрабатывается главный запрос |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/HttpKernel/Fragment/FragmentHandler.html