1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Cache
  7. \
  8. Context
  9. \
  10. UserCacheContext

UserCacheContext

class UserCacheContext extends UserCacheContextBase implements CacheContextInterface (View source)

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

Cache context ID: 'user'.

Properties

protected AccountInterface $user

The account object.

 from  UserCacheContextBase

Methods

__construct(AccountInterface $user)

Constructs a new UserCacheContextBase class.

from  UserCacheContextBase
static string
getLabel()

Returns the label of the cache context.

string
getContext()

Returns the string representation of the cache context.

CacheableMetadata
getCacheableMetadata()

Gets the cacheability metadata for the context.

Details

in UserCacheContextBase at line 29
__construct(AccountInterface $user)

Constructs a new UserCacheContextBase class.

Parameters

AccountInterface $user

The current user.

at line 17
static string getLabel()

Returns the label of the cache context.

Return Value

string

The label of the cache context.

at line 24
string getContext()

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 Value

string

The string representation of the cache context.

at line 31
CacheableMetadata getCacheableMetadata()

Gets the cacheability metadata for the context.

There are three valid cases for the returned CacheableMetadata object:

  • An empty object means this can be optimized away safely.
  • A max-age of 0 means that this context can never be optimized away. It will never bubble up and cache tags will not be used.
  • Any non-zero max-age and cache tags will bubble up into the cache item if this is optimized away to allow for invalidation if the context value changes.

Return Value

CacheableMetadata

A cacheable metadata object.