Esi

__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 необходимо обработать для суррогата.

Этот метод добавляет заголовок суррогата только в том случае, если в 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