Same name in other branches

1. 9 core/lib/Drupal/Core/Config/ConfigFactoryOverrideInterface.php \Drupal\Core\Config\ConfigFactoryOverrideInterface::createConfigObject()
2. 8.9.x core/lib/Drupal/Core/Config/ConfigFactoryOverrideInterface.php \Drupal\Core\Config\ConfigFactoryOverrideInterface::createConfigObject()
3. 10 core/lib/Drupal/Core/Config/ConfigFactoryOverrideInterface.php \Drupal\Core\Config\ConfigFactoryOverrideInterface::createConfigObject()

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\ConfigCollectionEvents::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. Additionally, the overrider's implementation should trigger the appropriate event:

• Saving and creating triggers ConfigCollectionEvents::SAVE_IN_COLLECTION.
• Deleting triggers ConfigCollectionEvents::DELETE_IN_COLLECTION.
• Renaming triggers ConfigCollectionEvents::RENAME_IN_COLLECTION.

Parameters

string $name: The configuration object name.

string $collection: The configuration collection.

Return value

\Drupal\Core\Config\StorableConfigBase|null The configuration object for the provided name and collection. NULL should be returned when the overrider does not use configuration collections. For example: a module that provides an overrider to avoid storing API keys in config would not use collections.

See also

\Drupal\Core\Config\ConfigCollectionInfo

\Drupal\Core\Config\ConfigImporter::importConfig()

\Drupal\Core\Config\ConfigInstaller::createConfiguration()

\Drupal\Core\Config\ConfigCollectionEvents::SAVE_IN_COLLECTION

\Drupal\Core\Config\ConfigCollectionEvents::DELETE_IN_COLLECTION

\Drupal\Core\Config\ConfigCollectionEvents::RENAME_IN_COLLECTION

File

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

Class

ConfigFactoryOverrideInterface

Defines the interface for a configuration factory override object.

Namespace

Drupal\Core\Config

Code

public function createConfigObject($name, $collection = StorageInterface::DEFAULT_COLLECTION);

---