interface LanguageConfigFactoryOverrideInterface

Same name and namespace in other branches
  1. 9 core/modules/language/src/Config/LanguageConfigFactoryOverrideInterface.php \Drupal\language\Config\LanguageConfigFactoryOverrideInterface
  2. 10 core/modules/language/src/Config/LanguageConfigFactoryOverrideInterface.php \Drupal\language\Config\LanguageConfigFactoryOverrideInterface
  3. 11.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

1 file declares its use of LanguageConfigFactoryOverrideInterface
ConfigurableLanguageManager.php in core/modules/language/src/ConfigurableLanguageManager.php

File

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

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);
    
    /**
     * Sets the language to be used in configuration overrides from the default.
     *
     * @param \Drupal\Core\Language\LanguageDefault $language_default
     *   The default language.
     *
     * @return $this
     *
     * @deprecated in drupal:8.3.0 and is removed from drupal:9.0.0. This
     *   method has been replaced by injecting the default language into the
     *   constructor.
     */
    public function setLanguageFromDefault(LanguageDefault $language_default = NULL);
    
    /**
     * Get language override for given language and configuration name.
     *
     * @param string $langcode
     *   Language code.
     * @param string $name
     *   Configuration name.
     *
     * @return \Drupal\Core\Config\Config
     *   Configuration override 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 Deprecated Modifiers Object type Summary Overrides
ConfigFactoryOverrideInterface::createConfigObject public function Creates a configuration object for use during install and synchronization. 8
ConfigFactoryOverrideInterface::getCacheableMetadata public function Gets the cacheability metadata associated with the config factory override. 8
ConfigFactoryOverrideInterface::getCacheSuffix public function The string to append to the configuration static cache name. 8
ConfigFactoryOverrideInterface::loadOverrides public function Returns config overrides. 8
LanguageConfigFactoryOverrideInterface::getLanguage public function Gets the language object used to override configuration data. 1
LanguageConfigFactoryOverrideInterface::getOverride public function Get language override for given 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
LanguageConfigFactoryOverrideInterface::setLanguageFromDefault Deprecated public function Sets the language to be used in configuration overrides from the default. 1

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