class Esi extends AbstractSurrogate

Esi implements the ESI capabilities to Request and Response instances.

For more information, read the following W3C notes:

  • ESI Language Specification 1.0 (http://www.w3.org/TR/esi-lang)

  • Edge Architecture Specification (http://www.w3.org/TR/edge-arch)

Methods

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

Constructor.

createCacheStrategy()

Returns a new cache strategy instance.

bool
hasSurrogateCapability(Request $request)

Checks that at least one surrogate has Surrogate capability.

addSurrogateCapability(Request $request)

Adds Surrogate-capability to the given Request.

bool
needsParsing(Response $response)

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

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

Handles a Surrogate from the cache.

string
getName()

Returns surrogate name.

addSurrogateControl(Response $response)

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

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

Renders a Surrogate tag.

process(Request $request, Response $response)

Replaces a Response Surrogate tags with the included resource content.

Details

in AbstractSurrogate at line line 38
__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 Surrogate information. (default: text/html, text/xml, application/xhtml+xml, and application/xml)

in AbstractSurrogate at line line 48
ResponseCacheStrategyInterface createCacheStrategy()

Returns a new cache strategy instance.

Return Value

ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance

in AbstractSurrogate at line line 56
bool hasSurrogateCapability(Request $request)

Checks that at least one surrogate has Surrogate capability.

Parameters

Request $request A Request instance

Return Value

bool true if one surrogate has Surrogate capability, false otherwise

in AbstractSurrogate at line line 68
addSurrogateCapability(Request $request)

Adds Surrogate-capability to the given Request.

Parameters

Request $request A Request instance

in AbstractSurrogate at line line 79
bool needsParsing(Response $response)

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

Parameters

Response $response A Response instance

Return Value

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

in AbstractSurrogate at line line 93
string handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors)

Handles a Surrogate 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

at line line 30
string getName()

Returns surrogate name.

Return Value

string

at line line 38
addSurrogateControl(Response $response)

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

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

Parameters

Response $response A Response instance

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

Renders a Surrogate 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

at line line 66
Response process(Request $request, Response $response)

Replaces a Response Surrogate tags with the included resource content.

Parameters

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

Return Value

Response