Esi
class Esi implements SurrogateInterface
Esi реализует возможности ESI для экземпляров Request и Response.
Для получения дополнительной информации ознакомьтесь со следующими заметками W3C:
Спецификация языка ESI 1.0 (http://www.w3.org/TR/esi-lang)
Спецификация архитектуры Edge (http://www.w3.org/TR/edge-arch)
Методы
| __construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml')) Конструктор. | ||
| string | getName() Возвращает имя суррогата. | |
| ResponseCacheStrategyInterface | createCacheStrategy() Возвращает новый экземпляр стратегии кэширования. | |
| bool | hasSurrogateCapability(Request $request) Проверяет, что хотя бы один суррогат обладает возможностью ESI/1.0. | |
| addSurrogateCapability(Request $request) Добавляет возможность ESI/1.0 к данному объекту Request. | ||
| addSurrogateControl(Response $response) Добавляет HTTP-заголовки, указывающие на то, что Response необходимо проанализировать на наличие ESI. | ||
| bool | needsParsing(Response $response) Проверяет, нужно ли анализировать Response на наличие тегов ESI. | |
| string | renderIncludeTag(string $uri, string $alt = null, bool $ignoreErrors = true, string $comment = '') Рендерит тег ESI. | |
| Response | process(Request $request, Response $response) Заменяет теги ESI в Response содержимым включённого ресурса. | |
| string | handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors) Обрабатывает ESI из кэша. |
Подробности
__construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))
Конструктор.
Параметры
| array | $contentTypes | Массив типов содержимого, которые следует анализировать на наличие информации ESI. (по умолчанию: text/html, text/xml, application/xhtml+xml и application/xml) |
string getName()
Возвращает имя суррогата.
Значение возврата
| string |
ResponseCacheStrategyInterface createCacheStrategy()
Возвращает новый экземпляр стратегии кэширования.
Значение возврата
| ResponseCacheStrategyInterface | Экземпляр ResponseCacheStrategyInterface |
bool hasSurrogateCapability(Request $request)
Проверяет, что хотя бы один суррогат обладает возможностью ESI/1.0.
Параметры
| Request | $request | Экземпляр Request |
Значение возврата
| bool | true, если один суррогат обладает возможностью суррогирования, иначе false |
addSurrogateCapability(Request $request)
Добавляет возможность ESI/1.0 к данному объекту Request.
Параметры
| Request | $request | Экземпляр Request |
addSurrogateControl(Response $response)
Добавляет HTTP-заголовки, указывающие на то, что Response необходимо проанализировать на наличие ESI.
Этот метод добавляет заголовок ESI в Response только в том случае, если в нём есть теги ESI.
Параметры
| Response | $response | Экземпляр Response |
bool needsParsing(Response $response)
Проверяет, нужно ли анализировать Response на наличие тегов ESI.
Параметры
| Response | $response | Экземпляр Response |
Значение возврата
| bool | true, если Response нужно проанализировать, иначе false |
string renderIncludeTag(string $uri, string $alt = null, bool $ignoreErrors = true, string $comment = '')
Рендерит тег ESI.
Параметры
| string | $uri | URI |
| string | $alt | Альтернативный URI |
| bool | $ignoreErrors | Игнорировать ошибки или нет |
| string | $comment | Комментарий, который нужно добавить в тег esi:include |
Значение возврата
| string |
Response process(Request $request, Response $response)
Заменяет теги ESI в Response содержимым включённого ресурса.
Параметры
| Request | $request | Экземпляр Request |
| Response | $response | Экземпляр Response |
Значение возврата
| Response |
string handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors)
Обрабатывает ESI из кэша.
Параметры
| HttpCache | $cache | Экземпляр HttpCache |
| string | $uri | Основной URI |
| string | $alt | Альтернативный URI |
| bool | $ignoreErrors | Игнорировать ошибки или нет |
Значение возврата
| string |
Исключения
| RuntimeException | |
| Exception |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpKernel/HttpCache/Esi.html
