interface ResponsePolicyInterface in Drupal 8

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.

Hierarchy

• interface \Drupal\Core\PageCache\ResponsePolicyInterface

12 files declare their use of ResponsePolicyInterface

ChainResponsePolicyTest.php in core/tests/Drupal/Tests/Core/PageCache/ChainResponsePolicyTest.php

DenyAdminRoutes.php in core/modules/dynamic_page_cache/src/PageCache/ResponsePolicy/DenyAdminRoutes.php

DenyNoCacheRoutes.php in core/lib/Drupal/Core/PageCache/ResponsePolicy/DenyNoCacheRoutes.php

DenyNodePreview.php in core/modules/node/src/PageCache/DenyNodePreview.php

DenyNodePreviewTest.php in core/modules/node/tests/src/Unit/PageCache/DenyNodePreviewTest.php

... See full list

File

core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php, line 15

Namespace

Drupal\Core\PageCache

interface ResponsePolicyInterface {

  /**
   * Deny storage of a page in the cache.
   */
  const DENY = 'deny';

  /**
   * Determines whether it is save to store a page in the cache.
   *
   * @param \Symfony\Component\HttpFoundation\Response $response
   *   The response which is about to be sent to the client.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return 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.
   */
  public function check(Response $response, Request $request);

}

Members

Name	Modifiers	Type	Description	Overrides
ResponsePolicyInterface::check	public	function	Determines whether it is save to store a page in the cache.	8
ResponsePolicyInterface::DENY		constant	Deny storage of a page in the cache.