RequestFormatCacheContext.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Cache/Context/RequestFormatCacheContext.php
  2. 10 core/lib/Drupal/Core/Cache/Context/RequestFormatCacheContext.php
  3. 11.x core/lib/Drupal/Core/Cache/Context/RequestFormatCacheContext.php

Namespace

Drupal\Core\Cache\Context

File

core/lib/Drupal/Core/Cache/Context/RequestFormatCacheContext.php

View source
<?php

namespace Drupal\Core\Cache\Context;

use Drupal\Core\Cache\CacheableMetadata;

/**
 * Defines the RequestFormatCacheContext service, for "per format" caching.
 *
 * Cache context ID: 'request_format'.
 */
class RequestFormatCacheContext extends RequestStackCacheContextBase {
    
    /**
     * {@inheritdoc}
     */
    public static function getLabel() {
        return t('Request format');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContext() {
        return $this->requestStack
            ->getCurrentRequest()
            ->getRequestFormat();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheableMetadata() {
        return new CacheableMetadata();
    }

}

Classes

Title Deprecated Summary
RequestFormatCacheContext Defines the RequestFormatCacheContext service, for "per format" caching.

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