interface ConfigFactoryOverrideInterface in Drupal 9

Defines the interface for a configuration factory override object.

Hierarchy

• interface \Drupal\Core\Config\ConfigFactoryOverrideInterface

8 files declare their use of ConfigFactoryOverrideInterface

CacheabilityMetadataConfigOverride.php in core/modules/config/tests/config_override_integration_test/src/CacheabilityMetadataConfigOverride.php

ConfigOverride.php in core/lib/Drupal/Core/Installer/ConfigOverride.php

ConfigOverrider.php in core/modules/config/tests/config_entity_static_cache_test/src/ConfigOverrider.php

ConfigOverrider.php in core/modules/config/tests/config_override_test/src/ConfigOverrider.php

ConfigOverrider.php in core/modules/settings_tray/tests/modules/settings_tray_override_test/src/ConfigOverrider.php

... See full list

File

core/lib/Drupal/Core/Config/ConfigFactoryOverrideInterface.php, line 8

Namespace

Drupal\Core\Config

interface ConfigFactoryOverrideInterface {

  /**
   * Returns config overrides.
   *
   * @param array $names
   *   A list of configuration names that are being loaded.
   *
   * @return array
   *   An array keyed by configuration name of override data. Override data
   *   contains a nested array structure of overrides.
   */
  public function loadOverrides($names);

  /**
   * The string to append to the configuration static cache name.
   *
   * @return string
   *   A string to append to the configuration static cache name.
   */
  public function getCacheSuffix();

  /**
   * Creates a configuration object for use during install and synchronization.
   *
   * If the overrider stores its overrides in configuration collections then
   * it can have its own implementation of
   * \Drupal\Core\Config\StorableConfigBase. Configuration overriders can link
   * themselves to a configuration collection by listening to the
   * \Drupal\Core\Config\ConfigEvents::COLLECTION_INFO event and adding the
   * collections they are responsible for. Doing this will allow installation
   * and synchronization to use the overrider's implementation of
   * StorableConfigBase.
   *
   * @see \Drupal\Core\Config\ConfigCollectionInfo
   * @see \Drupal\Core\Config\ConfigImporter::importConfig()
   * @see \Drupal\Core\Config\ConfigInstaller::createConfiguration()
   *
   * @param string $name
   *   The configuration object name.
   * @param string $collection
   *   The configuration collection.
   *
   * @return \Drupal\Core\Config\StorableConfigBase
   *   The configuration object for the provided name and collection.
   */
  public function createConfigObject($name, $collection = StorageInterface::DEFAULT_COLLECTION);

  /**
   * Gets the cacheability metadata associated with the config factory override.
   *
   * @param string $name
   *   The name of the configuration override to get metadata for.
   *
   * @return \Drupal\Core\Cache\CacheableMetadata
   *   A cacheable metadata object.
   */
  public function getCacheableMetadata($name);

}

Members

Name	Modifiers	Type	Description	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