class LanguagesCacheContext implements CalculatedCacheContextInterface (View source)

Defines the LanguagesCacheContext service, for "per language" caching.

Properties

protected LanguageManagerInterface $languageManager

The language manager.

Methods

__construct(LanguageManagerInterface $language_manager)

Constructs a new LanguagesCacheContext service.

static string
getLabel()

Returns the label of the cache context.

string
getContext($type = NULL)

Returns the string representation of the cache context.

getCacheableMetadata($type = NULL)

Gets the cacheability metadata for the context based on the parameter value.

Details

__construct(LanguageManagerInterface $language_manager)

Constructs a new LanguagesCacheContext service.

Parameters

LanguageManagerInterface $language_manager

The language manager.

static string getLabel()

Returns the label of the cache context.

Return Value

string

The label of the cache context.

string getContext($type = NULL)

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.

Parameters

$type

Return Value

string

The string representation of the cache context. When $parameter is NULL, a value representing all possible parameters must be generated.

Exceptions

LogicException

See also

LanguageManagerInterface::getLanguageTypes

CacheableMetadata getCacheableMetadata($type = NULL)

Gets the cacheability metadata for the context based on the parameter value.

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.

Parameters

$type

Return Value

CacheableMetadata

A cacheable metadata object.

Exceptions

LogicException