class ChainResponsePolicy in Zircon Profile 8
Same name in this branch
- 8 core/lib/Drupal/Core/PageCache/ChainResponsePolicy.php \Drupal\Core\PageCache\ChainResponsePolicy
- 8 core/lib/Drupal/Core/ProxyClass/PageCache/ChainResponsePolicy.php \Drupal\Core\ProxyClass\PageCache\ChainResponsePolicy
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/PageCache/ChainResponsePolicy.php \Drupal\Core\PageCache\ChainResponsePolicy
Implements a compound response policy.
When evaluating the compound policy, all of the contained rules are applied to the response. The overall result is computed according to the following rules:
<ol> <li>Returns static::DENY if any of the rules evaluated to static::DENY</li> <li>Otherwise returns NULL</li> </ol>
Hierarchy
- class \Drupal\Core\PageCache\ChainResponsePolicy implements ChainResponsePolicyInterface
Expanded class hierarchy of ChainResponsePolicy
1 file declares its use of ChainResponsePolicy
- ChainResponsePolicyTest.php in core/
tests/ Drupal/ Tests/ Core/ PageCache/ ChainResponsePolicyTest.php - Contains \Drupal\Tests\Core\PageCache\ChainResponsePolicyTest.
2 string references to 'ChainResponsePolicy'
- core.services.yml in core/
core.services.yml - core/core.services.yml
- dynamic_page_cache.services.yml in core/
modules/ dynamic_page_cache/ dynamic_page_cache.services.yml - core/modules/dynamic_page_cache/dynamic_page_cache.services.yml
2 services use ChainResponsePolicy
- dynamic_page_cache_response_policy in core/
modules/ dynamic_page_cache/ dynamic_page_cache.services.yml - Drupal\Core\PageCache\ChainResponsePolicy
- page_cache_response_policy in core/
core.services.yml - Drupal\Core\PageCache\ChainResponsePolicy
File
- core/
lib/ Drupal/ Core/ PageCache/ ChainResponsePolicy.php, line 24 - Contains \Drupal\Core\PageCache\ChainResponsePolicy.
Namespace
Drupal\Core\PageCacheView source
class ChainResponsePolicy implements ChainResponsePolicyInterface {
/**
* A list of policy rules to apply when this policy is checked.
*
* @var \Drupal\Core\PageCache\ResponsePolicyInterface[]
*/
protected $rules = [];
/**
* {@inheritdoc}
*/
public function check(Response $response, Request $request) {
foreach ($this->rules as $rule) {
$result = $rule
->check($response, $request);
if ($result === static::DENY) {
return $result;
}
elseif (isset($result)) {
throw new \UnexpectedValueException('Return value of ResponsePolicyInterface::check() must be one of ResponsePolicyInterface::DENY or NULL');
}
}
}
/**
* {@inheritdoc}
*/
public function addPolicy(ResponsePolicyInterface $policy) {
$this->rules[] = $policy;
return $this;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ChainResponsePolicy:: |
protected | property | A list of policy rules to apply when this policy is checked. | |
ChainResponsePolicy:: |
public | function |
Add a policy to the list of policy rules. Overrides ChainResponsePolicyInterface:: |
|
ChainResponsePolicy:: |
public | function |
Determines whether it is save to store a page in the cache. Overrides ResponsePolicyInterface:: |
|
ResponsePolicyInterface:: |
constant | Deny storage of a page in the cache. |