QueryArgsCacheContext.php

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

Namespace

Drupal\Core\Cache\Context

File

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

View source
<?php

namespace Drupal\Core\Cache\Context;

use Drupal\Core\Cache\CacheableMetadata;

/**
 * Defines the QueryArgsCacheContext service, for "per query args" caching.
 *
 * Cache context ID: 'url.query_args' (to vary by all query arguments).
 * Calculated cache context ID: 'url.query_args:%key', e.g.'url.query_args:foo'
 * (to vary by the 'foo' query argument).
 */
class QueryArgsCacheContext extends RequestStackCacheContextBase implements CalculatedCacheContextInterface {
    
    /**
     * {@inheritdoc}
     */
    public static function getLabel() {
        return t('Query arguments');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContext($query_arg = NULL) {
        if ($query_arg === NULL) {
            // All arguments requested. Use normalized query string to minimize
            // variations.
            $value = $this->requestStack
                ->getCurrentRequest()
                ->getQueryString();
            return $value !== NULL ? $value : '';
        }
        elseif ($this->requestStack
            ->getCurrentRequest()->query
            ->has($query_arg)) {
            $value = $this->requestStack
                ->getCurrentRequest()->query
                ->all()[$query_arg];
            if (is_array($value)) {
                return http_build_query($value);
            }
            elseif ($value !== '') {
                return $value;
            }
            return '?valueless?';
        }
        return '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheableMetadata($query_arg = NULL) {
        return new CacheableMetadata();
    }

}

Classes

Title Deprecated Summary
QueryArgsCacheContext Defines the QueryArgsCacheContext service, for "per query args" caching.

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