class DenyNoCacheRoutes

Cache policy for routes with the 'no_cache' option set.

This policy rule denies caching of responses generated for routes that have the 'no_cache' option set to TRUE.

Hierarchy

Expanded class hierarchy of DenyNoCacheRoutes

1 string reference to 'DenyNoCacheRoutes'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses DenyNoCacheRoutes
page_cache_no_cache_routes in core/core.services.yml
Drupal\Core\PageCache\ResponsePolicy\DenyNoCacheRoutes

File

View on git.drupalcode.org

core/lib/Drupal/Core/PageCache/ResponsePolicy/DenyNoCacheRoutes.php, line 16

Namespace

Drupal\Core\PageCache\ResponsePolicy
View source 
class DenyNoCacheRoutes implements ResponsePolicyInterface {
  
  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;
  
  /**
   * Constructs a deny node preview page cache policy.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   */
  public function __construct(RouteMatchInterface $route_match) {
    $this->routeMatch = $route_match;
  }
  
  /**
   * {@inheritdoc}
   */
  public function check(Response $response, Request $request) {
    if (($route = $this->routeMatch
      ->getRouteObject()) && $route->getOption('no_cache')) {
      return static::DENY;
    }
  }

}

Members

Title Modifiers Object type Summary Overriden Title
DenyNoCacheRoutes::$routeMatch protected property The current route match.
DenyNoCacheRoutes::check public function Determines whether it is save to store a page in the cache. Overrides ResponsePolicyInterface::check
DenyNoCacheRoutes::__construct public function Constructs a deny node preview page cache policy.
ResponsePolicyInterface::DENY constant Deny storage of a page in the cache.

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