LanguagesCacheContext.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Cache/Context/LanguagesCacheContext.php
  2. 8.9.x core/lib/Drupal/Core/Cache/Context/LanguagesCacheContext.php
  3. 10 core/lib/Drupal/Core/Cache/Context/LanguagesCacheContext.php

Namespace

Drupal\Core\Cache\Context

File

core/lib/Drupal/Core/Cache/Context/LanguagesCacheContext.php

View source
<?php

namespace Drupal\Core\Cache\Context;

use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Language\LanguageManagerInterface;

/**
 * Defines the LanguagesCacheContext service, for "per language" caching.
 */
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();
    }

}

Classes

Title Deprecated Summary
LanguagesCacheContext Defines the LanguagesCacheContext service, for "per language" caching.

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