SurrogateInterface

string getName()

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

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

string

ResponseCacheStrategyInterface createCacheStrategy()

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

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

ResponseCacheStrategyInterface

Экземпляр ResponseCacheStrategyInterface

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

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

Параметры

Запрос

$request

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

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

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

addSurrogateCapability(Запрос $request)

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

Параметры

Запрос

$request

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

addSurrogateControl(Ответ $response)

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

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

Параметры

Ответ

$response

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

bool needsParsing(Ответ $response)

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

Параметры

Ответ

$response

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

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

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

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

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

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

Параметры

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

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

Ответ

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

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

Параметры

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

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

string

Исключения

RuntimeException
Исключение