class ContextCacheKeys in Drupal 10

A value object to store generated cache keys with its cacheability metadata.

Hierarchy

• class \Drupal\Core\Cache\CacheableMetadata implements RefinableCacheableDependencyInterface uses RefinableCacheableDependencyTrait
  • class \Drupal\Core\Cache\Context\ContextCacheKeys

1 file declares its use of ContextCacheKeys

RendererTestBase.php in core/tests/Drupal/Tests/Core/Render/RendererTestBase.php

Contains \Drupal\Tests\Core\Render\RendererTestBase.

File

core/lib/Drupal/Core/Cache/Context/ContextCacheKeys.php, line 10

Namespace

Drupal\Core\Cache\Context

class ContextCacheKeys extends CacheableMetadata {

  /**
   * The generated cache keys.
   *
   * @var string[]
   */
  protected $keys;

  /**
   * Constructs a ContextCacheKeys object.
   *
   * @param string[] $keys
   *   The cache context keys.
   */
  public function __construct(array $keys) {

    // Domain invariant: cache keys must be always sorted.
    // Sorting keys warrants that different combination of the same keys
    // generates the same cache cid.
    // @see \Drupal\Core\Render\RenderCache::createCacheID()
    sort($keys);
    $this->keys = $keys;
  }

  /**
   * Gets the generated cache keys.
   *
   * @return string[]
   *   The cache keys.
   */
  public function getKeys() {
    return $this->keys;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
CacheableMetadata::applyTo	public	function	Applies the values of this CacheableMetadata object to a render array.
CacheableMetadata::createFromObject	public static	function	Creates a CacheableMetadata object from a depended object.
CacheableMetadata::createFromRenderArray	public static	function	Creates a CacheableMetadata object with values taken from a render array.
CacheableMetadata::getCacheContexts	public	function
CacheableMetadata::getCacheMaxAge	public	function
CacheableMetadata::getCacheTags	public	function
CacheableMetadata::merge	public	function	Merges the values of another CacheableMetadata object with this one.
CacheableMetadata::setCacheContexts	public	function	Sets cache contexts.
CacheableMetadata::setCacheMaxAge	public	function	Sets the maximum age (in seconds).
CacheableMetadata::setCacheTags	public	function	Sets cache tags.
ContextCacheKeys::$keys	protected	property	The generated cache keys.
ContextCacheKeys::getKeys	public	function	Gets the generated cache keys.
ContextCacheKeys::__construct	public	function	Constructs a ContextCacheKeys object.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function