Интерфейс Surrogate

строка getName()

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

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

строка

ResponseCacheStrategyInterface createCacheStrategy()

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

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

ResponseCacheStrategyInterface

Экземпляр ResponseCacheStrategyInterface

bool hasSurrogateCapability(Запрос $request)

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

Параметры

Запрос

$request

Экземпляр Запрос

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

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

addSurrogateCapability(Запрос $request)

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

Параметры

Запрос

$request

Экземпляр Запрос

addSurrogateControl(Ответ $response)

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

Этот метод добавляет заголовок Surrogate в HTTP только если в Ответе есть какие-либо теги суррогата.

Параметры

Ответ

$response

Экземпляр Ответ

bool needsParsing(Ответ $response)

Проверяет, нужно ли обработать Ответ на предмет тегов суррогата.

Параметры

Ответ

$response

Экземпляр Ответ

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

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

строка renderIncludeTag(строка $uri, строка $alt = null, bool $ignoreErrors = true, строка $comment = '')

Создаёт тег суррогата.

Параметры

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

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

строка

Ответ process(Запрос $request, Ответ $response)

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

Параметры

Запрос	$request	Экземпляр Запрос
Ответ	$response	Экземпляр Ответ

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

Ответ

строка handle(HttpCache $cache, строка $uri, строка $alt, bool $ignoreErrors)

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

Параметры

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

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

строка

Исключения

RuntimeException
Исключение