Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Core/Config/ConfigEvents.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Core/Config/ConfigEvents.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,146 @@ +<?php + +namespace Drupal\Core\Config; + +/** + * Defines events for the configuration system. + * + * @see \Drupal\Core\Config\ConfigCrudEvent + */ +final class ConfigEvents { + + /** + * Name of the event fired when saving a configuration object. + * + * This event allows modules to perform an action whenever a configuration + * object is saved. The event listener method receives a + * \Drupal\Core\Config\ConfigCrudEvent instance. + * + * See hook_update_N() documentation for safe configuration API usage and + * restrictions as this event will be fired when configuration is saved by + * hook_update_N(). + * + * @Event + * + * @see \Drupal\Core\Config\ConfigCrudEvent + * @see \Drupal\Core\Config\Config::save() + * @see \Drupal\Core\Config\ConfigFactory::onConfigSave() + * @see hook_update_N() + * + * @var string + */ + const SAVE = 'config.save'; + + /** + * Name of the event fired when deleting a configuration object. + * + * This event allows modules to perform an action whenever a configuration + * object is deleted. The event listener method receives a + * \Drupal\Core\Config\ConfigCrudEvent instance. + * + * See hook_update_N() documentation for safe configuration API usage and + * restrictions as this event will be fired when configuration is deleted by + * hook_update_N(). + * + * @Event + * + * @see \Drupal\Core\Config\ConfigCrudEvent + * @see \Drupal\Core\Config\Config::delete() + * @see \Drupal\Core\Config\ConfigFactory::onConfigDelete() + * @see hook_update_N() + * + * @var string + */ + const DELETE = 'config.delete'; + + /** + * Name of the event fired when renaming a configuration object. + * + * This event allows modules to perform an action whenever a configuration + * object's name is changed. The event listener method receives a + * \Drupal\Core\Config\ConfigRenameEvent instance. + * + * See hook_update_N() documentation for safe configuration API usage and + * restrictions as this event will be fired when configuration is renamed by + * hook_update_N(). + * + * @Event + * + * @see \Drupal\Core\Config\ConfigRenameEvent + * @see \Drupal\Core\Config\ConfigFactoryInterface::rename() + * @see hook_update_N() + * + * @var string + */ + const RENAME = 'config.rename'; + + /** + * Name of the event fired when validating imported configuration. + * + * This event allows modules to perform additional validation operations when + * configuration is being imported. The event listener method receives a + * \Drupal\Core\Config\ConfigImporterEvent instance. + * + * @Event + * + * @see \Drupal\Core\Config\ConfigImporterEvent + * @see \Drupal\Core\Config\ConfigImporter::validate(). + * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber::onConfigImporterValidate(). + * + * @var string + */ + const IMPORT_VALIDATE = 'config.importer.validate'; + + /** + * Name of the event fired when importing configuration to target storage. + * + * This event allows modules to perform additional actions when configuration + * is imported. The event listener method receives a + * \Drupal\Core\Config\ConfigImporterEvent instance. + * + * @Event + * + * @see \Drupal\Core\Config\ConfigImporterEvent + * @see \Drupal\Core\Config\ConfigImporter::import(). + * @see \Drupal\Core\EventSubscriber\ConfigSnapshotSubscriber::onConfigImporterImport(). + * + * @var string + */ + const IMPORT = 'config.importer.import'; + + /** + * Name of event fired when missing content dependencies are detected. + * + * Events subscribers are fired as part of the configuration import batch. + * Each subscribe should call + * \Drupal\Core\Config\MissingContentEvent::resolveMissingContent() when they + * address a missing dependency. To address large amounts of dependencies + * subscribers can call + * \Drupal\Core\Config\MissingContentEvent::stopPropagation() which will stop + * calling other events and guarantee that the configuration import batch will + * fire the event again to continue processing missing content dependencies. + * + * @see \Drupal\Core\Config\ConfigImporter::processMissingContent() + * @see \Drupal\Core\Config\MissingContentEvent + */ + const IMPORT_MISSING_CONTENT = 'config.importer.missing_content'; + + /** + * Name of event fired to collect information on all config collections. + * + * This event allows modules to add to the list of configuration collections + * retrieved by \Drupal\Core\Config\ConfigManager::getConfigCollectionInfo(). + * The event listener method receives a + * \Drupal\Core\Config\ConfigCollectionInfo instance. + * + * @Event + * + * @see \Drupal\Core\Config\ConfigCollectionInfo + * @see \Drupal\Core\Config\ConfigManager::getConfigCollectionInfo() + * @see \Drupal\Core\Config\ConfigFactoryOverrideBase + * + * @var string + */ + const COLLECTION_INFO = 'config.collection_info'; + +}