SurrogateInterface

string getName()

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

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

string

ResponseCacheStrategyInterface createCacheStrategy()

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

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

ResponseCacheStrategyInterface

Экземпляр ResponseCacheStrategyInterface

bool hasSurrogateCapability(Request $request)

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

Параметры

Request

$request

Экземпляр Request

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

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

addSurrogateCapability(Request $request)

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

Параметры

Request

$request

Экземпляр Request

addSurrogateControl(Response $response)

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

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

Параметры

Response

$response

Экземпляр Response

bool needsParsing(Response $response)

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

Параметры

Response

$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

Response process(Request $request, Response $response)

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

Параметры

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

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

Response

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

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

Параметры

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

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

string

Исключения

RuntimeException
Exception