interface SurrogateInterface

Methods

string
getName()

Returns surrogate name.

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.

addSurrogateControl(Response $response)

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

bool
needsParsing(Response $response)

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

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.

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

Handles a Surrogate from the cache.

Details

at line line 24
string getName()

Returns surrogate name.

Return Value

string

at line line 31
ResponseCacheStrategyInterface createCacheStrategy()

Returns a new cache strategy instance.

Return Value

ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance

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

at line line 47
addSurrogateCapability(Request $request)

Adds Surrogate-capability to the given Request.

Parameters

Request $request A Request instance

at line line 56
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 65
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

at line line 77
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 87
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

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