class ConfigImporter

Defines a configuration importer.

A config importer imports the changes into the configuration system. To determine which changes to import a StorageComparer in used.

The ConfigImporter has a identifier which is used to construct event names. The events fired during an import are:

• ConfigEvents::IMPORT_VALIDATE: Events listening can throw a \Drupal\Core\Config\ConfigImporterException to prevent an import from occurring.
  • ConfigEvents::IMPORT: Events listening can react to a successful import.

Hierarchy

• class \Drupal\Core\Config\ConfigImporter uses DependencySerializationTrait, StringTranslationTrait

See also

\Drupal\Core\Config\StorageComparerInterface

\Drupal\Core\EventSubscriber\ConfigImportSubscriber

\Drupal\Core\EventSubscriber\ConfigSnapshotSubscriber

\Drupal\Core\Config\ConfigImporterEvent

File

core/lib/Drupal/Core/Config/ConfigImporter.php, line 36

Namespace

Drupal\Core\Config

Members

Name	Modifiers	Type	Description
ConfigImporter::$configManager	protected	property	The configuration manager.
ConfigImporter::$errors	protected	property	A log of any errors encountered.
ConfigImporter::$eventDispatcher	protected	property	The event dispatcher used to notify subscribers.
ConfigImporter::$extensionChangelist	protected	property	List of extension changes to be processed by the import().
ConfigImporter::$lock	protected	property	The used lock backend instance.
ConfigImporter::$moduleHandler	protected	property	The module handler.
ConfigImporter::$moduleInstaller	protected	property	The module installer.
ConfigImporter::$processedConfiguration	protected	property	List of configuration file changes processed by the import().
ConfigImporter::$processedExtensions	protected	property	List of extension changes processed by the import().
ConfigImporter::$processedSystemTheme	protected	property	Flag set to import system.theme during processing theme install and uninstalls.
ConfigImporter::$storageComparer	protected	property	The storage comparer used to discover configuration changes.
ConfigImporter::$themeHandler	protected	property	The theme handler.
ConfigImporter::$totalConfigurationToProcess	protected	property	The total number of configuration objects to process.
ConfigImporter::$totalExtensionsToProcess	protected	property	The total number of extensions to process.
ConfigImporter::$typedConfigManager	protected	property	The typed config manager.
ConfigImporter::$validated	protected	property	Indicates changes to import have been validated.
ConfigImporter::alreadyImporting	public	function	Determines if a import is already running.
ConfigImporter::checkOp	protected	function	Checks that the operation is still valid.
ConfigImporter::createExtensionChangelist	protected	function	Populates the extension change list.
ConfigImporter::doSyncStep	public	function	Calls a config import step.
ConfigImporter::finish	protected	function	Finishes the batch.
ConfigImporter::getEmptyExtensionsProcessedList	protected	function	Gets an empty list of extensions to process.
ConfigImporter::getErrors	public	function	Returns error messages created while running the import.
ConfigImporter::getExtensionChangelist	public	function	Gets a list changes for extensions.
ConfigImporter::getNextConfigurationOperation	protected	function	Gets the next configuration operation to perform.
ConfigImporter::getNextExtensionOperation	protected	function	Gets the next extension operation to perform.
ConfigImporter::getProcessedConfiguration	public	function	Gets list of processed changes.
ConfigImporter::getProcessedExtensions	public	function	Gets list of processed extension changes.
ConfigImporter::getStorageComparer	public	function	Gets the configuration storage comparer.
ConfigImporter::getUnprocessedConfiguration	public	function	Gets a list of unprocessed changes for a given operation.
ConfigImporter::getUnprocessedExtensions	protected	function	Gets a list of unprocessed changes for extensions.
ConfigImporter::hasUnprocessedConfigurationChanges	public	function	Checks if there are any unprocessed configuration changes.
ConfigImporter::import	public	function	Imports the changelist to the target storage.
ConfigImporter::importConfig	protected	function	Writes a configuration change from the source to the target storage.
ConfigImporter::importInvokeOwner	protected	function	Invokes import* methods on configuration entity storage.
ConfigImporter::importInvokeRename	protected	function	Imports a configuration entity rename.
ConfigImporter::initialize	public	function	Initializes the config importer in preparation for processing a batch.
ConfigImporter::LOCK_NAME		constant	The name used to identify the lock.
ConfigImporter::logError	public	function	Logs an error message.
ConfigImporter::processConfiguration	protected	function	Processes a configuration change.
ConfigImporter::processConfigurations	protected	function	Processes configuration as a batch operation.
ConfigImporter::processExtension	protected	function	Processes an extension change.
ConfigImporter::processExtensions	protected	function	Processes extensions as a batch operation.
ConfigImporter::processMissingContent	protected	function	Handles processing of missing content.
ConfigImporter::reInjectMe	protected	function	Gets all the service dependencies from \Drupal.
ConfigImporter::reset	public	function	Resets the storage comparer and processed list.
ConfigImporter::setProcessedConfiguration	protected	function	Sets a change as processed.
ConfigImporter::setProcessedExtension	protected	function	Sets an extension change as processed.
ConfigImporter::validate	public	function	Dispatches validate event for a ConfigImporter object.
ConfigImporter::__construct	public	function	Constructs a configuration import object.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function
DependencySerializationTrait::__wakeup	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.