1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. PageCache
  7. \
  8. ResponsePolicyInterface

ResponsePolicyInterface

interface ResponsePolicyInterface (View source)

Defines the interface for response policy implementations.

The response policy is evaluated in order to determine whether a page should be stored a in the cache. Calling code should do so unless static::DENY is returned from the check() method.

Constants

DENY

Deny storage of a page in the cache.

Methods

string|null
check(Response $response, Request $request)

Determines whether it is save to store a page in the cache.

Details

at line 35
string|null check(Response $response, Request $request)

Determines whether it is save to store a page in the cache.

Parameters

Response $response

The response which is about to be sent to the client.
Request $request

The request object.

Return Value

string|null

Either static::DENY or NULL. Calling code may attempt to store a page in the cache unless static::DENY is returned. Returns NULL if the policy policy is not specified for the given response.