class LanguagesCacheContext in Drupal 10
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Cache/Context/LanguagesCacheContext.php \Drupal\Core\Cache\Context\LanguagesCacheContext
- 9 core/lib/Drupal/Core/Cache/Context/LanguagesCacheContext.php \Drupal\Core\Cache\Context\LanguagesCacheContext
Defines the LanguagesCacheContext service, for "per language" caching.
Hierarchy
- class \Drupal\Core\Cache\Context\LanguagesCacheContext implements CalculatedCacheContextInterface
Expanded class hierarchy of LanguagesCacheContext
1 string reference to 'LanguagesCacheContext'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses LanguagesCacheContext
File
- core/
lib/ Drupal/ Core/ Cache/ Context/ LanguagesCacheContext.php, line 11
Namespace
Drupal\Core\Cache\ContextView source
class LanguagesCacheContext implements CalculatedCacheContextInterface {
/**
* The language manager.
*
* @var \Drupal\Core\Language\LanguageManagerInterface
*/
protected $languageManager;
/**
* Constructs a new LanguagesCacheContext service.
*
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
*/
public function __construct(LanguageManagerInterface $language_manager) {
$this->languageManager = $language_manager;
}
/**
* {@inheritdoc}
*/
public static function getLabel() {
return t('Language');
}
/**
* {@inheritdoc}
*
* $type can be NULL, or one of the language types supported by the language
* manager, typically:
* - LanguageInterface::TYPE_INTERFACE
* - LanguageInterface::TYPE_CONTENT
* - LanguageInterface::TYPE_URL
*
* @see \Drupal\Core\Language\LanguageManagerInterface::getLanguageTypes()
*
* @throws \RuntimeException
* In case an invalid language type is specified.
*/
public function getContext($type = NULL) {
if ($type === NULL) {
$context_parts = [];
if ($this->languageManager
->isMultilingual()) {
foreach ($this->languageManager
->getLanguageTypes() as $type) {
$context_parts[] = $this->languageManager
->getCurrentLanguage($type)
->getId();
}
}
else {
$context_parts[] = $this->languageManager
->getCurrentLanguage()
->getId();
}
return implode(',', $context_parts);
}
else {
$language_types = $this->languageManager
->getDefinedLanguageTypesInfo();
if (!isset($language_types[$type])) {
throw new \RuntimeException(sprintf('The language type "%s" is invalid.', $type));
}
return $this->languageManager
->getCurrentLanguage($type)
->getId();
}
}
/**
* {@inheritdoc}
*/
public function getCacheableMetadata($type = NULL) {
return new CacheableMetadata();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
LanguagesCacheContext:: |
protected | property | The language manager. | |
LanguagesCacheContext:: |
public | function |
Gets the cacheability metadata for the context based on the parameter value. Overrides CalculatedCacheContextInterface:: |
|
LanguagesCacheContext:: |
public | function |
$type can be NULL, or one of the language types supported by the language
manager, typically: Overrides CalculatedCacheContextInterface:: |
|
LanguagesCacheContext:: |
public static | function |
Returns the label of the cache context. Overrides CalculatedCacheContextInterface:: |
|
LanguagesCacheContext:: |
public | function | Constructs a new LanguagesCacheContext service. |