class ConfigInstaller

Defines a configuration installer.

A config installer imports the changes into the configuration system during module installs.

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

• 'config.installer.validate': Events listening can throw a \Drupal\Core\Config\ConfigImporterException to prevent an import from occurring.
  • 'config.installer.import': Events listening can react to a successful import.

Hierarchy

Expanded class hierarchy of ConfigInstaller

See also

\Drupal\Core\EventSubscriber\ConfigImportSubscriber

\Drupal\Core\Config\ConfigImporter

File

drupal/core/lib/Drupal/Core/Config/ConfigInstaller.php, line 26

Contains \Drupal\Core\Config\ConfigInstaller.

Namespace

class ConfigInstaller extends ConfigImporter {

  /**
   * The name used to identify events and the lock.
   */
  const ID = 'config.installer';

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
ConfigImporter::$configFactory	protected	property	The configuration factory.
ConfigImporter::$context	protected	property	The configuration context.
ConfigImporter::$entityManager	protected	property	The plugin manager for entities.
ConfigImporter::$eventDispatcher	protected	property	The event dispatcher used to notify subscribers.
ConfigImporter::$lock	protected	property	The used lock backend instance.
ConfigImporter::$processed	protected	property	List of changes processed by the import().
ConfigImporter::$storageComparer	protected	property	The storage comparer used to discover configuration changes.
ConfigImporter::$validated	protected	property	Indicates changes to import have been validated.
ConfigImporter::alreadyImporting	public	function	Determines if a import is already running.
ConfigImporter::getId	public	function	Returns the identifier for events and locks.
ConfigImporter::getProcessed	public	function	Gets list of processed changes.
ConfigImporter::getStorageComparer	public	function	Gets the configuration storage comparer.
ConfigImporter::getUnprocessed	public	function	Gets a list of unprocessed changes for a given operation.
ConfigImporter::hasUnprocessedChanges	public	function	Checks if there are any unprocessed changes.
ConfigImporter::import	public	function	Imports the changelist to the target storage.
ConfigImporter::importConfig	protected	function	Writes an array of config changes from the source to the target storage.
ConfigImporter::importInvokeOwner	protected	function	Invokes import* methods on configuration entity storage controllers.
ConfigImporter::notify	protected	function	Dispatches a config importer event.
ConfigImporter::reset	public	function	Resets the storage comparer and processed list.
ConfigImporter::setProcessed	protected	function	Sets a change as processed.
ConfigImporter::validate	public	function	Dispatches validate event for a ConfigImporter object.
ConfigImporter::__construct	public	function	Constructs a configuration import object.
ConfigInstaller::ID		constant	The name used to identify events and the lock. Overrides ConfigImporter::ID