HttpCache\SurrogateInterface (Component\HttpKernel)
Symfony\Component\HttpKernel\HttpCache\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
public string getName()
Returns surrogate name.
public ResponseCacheStrategyInterface createCacheStrategy()
Returns a new cache strategy instance.
public bool hasSurrogateCapability(Request $request)
Checks that at least one surrogate has Surrogate capability.
public addSurrogateCapability(Request $request)
Adds Surrogate-capability to the given Request.
public 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.
public bool needsParsing(Response $response)
Checks that the Response needs to be parsed for Surrogate tags.
public string renderIncludeTag(string $uri, string $alt = null, bool $ignoreErrors = true, string $comment = '')
Renders a Surrogate tag.
public Response process(Request $request, Response $response)
Replaces a Response Surrogate tags with the included resource content.
public string handle(HttpCache $cache, string $uri, string $alt, bool $ignoreErrors)
Handles a Surrogate from the cache.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpKernel/HttpCache/SurrogateInterface.html