CacheContextInterface.php in Render cache 7.2

Contains \Drupal\Core\Cache\CacheContextInterface.

Namespace

Drupal\Core\Cache

File

lib/Drupal/Core/Cache/CacheContextInterface.php

<?php

/**
 * @file
 * Contains \Drupal\Core\Cache\CacheContextInterface.
 */
namespace Drupal\Core\Cache;


/**
 * Provides an interface for defining a cache context service.
 */
interface CacheContextInterface {

  /**
   * Returns the label of the cache context.
   *
   * @return string
   *   The label of the cache context.
   */
  public static function getLabel();

  /**
   * Returns the string representation of the cache context.
   *
   * A cache context service's name is used as a token (placeholder) cache key,
   * and is then replaced with the string returned by this method.
   *
   * @return string
   *   The string representation of the cache context.
   */
  public function getContext();

}

Interfaces

Name	Description
CacheContextInterface	Provides an interface for defining a cache context service.