class IpCacheContext in Drupal 8

Defines the IpCacheContext service, for "per IP address" caching.

Cache context ID: 'ip'.

Hierarchy

• class \Drupal\Core\Cache\Context\RequestStackCacheContextBase
  • class \Drupal\Core\Cache\Context\IpCacheContext implements CacheContextInterface

1 string reference to 'IpCacheContext'

core.services.yml in core/core.services.yml

core/core.services.yml

1 service uses IpCacheContext

cache_context.ip in core/core.services.yml

Drupal\Core\Cache\Context\IpCacheContext

File

core/lib/Drupal/Core/Cache/Context/IpCacheContext.php, line 12

Namespace

Drupal\Core\Cache\Context

class IpCacheContext extends RequestStackCacheContextBase implements CacheContextInterface {

  /**
   * {@inheritdoc}
   */
  public static function getLabel() {
    return t('IP address');
  }

  /**
   * {@inheritdoc}
   */
  public function getContext() {
    return $this->requestStack
      ->getCurrentRequest()
      ->getClientIp();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata() {
    return new CacheableMetadata();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
IpCacheContext::getCacheableMetadata	public	function	Gets the cacheability metadata for the context. Overrides CacheContextInterface::getCacheableMetadata
IpCacheContext::getContext	public	function	Returns the string representation of the cache context. Overrides CacheContextInterface::getContext
IpCacheContext::getLabel	public static	function	Returns the label of the cache context. Overrides CacheContextInterface::getLabel
RequestStackCacheContextBase::$requestStack	protected	property	The request stack.
RequestStackCacheContextBase::__construct	public	function	Constructs a new RequestStackCacheContextBase class.