Spec-Zone.ru › Symfony 3.2

Esi

class Esi extends AbstractSurrogate

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'))

Конструктор.

from AbstractSurrogate
ResponseCacheStrategyInterface createCacheStrategy()

Возвращает новый экземпляр стратегии кэширования.

from AbstractSurrogate
bool hasSurrogateCapability(Request $request)

Проверяет, что хотя бы один суррогат обладает способностью суррогирования.

from AbstractSurrogate
addSurrogateCapability(Request $request)

Добавляет возможность суррогирования в данный Request.

from AbstractSurrogate
bool needsParsing(Response $response)

Проверяет, нужно ли анализировать Response на наличие тегов суррогата.

from AbstractSurrogate
string handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors)

Обрабатывает суррогат из кэша.

from AbstractSurrogate
string getName()

Возвращает имя суррогата.

addSurrogateControl(Response $response)

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

Этот метод добавляет заголовок суррогата HTTP только в том случае, если в Response есть теги суррогата.

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

Рендерит тег суррогата.

Response process(Request $request, Response $response)

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

Подробное описание

__construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))

Конструктор.

Параметры

array $contentTypes Массив типов содержимого, которые должны быть обработаны на наличие информации о суррогате (по умолчанию: text/html, text/xml, application/xhtml+xml и application/xml)

ResponseCacheStrategyInterface createCacheStrategy()

Возвращает новый экземпляр стратегии кэширования.

Возвращаемое значение

ResponseCacheStrategyInterface Экземпляр ResponseCacheStrategyInterface

bool hasSurrogateCapability(Request $request)

Проверяет, что хотя бы один суррогат обладает способностью суррогирования.

Параметры

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

Возвращаемое значение

bool true, если один суррогат обладает способностью суррогирования, иначе false

addSurrogateCapability(Request $request)

Добавляет возможность суррогирования в данный Request.

Параметры

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

bool needsParsing(Response $response)

Проверяет, нужно ли анализировать Response на наличие тегов суррогата.

Параметры

Response $response Экземпляр Response

Возвращаемое значение

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

string handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors)

Обрабатывает суррогат из кэша.

Параметры

HttpCache $cache Экземпляр HttpCache
string $uri Основной URI
string $alt Альтернативный URI
bool $ignoreErrors Игнорировать ошибки или нет

Возвращаемое значение

string

Исключения

RuntimeException
Exception

string getName()

Возвращает имя суррогата.

Возвращаемое значение

string

addSurrogateControl(Response $response)

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

Этот метод добавляет заголовок суррогата HTTP только в том случае, если в Response есть теги суррогата.

Параметры

Response $response Экземпляр Response

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

Рендерит тег суррогата.

Параметры

string $uri URI
string $alt Альтернативный URI
bool $ignoreErrors Игнорировать ошибки или нет
string $comment Комментарий для добавления в тег esi:include

Возвращаемое значение

string

Response process(Request $request, Response $response)

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

Параметры

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

Возвращаемое значение

Response

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/HttpKernel/HttpCache/Esi.html

Spec-Zone.ru

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