function ResponsePolicyInterface::check

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php \Drupal\Core\PageCache\ResponsePolicyInterface::check()
  2. 10 core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php \Drupal\Core\PageCache\ResponsePolicyInterface::check()
  3. 11.x core/lib/Drupal/Core/PageCache/ResponsePolicyInterface.php \Drupal\Core\PageCache\ResponsePolicyInterface::check()

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

Parameters

\Symfony\Component\HttpFoundation\Response $response: The response which is about to be sent to the client.

\Symfony\Component\HttpFoundation\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.

8 methods override ResponsePolicyInterface::check()
ChainResponsePolicy::check in core/lib/Drupal/Core/ProxyClass/PageCache/ChainResponsePolicy.php
ChainResponsePolicy::check in core/lib/Drupal/Core/PageCache/ChainResponsePolicy.php
DenyAdminRoutes::check in core/modules/dynamic_page_cache/src/PageCache/ResponsePolicy/DenyAdminRoutes.php
Determines whether it is save to store a page in the cache.
DenyNoCacheRoutes::check in core/lib/Drupal/Core/PageCache/ResponsePolicy/DenyNoCacheRoutes.php
DenyNodePreview::check in core/modules/node/src/PageCache/DenyNodePreview.php

... See full list

File

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

Class

ResponsePolicyInterface
Defines the interface for response policy implementations.

Namespace

Drupal\Core\PageCache

Code

public function check(Response $response, Request $request);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.