class UserCacheContext

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Cache/Context/UserCacheContext.php \Drupal\Core\Cache\Context\UserCacheContext
  2. 10 core/lib/Drupal/Core/Cache/Context/UserCacheContext.php \Drupal\Core\Cache\Context\UserCacheContext
  3. 11.x core/lib/Drupal/Core/Cache/Context/UserCacheContext.php \Drupal\Core\Cache\Context\UserCacheContext

Defines the UserCacheContext service, for "per user" caching.

Cache context ID: 'user'.

Hierarchy

Expanded class hierarchy of UserCacheContext

1 string reference to 'UserCacheContext'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses UserCacheContext
cache_context.user in core/core.services.yml
Drupal\Core\Cache\Context\UserCacheContext

File

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

Namespace

Drupal\Core\Cache\Context
View source 
class UserCacheContext extends UserCacheContextBase implements CacheContextInterface {
    
    /**
     * {@inheritdoc}
     */
    public static function getLabel() {
        return t('User');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContext() {
        return $this->user
            ->id();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheableMetadata() {
        return new CacheableMetadata();
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
UserCacheContext::getCacheableMetadata public function Gets the cacheability metadata for the context. Overrides CacheContextInterface::getCacheableMetadata
UserCacheContext::getContext public function Returns the string representation of the cache context. Overrides CacheContextInterface::getContext
UserCacheContext::getLabel public static function Returns the label of the cache context. Overrides CacheContextInterface::getLabel
UserCacheContextBase::$user protected property The account object.
UserCacheContextBase::__construct public function Constructs a new UserCacheContextBase class. 1

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