class LocaleLookup extends CacheCollector (View source)

A cache collector to allow for dynamic building of the locale cache.

Properties

protected string $cid

The cache id that is used for the cache entry.

from  CacheCollector
protected array $tags

A list of tags that are used for the cache entry.

from  CacheCollector
protected CacheBackendInterface $cache

The cache backend that should be used.

protected LockBackendInterface $lock

The lock backend that should be used.

protected array $keysToPersist

An array of keys to add to the cache on service termination.

from  CacheCollector
protected array $keysToRemove

An array of keys to remove from the cache on service termination.

from  CacheCollector
protected array $storage

Storage for the data itself.

from  CacheCollector
protected int $cacheCreated

Stores the cache creation time.

from  CacheCollector
protected bool $cacheInvalidated

Flag that indicates of the cache has been invalidated.

from  CacheCollector
protected bool $cacheLoaded

Indicates if the collected cache was already loaded.

from  CacheCollector
protected string $langcode

A language code.

protected string $context

The msgctxt context.

protected StringStorageInterface $stringStorage

The locale storage.

protected ConfigFactoryInterface $configFactory

The configuration factory.

protected LanguageManagerInterface $languageManager

The language manager.

protected RequestStack $requestStack

The request stack.

Methods

__construct(string $langcode, string $context, StringStorageInterface $string_storage, CacheBackendInterface $cache, LockBackendInterface $lock, ConfigFactoryInterface $config_factory, LanguageManagerInterface $language_manager, RequestStack $request_stack)

Constructs a LocaleLookup object.

string
getCid()

Gets the cache ID.

has(string $key)

Returns whether data exists for this key.

mixed
get(string $key)

Gets value from the cache.

set(string $key, mixed $value)

Implements \Drupal\Core\Cache\CacheCollectorInterface::set().

delete(string $key)

Deletes the element.

persist(string $key, bool $persist = TRUE)

Flags an offset value to be written to the persistent cache.

mixed
resolveCacheMiss($offset)

Resolves a cache miss.

updateCache(bool $lock = TRUE)

Writes a value to the persistent cache immediately.

string
normalizeLockName(string $cid)

Normalizes a cache ID in order to comply with database limitations.

reset()

Resets the local cache.

clear()

Clears the collected cache entry.

destruct()

Performs destruct operations.

lazyLoadCache()

Loads the cache if not already done.

invalidateCache()

Invalidate the cache.

Details

__construct(string $langcode, string $context, StringStorageInterface $string_storage, CacheBackendInterface $cache, LockBackendInterface $lock, ConfigFactoryInterface $config_factory, LanguageManagerInterface $language_manager, RequestStack $request_stack)

Constructs a LocaleLookup object.

Parameters

string $langcode

The language code.

string $context

The string context.

StringStorageInterface $string_storage

The string storage.

CacheBackendInterface $cache

The cache backend.

LockBackendInterface $lock

The lock backend.

ConfigFactoryInterface $config_factory

The config factory.

LanguageManagerInterface $language_manager

The language manager.

RequestStack $request_stack

The request stack.

protected string getCid()

Gets the cache ID.

Return Value

string

has(string $key)

Returns whether data exists for this key.

Parameters

string $key

Key that identifies the data.

mixed get(string $key)

Gets value from the cache.

Parameters

string $key

Key that identifies the data.

Return Value

mixed

The corresponding cache data.

set(string $key, mixed $value)

Implements \Drupal\Core\Cache\CacheCollectorInterface::set().

This is not persisted by default. In practice this means that setting a value will only apply while the object is in scope and will not be written back to the persistent cache. This follows a similar pattern to static vs. persistent caching in procedural code. Extending classes may wish to alter this behavior, for example by adding a call to persist().

Parameters

string $key

Key that identifies the data.

mixed $value

The data to be set.

delete(string $key)

Deletes the element.

It depends on the specific case and implementation whether this has a permanent effect or if it just affects the current request.

Parameters

string $key

Key that identifies the data.

protected persist(string $key, bool $persist = TRUE)

Flags an offset value to be written to the persistent cache.

Parameters

string $key

The key that was requested.

bool $persist

(optional) Whether the offset should be persisted or not, defaults to TRUE. When called with $persist = FALSE the offset will be unflagged so that it will not be written at the end of the request.

protected mixed resolveCacheMiss($offset)

Resolves a cache miss.

When an offset is not found in the object, this is treated as a cache miss. This method allows classes using this implementation to look up the actual value and allow it to be cached.

Parameters

$offset

Return Value

mixed

The value of the offset, or NULL if no value was found.

protected updateCache(bool $lock = TRUE)

Writes a value to the persistent cache immediately.

Parameters

bool $lock

(optional) Whether to acquire a lock before writing to cache. Defaults to TRUE.

protected string normalizeLockName(string $cid)

Normalizes a cache ID in order to comply with database limitations.

Parameters

string $cid

The passed in cache ID.

Return Value

string

An ASCII-encoded cache ID that is at most 255 characters long.

reset()

Resets the local cache.

Does not clear the persistent cache.

clear()

Clears the collected cache entry.

destruct()

Performs destruct operations.

protected lazyLoadCache()

Loads the cache if not already done.

protected invalidateCache()

Invalidate the cache.