Esi

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

Constructor.

Parameters

array

$contentTypes

An array of content-type that should be parsed for ESI information (default: text/html, text/xml, application/xhtml+xml, and application/xml)

string getName()

Returns surrogate name.

Return Value

string

ResponseCacheStrategyInterface createCacheStrategy()

Returns a new cache strategy instance.

Return Value

ResponseCacheStrategyInterface

A ResponseCacheStrategyInterface instance

bool hasSurrogateCapability(Request $request)

Checks that at least one surrogate has ESI/1.0 capability.

Parameters

Request

$request

A Request instance

Return Value

bool	true if one surrogate has Surrogate capability, false otherwise

addSurrogateCapability(Request $request)

Adds ESI/1.0 capability to the given Request.

Parameters

Request

$request

A Request instance

addSurrogateControl(Response $response)

Adds HTTP headers to specify that the Response needs to be parsed for ESI.

This method only adds an ESI HTTP header if the Response has some ESI tags.

Parameters

Response

$response

A Response instance

bool needsParsing(Response $response)

Checks that the Response needs to be parsed for ESI tags.

Parameters

Response

$response

A Response instance

Return Value

bool	true if the Response needs to be parsed, false otherwise

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

Renders an ESI tag.

Parameters

string	$uri	A URI
string	$alt	An alternate URI
bool	$ignoreErrors	Whether to ignore errors or not
string	$comment	A comment to add as an esi:include tag

Return Value

string

Response process(Request $request, Response $response)

Replaces a Response ESI tags with the included resource content.

Parameters

Request	$request	A Request instance
Response	$response	A Response instance

Return Value

Response

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

Handles an ESI from the cache.

Parameters

HttpCache	$cache	An HttpCache instance
string	$uri	The main URI
string	$alt	An alternative URI
bool	$ignoreErrors	Whether to ignore errors or not

Return Value

string

Exceptions

RuntimeException
Exception