SurrogateInterface

interface SurrogateInterface

Methods

string	getName() Returns surrogate name.
ResponseCacheStrategyInterface	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.
Response	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

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 Surrogate capability.

Parameters

Request

$request

A Request instance

Return Value

bool	true if one surrogate has Surrogate capability, false otherwise

addSurrogateCapability(Request $request)

Adds Surrogate-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 Surrogate.

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

Parameters

Response

$response

A Response instance

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

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

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

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

Links:

http://api.symfony.com/master/Symfony/Component/HttpKernel/HttpCache/SurrogateInterface.html

doc_Symfony

2016-10-28 06:33:43

Comments