You are here

DenyAdminRoutes.php in Drupal 9

File

core/modules/dynamic_page_cache/src/PageCache/ResponsePolicy/DenyAdminRoutes.php
View source
<?php

namespace Drupal\dynamic_page_cache\PageCache\ResponsePolicy;

use Drupal\Core\PageCache\ResponsePolicyInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * Cache policy for routes with the '_admin_route' option set.
 *
 * This policy rule denies caching of responses generated for admin routes,
 * because admin routes have very low cache hit ratios due to low traffic and
 * form submissions.
 */
class DenyAdminRoutes implements ResponsePolicyInterface {

  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Constructs a deny admin route 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('_admin_route')) {
      return static::DENY;
    }
  }

}

Classes

Namesort descending Description
DenyAdminRoutes Cache policy for routes with the '_admin_route' option set.