You are here

public function ConfigFactoryOverrideInterface::createConfigObject in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Config/ConfigFactoryOverrideInterface.php \Drupal\Core\Config\ConfigFactoryOverrideInterface::createConfigObject()
  2. 9 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\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.

Parameters

string $name: The configuration object name.

string $collection: The configuration collection.

Return value

\Drupal\Core\Config\StorableConfigBase The configuration object for the provided name and collection.

See also

\Drupal\Core\Config\ConfigCollectionInfo

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

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

2 methods override ConfigFactoryOverrideInterface::createConfigObject()
ConfigOverrider::createConfigObject in core/modules/settings_tray/tests/modules/settings_tray_override_test/src/ConfigOverrider.php
Creates a configuration object for use during install and synchronization.
LanguageConfigFactoryOverride::createConfigObject in core/modules/language/src/Config/LanguageConfigFactoryOverride.php
Creates a configuration object for use during install and synchronization.

File

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

Class

ConfigFactoryOverrideInterface
Defines the interface for a configuration factory override object.

Namespace

Drupal\Core\Config

Code

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