Ssi

Ssi реализует возможности SSI для объектов Request и Response.

Свойства

protected	$contentTypes		из AbstractSurrogate
protected	$phpEscapeMap		из AbstractSurrogate

Методы

	__construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))	из AbstractSurrogate
ResponseCacheStrategyInterface	createCacheStrategy() Возвращает новый экземпляр стратегии кэширования.	из AbstractSurrogate
bool	hasSurrogateCapability(Request $request) Проверяет, имеет ли хотя бы один суррогат возможность суррогирования.	из AbstractSurrogate
	addSurrogateCapability(Request $request) Добавляет возможность суррогирования в данный Request.	из AbstractSurrogate
bool	needsParsing(Response $response) Проверяет, нужно ли анализировать Response на наличие тегов суррогатов.	из AbstractSurrogate
string	handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors) Обрабатывает суррогат из кэша.	из AbstractSurrogate
	removeFromControl(Response $response) Удаляет суррогат из заголовка Surrogate-Control.	из AbstractSurrogate
string	getName() Возвращает имя суррогата.
	addSurrogateControl(Response $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)

Интерфейс ResponseCacheStrategy createCacheStrategy()

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

Значение возврата

Интерфейс ResponseCacheStrategy

Экземпляр ResponseCacheStrategyInterface

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

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

Параметры

Запрос

$request

Значение возврата

bool	true, если один заменитель обладает возможностью замены, иначе false

addSurrogateCapability(Запрос $request)

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

Параметры

Запрос

$request

bool needsParsing(Ответ $response)

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

Параметры

Ответ

$response

Значение возврата

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

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

Обрабатывает заменитель из кэша.

Параметры

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

Значение возврата

string

Исключения

RuntimeException
Исключение

protected removeFromControl(Ответ $response)

Удаляет заменителя из заголовка Surrogate-Control.

Параметры

Ответ

$response

string getName()

Возвращает имя заменителя.

Значение возврата

string

addSurrogateControl(Ответ $response)

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

Этот метод добавляет заголовок Surrogate только если в ответе есть теги замен.

Параметры

Ответ

$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

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

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

Параметры

Запрос	$request
Ответ	$response

Значение возврата

Ответ

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/HttpCache/Ssi.html