You are here

public function KillSwitch::check in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/PageCache/ResponsePolicy/KillSwitch.php \Drupal\Core\PageCache\ResponsePolicy\KillSwitch::check()
  2. 9 core/lib/Drupal/Core/PageCache/ResponsePolicy/KillSwitch.php \Drupal\Core\PageCache\ResponsePolicy\KillSwitch::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.

Overrides ResponsePolicyInterface::check

File

core/lib/Drupal/Core/PageCache/ResponsePolicy/KillSwitch.php, line 24

Class

KillSwitch
A policy evaluating to static::DENY when the kill switch was triggered.

Namespace

Drupal\Core\PageCache\ResponsePolicy

Code

public function check(Response $response, Request $request) {
  if ($this->kill) {
    return static::DENY;
  }
}