public function ChainRequestPolicy::check in Drupal 9

Same name and namespace in other branches

8 core/lib/Drupal/Core/PageCache/ChainRequestPolicy.php \Drupal\Core\PageCache\ChainRequestPolicy::check()

Determines whether delivery of a cached page should be attempted.

Note that the request-policy check runs very early. In particular it is not possible to determine the logged in user. Also the current route match is not yet present when the check runs. Therefore, request-policy checks need to be designed in a way such that they do not depend on any other service and only take in account the information present on the incoming request.

When matching against the request path, special attention is needed to support path prefixes which are often used on multilingual sites.

Parameters

\Symfony\Component\HttpFoundation\Request $request: The incoming request object.

Return value

string|null One of static::ALLOW, static::DENY or NULL. Calling code may attempt to deliver a cached page if static::ALLOW is returned. Returns NULL if the policy is not specified for the given request.

Overrides RequestPolicyInterface::check

File

core/lib/Drupal/Core/PageCache/ChainRequestPolicy.php, line 33

Class

ChainRequestPolicy: Implements a compound request policy.

Namespace

Drupal\Core\PageCache

Code

public function check(Request $request) {
  $final_result = NULL;
  foreach ($this->rules as $rule) {
    $result = $rule
      ->check($request);
    if ($result === static::DENY) {
      return $result;
    }
    elseif ($result === static::ALLOW) {
      $final_result = $result;
    }
    elseif (isset($result)) {
      throw new \UnexpectedValueException('Return value of RequestPolicyInterface::check() must be one of RequestPolicyInterface::ALLOW, RequestPolicyInterface::DENY or NULL');
    }
  }
  return $final_result;
}

You are here