interface LanguageConfigFactoryOverrideInterface

Same name and namespace in other branches
  1. 10 core/modules/language/src/Config/LanguageConfigFactoryOverrideInterface.php \Drupal\language\Config\LanguageConfigFactoryOverrideInterface
  2. 11.x core/modules/language/src/Config/LanguageConfigFactoryOverrideInterface.php \Drupal\language\Config\LanguageConfigFactoryOverrideInterface
  3. 9 core/modules/language/src/Config/LanguageConfigFactoryOverrideInterface.php \Drupal\language\Config\LanguageConfigFactoryOverrideInterface
  4. 8.9.x core/modules/language/src/Config/LanguageConfigFactoryOverrideInterface.php \Drupal\language\Config\LanguageConfigFactoryOverrideInterface

Defines the interface for a configuration factory language override object.

Hierarchy

Expanded class hierarchy of LanguageConfigFactoryOverrideInterface

All classes that implement LanguageConfigFactoryOverrideInterface

2 files declare their use of LanguageConfigFactoryOverrideInterface
ConfigurableLanguageManager.php in core/modules/language/src/ConfigurableLanguageManager.php
ConfigurableLanguageManagerSwitchLinksTest.php in core/modules/language/tests/src/Unit/ConfigurableLanguageManagerSwitchLinksTest.php

File

core/modules/language/src/Config/LanguageConfigFactoryOverrideInterface.php, line 11

Namespace

Drupal\language\Config
View source
interface LanguageConfigFactoryOverrideInterface extends ConfigFactoryOverrideInterface {
  
  /**
   * Gets the language object used to override configuration data.
   *
   * @return \Drupal\Core\Language\LanguageInterface
   *   The language object used to override configuration data.
   */
  public function getLanguage();
  
  /**
   * Sets the language to be used in configuration overrides.
   *
   * @param \Drupal\Core\Language\LanguageInterface $language
   *   The language object used to override configuration data.
   *
   * @return $this
   */
  public function setLanguage(?LanguageInterface $language = NULL);
  
  /**
   * Gets the language override for a language and configuration name.
   *
   * An empty object is returned when there is no override data for the given
   * language code and configuration object. This includes cases where:
   * - The configuration has no override for that language.
   * - The given language is not installed or does not exist.
   * - The configuration name is not an existing configuration object.
   *
   * @param string $langcode
   *   The language code for the override.
   * @param string $name
   *   The name of the configuration object.
   *
   * @return \Drupal\language\Config\LanguageConfigOverride
   *   The language config override object for the requested language and
   *   configuration object.
   */
  public function getOverride($langcode, $name);
  
  /**
   * Returns the storage instance for a particular langcode.
   *
   * @param string $langcode
   *   Language code.
   *
   * @return \Drupal\Core\Config\StorageInterface
   *   The storage instance for a particular langcode.
   */
  public function getStorage($langcode);
  
  /**
   * Installs available language configuration overrides for a given langcode.
   *
   * @param string $langcode
   *   Language code.
   */
  public function installLanguageOverrides($langcode);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
ConfigFactoryOverrideInterface::createConfigObject public function Creates a configuration object for use during install and synchronization. 9
ConfigFactoryOverrideInterface::getCacheableMetadata public function Gets the cacheability metadata associated with the config factory override. 9
ConfigFactoryOverrideInterface::getCacheSuffix public function The string to append to the configuration static cache name. 9
ConfigFactoryOverrideInterface::loadOverrides public function Returns config overrides. 9
LanguageConfigFactoryOverrideInterface::getLanguage public function Gets the language object used to override configuration data. 1
LanguageConfigFactoryOverrideInterface::getOverride public function Gets the language override for a language and configuration name. 1
LanguageConfigFactoryOverrideInterface::getStorage public function Returns the storage instance for a particular langcode. 1
LanguageConfigFactoryOverrideInterface::installLanguageOverrides public function Installs available language configuration overrides for a given langcode. 1
LanguageConfigFactoryOverrideInterface::setLanguage public function Sets the language to be used in configuration overrides. 1

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