Spec-Zone.ru › Symfony 2.8

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.

bool hasSurrogateEsiCapability(Request $request) deprecated

Проверяет, имеет ли хотя бы один суррогат возможность ESI/1.0.

addSurrogateCapability(Request $request)

Добавляет возможность ESI/1.0 к данному запросу.

addSurrogateEsiCapability(Request $request) deprecated

Добавляет возможность ESI/1.0 к данному запросу.

addSurrogateControl(Response $response)

Добавляет HTTP-заголовки, указывающие на необходимость анализа ответа для ESI.

bool needsParsing(Response $response)

Проверяет, нужно ли анализировать ответ для тегов ESI.

bool needsEsiParsing(Response $response) deprecated

Проверяет, нужно ли анализировать ответ для тегов ESI.

string renderIncludeTag(string $uri, string $alt = null, bool $ignoreErrors = true, string $comment = '')

Рендерит тег ESI.

Response process(Request $request, Response $response)

Заменяет теги ESI в ответе содержимым включённого ресурса.

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

Значение возврата

bool true, если у одного суррогата есть возможность суррогата, иначе false

bool hasSurrogateEsiCapability(Request $request) устарело

устарело

с версия 2.6, будет удалено в 3.0. Используйте hasSurrogateCapability() вместо этого

Проверяет, что хотя бы один суррогат имеет возможности ESI/1.0.

Параметры

Request $request Экземпляр Request

Значение возврата

bool true, если у одного суррогата есть возможность ESI/1.0, иначе false

addSurrogateCapability(Request $request)

Добавляет возможности ESI/1.0 к заданному Request.

Параметры

Request $request

addSurrogateEsiCapability(Request $request) устарело

устарело

с версия 2.6, будет удалено в 3.0. Используйте addSurrogateCapability() вместо этого

Добавляет возможности ESI/1.0 к заданному Request.

Параметры

Request $request Экземпляр Request

addSurrogateControl(Response $response)

Добавляет HTTP-заголовки, указывающие на то, что Response необходимо обработать для ESI.

Этот метод добавляет заголовок ESI в Response только если в нём есть теги ESI.

Параметры

Response $response

bool needsParsing(Response $response)

Проверяет, необходимо ли обработать Response для тегов ESI.

Параметры

Response $response

Значение возврата

bool true, если Response нужно обработать, иначе false

bool needsEsiParsing(Response $response) устарело

устарело

с версия 2.6, будет удалено в 3.0. Используйте needsParsing() вместо этого

Проверяет, необходимо ли обработать 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
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/2.8/Symfony/Component/HttpKernel/HttpCache/Esi.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API