DefaultRevalidation
in package
implements
RevalidationInterface
Default revalidation strategy
Interfaces, Classes and Traits
- RevalidationInterface
- Cache revalidation interface
Table of Contents
- $canCache : CanCacheStrategyInterface
- $storage : CacheStorageInterface
- __construct() : mixed
- revalidate() : bool
- Performs a cache revalidation
- shouldRevalidate() : bool
- Returns true if the response should be revalidated
- createRevalidationRequest() : RequestInterface
- Creates a request to use for revalidation
- handle200Response() : bool
- Handles a 200 response response from revalidating. The server does not support validation, so use this response.
- handle304Response() : bool
- Handle a 304 response and ensure that it is still valid
- handleBadResponse() : mixed
- Handles a bad response when attempting to revalidate
Properties
$canCache
protected
CanCacheStrategyInterface
$canCache
$storage
protected
CacheStorageInterface
$storage
Cache object storing cache data
Methods
__construct()
public
__construct(CacheStorageInterface $cache[, CanCacheStrategyInterface $canCache = null ]) : mixed
Parameters
- $cache : CacheStorageInterface
-
Cache storage
- $canCache : CanCacheStrategyInterface = null
-
Determines if a message can be cached
Return values
mixed —revalidate()
Performs a cache revalidation
public
revalidate(RequestInterface $request, Response $response) : bool
Parameters
- $request : RequestInterface
-
Request to revalidate
- $response : Response
-
Response that was received
Return values
bool —Returns true if the request can be cached
shouldRevalidate()
Returns true if the response should be revalidated
public
shouldRevalidate(RequestInterface $request, Response $response) : bool
Parameters
- $request : RequestInterface
-
Request to check
- $response : Response
-
Response to check
Return values
bool —createRevalidationRequest()
Creates a request to use for revalidation
protected
createRevalidationRequest(RequestInterface $request, Response $response) : RequestInterface
Parameters
- $request : RequestInterface
-
Request
- $response : Response
-
Response to revalidate
Return values
RequestInterface —returns a revalidation request
handle200Response()
Handles a 200 response response from revalidating. The server does not support validation, so use this response.
protected
handle200Response(RequestInterface $request, Response $validateResponse) : bool
Parameters
- $request : RequestInterface
-
Request that was sent
- $validateResponse : Response
-
Response received
Return values
bool —Returns true if valid, false if invalid
handle304Response()
Handle a 304 response and ensure that it is still valid
protected
handle304Response(RequestInterface $request, Response $validateResponse, Response $response) : bool
Parameters
- $request : RequestInterface
-
Request that was sent
- $validateResponse : Response
-
Response received
- $response : Response
-
Original cached response
Return values
bool —Returns true if valid, false if invalid
handleBadResponse()
Handles a bad response when attempting to revalidate
protected
handleBadResponse(BadResponseException $e) : mixed
Parameters
- $e : BadResponseException
-
Exception encountered