1. class
  2. Symfony
  3. Component
  4. HttpKernel
  5. HttpCache
  6. Esi

Esi

class Esi implements SurrogateInterface

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.

string
getName()

Returns surrogate name.

ResponseCacheStrategyInterface
createCacheStrategy()

Returns a new cache strategy instance.

bool
hasSurrogateCapability(Request $request)

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

addSurrogateCapability(Request $request)

Adds ESI/1.0 capability to the given Request.

addSurrogateControl(Response $response)

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

bool
needsParsing(Response $response)

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

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

Renders an ESI tag.

Response
process(Request $request, Response $response)

Replaces a Response ESI tags with the included resource content.

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

Handles an ESI from the cache.

Details

at line line 43
__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)

at line line 48
string getName()

Returns surrogate name.

Return Value

string

at line line 58
ResponseCacheStrategyInterface createCacheStrategy()

Returns a new cache strategy instance.

Return Value

ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance

at line line 70
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

at line line 84
addSurrogateCapability(Request $request)

Adds ESI/1.0 capability to the given Request.

Parameters

Request $request A Request instance

at line line 99
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

at line line 113
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

at line line 132
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

at line line 155
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

at line line 227
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