Spec-Zone.ru › Symfony 2.7

Ssi

class Ssi implements SurrogateInterface

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

Методы

__construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))
string getName()

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

ResponseCacheStrategyInterface createCacheStrategy()

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

bool hasSurrogateCapability(Request $request)

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

addSurrogateCapability(Request $request)

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

addSurrogateControl(Response $response)

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

bool needsParsing(Response $response)

Проверяет, нужно ли анализировать объект Response на наличие тегов SSI.

string renderIncludeTag(string $uri, string $alt = null, bool $ignoreErrors = true, string $comment = '')

Рендерит тег SSI.

Response process(Request $request, Response $response)

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

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

Обрабатывает тег SSI из кэша.

Подробное описание

__construct(array $contentTypes = array('text/html', 'text/xml', 'application/xhtml+xml', 'application/xml'))

Параметры

array $contentTypes Массив типов содержимого, которые должны анализироваться на наличие информации о SSI (по умолчанию: text/html, text/xml, application/xhtml+xml и application/xml)

string getName()

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

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

string

ResponseCacheStrategyInterface createCacheStrategy()

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

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

ResponseCacheStrategyInterface Экземпляр ResponseCacheStrategyInterface

bool hasSurrogateCapability(Request $request)

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

Параметры

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

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

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

addSurrogateCapability(Request $request)

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

Параметры

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

addSurrogateControl(Response $response)

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

Этот метод добавляет заголовок SSI в HTTP-заголовки объекта Response только в случае, если в нём есть теги SSI.

Параметры

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

bool needsParsing(Response $response)

Проверяет, нужно ли анализировать объект Response на наличие тегов SSI.

Параметры

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

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

bool true, если объект Response необходимо обработать, иначе false

string renderIncludeTag(string $uri, string $alt = null, bool $ignoreErrors = true, string $comment = '')

Рендерит тег SSI.

Параметры

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

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

string

Response process(Request $request, Response $response)

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

Параметры

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

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

Response

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

Обрабатывает тег SSI из кэша.

Параметры

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

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

string

Исключения

RuntimeException
Exception

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API