annotate core/modules/language/src/Config/LanguageConfigFactoryOverrideInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\language\Config;
Chris@0 4
Chris@0 5 use Drupal\Core\Config\ConfigFactoryOverrideInterface;
Chris@0 6 use Drupal\Core\Language\LanguageInterface;
Chris@0 7 use Drupal\Core\Language\LanguageDefault;
Chris@0 8
Chris@0 9 /**
Chris@0 10 * Defines the interface for a configuration factory language override object.
Chris@0 11 */
Chris@0 12 interface LanguageConfigFactoryOverrideInterface extends ConfigFactoryOverrideInterface {
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Gets the language object used to override configuration data.
Chris@0 16 *
Chris@0 17 * @return \Drupal\Core\Language\LanguageInterface
Chris@0 18 * The language object used to override configuration data.
Chris@0 19 */
Chris@0 20 public function getLanguage();
Chris@0 21
Chris@0 22 /**
Chris@0 23 * Sets the language to be used in configuration overrides.
Chris@0 24 *
Chris@0 25 * @param \Drupal\Core\Language\LanguageInterface $language
Chris@0 26 * The language object used to override configuration data.
Chris@0 27 *
Chris@0 28 * @return $this
Chris@0 29 */
Chris@0 30 public function setLanguage(LanguageInterface $language = NULL);
Chris@0 31
Chris@0 32 /**
Chris@0 33 * Sets the language to be used in configuration overrides from the default.
Chris@0 34 *
Chris@0 35 * @param \Drupal\Core\Language\LanguageDefault $language_default
Chris@0 36 * The default language.
Chris@0 37 *
Chris@0 38 * @return $this
Chris@0 39 *
Chris@0 40 * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0. This
Chris@0 41 * method has been replaced by injecting the default language into the
Chris@0 42 * constructor.
Chris@0 43 */
Chris@0 44 public function setLanguageFromDefault(LanguageDefault $language_default = NULL);
Chris@0 45
Chris@0 46 /**
Chris@0 47 * Get language override for given language and configuration name.
Chris@0 48 *
Chris@0 49 * @param string $langcode
Chris@0 50 * Language code.
Chris@0 51 * @param string $name
Chris@0 52 * Configuration name.
Chris@0 53 *
Chris@0 54 * @return \Drupal\Core\Config\Config
Chris@0 55 * Configuration override object.
Chris@0 56 */
Chris@0 57 public function getOverride($langcode, $name);
Chris@0 58
Chris@0 59 /**
Chris@0 60 * Returns the storage instance for a particular langcode.
Chris@0 61 *
Chris@0 62 * @param string $langcode
Chris@0 63 * Language code.
Chris@0 64 *
Chris@0 65 * @return \Drupal\Core\Config\StorageInterface
Chris@0 66 * The storage instance for a particular langcode.
Chris@0 67 */
Chris@0 68 public function getStorage($langcode);
Chris@0 69
Chris@0 70 /**
Chris@0 71 * Installs available language configuration overrides for a given langcode.
Chris@0 72 *
Chris@0 73 * @param string $langcode
Chris@0 74 * Language code.
Chris@0 75 */
Chris@0 76 public function installLanguageOverrides($langcode);
Chris@0 77
Chris@0 78 }