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