class CacheControlEventSubscriber in HTTP Cache Control 8.2

Subscriber for adding http cache control headers.

Hierarchy

• class \Drupal\http_cache_control\EventSubscriber\CacheControlEventSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'CacheControlEventSubscriber'

http_cache_control.services.yml in ./http_cache_control.services.yml

http_cache_control.services.yml

1 service uses CacheControlEventSubscriber

s_max_age_event_subscriber in ./http_cache_control.services.yml

Drupal\http_cache_control\EventSubscriber\CacheControlEventSubscriber

File

src/EventSubscriber/CacheControlEventSubscriber.php, line 14

Namespace

Drupal\http_cache_control\EventSubscriber

class CacheControlEventSubscriber implements EventSubscriberInterface {

  /**
   * Configuration Factory.
   *
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * Constructor.
   */
  public function __construct(ConfigFactory $configFactory) {
    $this->configFactory = $configFactory;
  }

  /**
   * Set http cache control headers.
   */
  public function setHeaderCacheControl(FilterResponseEvent $event) {
    $config = $this->configFactory
      ->get('http_cache_control.settings');
    $response = $event
      ->getResponse();
    if ($variation = $config
      ->get('cache.http.vary')) {
      $vary = $response
        ->getVary();
      foreach (array_map('trim', explode(',', $variation)) as $header) {
        $vary[] = $header;
      }
      if (!Settings::get('omit_vary_cookie')) {
        $vary[] = 'Cookie';
      }
      $response
        ->setVary(implode(',', $vary));
    }
    if (!$response
      ->isCacheable()) {
      return;
    }
    $ttl = $response
      ->getMaxAge();
    switch ($response
      ->getStatusCode()) {
      case 404:
        $ttl = $config
          ->get('cache.http.404_max_age', $ttl);
        break;
      case 302:
        $ttl = $config
          ->get('cache.http.302_max_age', $ttl);
        break;
      case 301:
        $ttl = $config
          ->get('cache.http.301_max_age', $ttl);
        break;
    }
    if ($ttl != $response
      ->getMaxAge()) {
      $response
        ->setClientTtl($ttl);
      $response
        ->setSharedMaxAge($ttl);
    }
    elseif ($ttl = $config
      ->get('cache.http.s_maxage')) {
      $response
        ->setSharedMaxAge($ttl);
    }
    if ($response
      ->getStatusCode() >= 500) {
      $response
        ->setSharedMaxAge($config
        ->get('cache.http.5xx_max_age'));
    }
    elseif ($response
      ->getStatusCode() < 400) {

      // Add stale-if-error directive.
      if ($seconds = $config
        ->get('cache.http.stale_if_error')) {
        $response->headers
          ->addCacheControlDirective('stale-if-error', $seconds);
      }

      // Add stale-while-revalidate directive.
      if ($seconds = $config
        ->get('cache.http.stale_while_revalidate')) {
        $response->headers
          ->addCacheControlDirective('stale-while-revalidate', $seconds);
      }

      // Surrogate Control
      $maxage = $config
        ->get('cache.surrogate.maxage');
      $nostore = $config
        ->get('cache.surrogate.nostore');
      if (!empty($maxage) || $nostore) {
        $value = $nostore ? [
          'no-store',
        ] : [];
        if (!empty($maxage)) {
          $value[] = 'max-age=' . $maxage;
        }
        $response->headers
          ->set('Surrogate-Control', implode(', ', $value));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {

    // Response: set header content for security policy.
    $events[KernelEvents::RESPONSE][] = [
      'setHeaderCacheControl',
      -10,
    ];
    return $events;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheControlEventSubscriber::$configFactory	protected	property	Configuration Factory.
CacheControlEventSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
CacheControlEventSubscriber::setHeaderCacheControl	public	function	Set http cache control headers.
CacheControlEventSubscriber::__construct	public	function	Constructor.