HttpCache
HttpCache
class HttpCache implements HttpKernelInterface, TerminableInterface
Cache provides HTTP caching.
Methods
__construct(HttpKernelInterface $kernel, StoreInterface $store, SurrogateInterface $surrogate = null, array $options = array()) Constructor. | ||
StoreInterface | getStore() Gets the current store. | |
array | getTraces() Returns an array of events that took place during processing of the last request. | |
string | getLog() Returns a log message for the events of the last request processing. | |
Request | getRequest() Gets the Request instance associated with the master request. | |
HttpKernelInterface | getKernel() Gets the Kernel instance. | |
SurrogateInterface | getSurrogate() Gets the Surrogate instance. | |
Response | handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true) Handles a Request to convert it to a Response. | |
terminate(Request $request, Response $response) Terminates a request/response cycle. |
Details
__construct(HttpKernelInterface $kernel, StoreInterface $store, SurrogateInterface $surrogate = null, array $options = array())
Constructor.
The available options are:
debug: If true, the traces are added as a HTTP header to ease debugging
default_ttl The number of seconds that a cache entry should be considered fresh when no explicit freshness information is provided in a response. Explicit Cache-Control or Expires headers override this value. (default: 0)
private_headers Set of request headers that trigger "private" cache-control behavior on responses that don't explicitly state whether the response is public or private via a Cache-Control directive. (default: Authorization and Cookie)
allow_reload Specifies whether the client can force a cache reload by including a Cache-Control "no-cache" directive in the request. Set it to
true
for compliance with RFC 2616. (default: false)allow_revalidate Specifies whether the client can force a cache revalidate by including a Cache-Control "max-age=0" directive in the request. Set it to
true
for compliance with RFC 2616. (default: false)stalewhilerevalidate Specifies the default number of seconds (the granularity is the second as the Response TTL precision is a second) during which the cache can immediately return a stale response while it revalidates it in the background (default: 2). This setting is overridden by the stale-while-revalidate HTTP Cache-Control extension (see RFC 5861).
staleiferror Specifies the default number of seconds (the granularity is the second) during which the cache can serve a stale response when an error is encountered (default: 60). This setting is overridden by the stale-if-error HTTP Cache-Control extension (see RFC 5861).
Parameters
HttpKernelInterface | $kernel | An HttpKernelInterface instance |
StoreInterface | $store | A Store instance |
SurrogateInterface | $surrogate | A SurrogateInterface instance |
array | $options | An array of options |
StoreInterface getStore()
Gets the current store.
Return Value
StoreInterface | $store A StoreInterface instance |
array getTraces()
Returns an array of events that took place during processing of the last request.
Return Value
array | An array of events |
string getLog()
Returns a log message for the events of the last request processing.
Return Value
string | A log message |
Request getRequest()
Gets the Request instance associated with the master request.
Return Value
Request | A Request instance |
HttpKernelInterface getKernel()
Gets the Kernel instance.
Return Value
HttpKernelInterface | An HttpKernelInterface instance |
SurrogateInterface getSurrogate()
Gets the Surrogate instance.
Return Value
SurrogateInterface | A Surrogate instance |
Exceptions
LogicException |
Response handle(Request $request, int $type = HttpKernelInterface::MASTER_REQUEST, bool $catch = true)
Handles a Request to convert it to a Response.
When $catch is true, the implementation must catch all exceptions and do its best to convert them to a Response instance.
Parameters
Request | $request | A Request instance |
int | $type | The type of the request (one of HttpKernelInterface::MASTERREQUEST or HttpKernelInterface::SUBREQUEST) |
bool | $catch | Whether to catch exceptions or not |
Return Value
Response | A Response instance |
Exceptions
Exception | When an Exception occurs during processing |
terminate(Request $request, Response $response)
Terminates a request/response cycle.
Should be called after sending the response and before shutting down the kernel.
Parameters
Request | $request | A Request instance |
Response | $response | A Response instance |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/HttpKernel/HttpCache/HttpCache.html