class ConfigSnapshotSubscriber

Same name in other branches
  1. 9 core/lib/Drupal/Core/EventSubscriber/ConfigSnapshotSubscriber.php \Drupal\Core\EventSubscriber\ConfigSnapshotSubscriber
  2. 8.9.x core/lib/Drupal/Core/EventSubscriber/ConfigSnapshotSubscriber.php \Drupal\Core\EventSubscriber\ConfigSnapshotSubscriber
  3. 10 core/lib/Drupal/Core/EventSubscriber/ConfigSnapshotSubscriber.php \Drupal\Core\EventSubscriber\ConfigSnapshotSubscriber

Create a snapshot when config is imported.

Hierarchy

  • class \Drupal\Core\EventSubscriber\ConfigSnapshotSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

Expanded class hierarchy of ConfigSnapshotSubscriber

File

core/lib/Drupal/Core/EventSubscriber/ConfigSnapshotSubscriber.php, line 14

Namespace

Drupal\Core\EventSubscriber
View source 
class ConfigSnapshotSubscriber implements EventSubscriberInterface {
    
    /**
     * The configuration manager.
     *
     * @var \Drupal\Core\Config\ConfigManagerInterface
     */
    protected $configManager;
    
    /**
     * The source storage used to discover configuration changes.
     *
     * @var \Drupal\Core\Config\StorageInterface
     */
    protected $sourceStorage;
    
    /**
     * The snapshot storage used to write configuration changes.
     *
     * @var \Drupal\Core\Config\StorageInterface
     */
    protected $snapshotStorage;
    
    /**
     * Constructs the ConfigSnapshotSubscriber object.
     *
     * @param \Drupal\Core\Config\ConfigManagerInterface $config_manager
     *   The configuration manager.
     * @param \Drupal\Core\Config\StorageInterface $source_storage
     *   The source storage used to discover configuration changes.
     * @param \Drupal\Core\Config\StorageInterface $snapshot_storage
     *   The snapshot storage used to write configuration changes.
     */
    public function __construct(ConfigManagerInterface $config_manager, StorageInterface $source_storage, StorageInterface $snapshot_storage) {
        $this->configManager = $config_manager;
        $this->sourceStorage = $source_storage;
        $this->snapshotStorage = $snapshot_storage;
    }
    
    /**
     * Creates a config snapshot.
     *
     * @param \Drupal\Core\Config\ConfigImporterEvent $event
     *   The Event to process.
     */
    public function onConfigImporterImport(ConfigImporterEvent $event) {
        $this->configManager
            ->createSnapshot($this->sourceStorage, $this->snapshotStorage);
    }
    
    /**
     * Registers the methods in this class that should be listeners.
     *
     * @return array
     *   An array of event listener definitions.
     */
    public static function getSubscribedEvents() : array {
        $events[ConfigEvents::IMPORT][] = [
            'onConfigImporterImport',
            40,
        ];
        return $events;
    }

}

Members

Title Modifiers Object type Summary
ConfigSnapshotSubscriber::$configManager protected property The configuration manager.
ConfigSnapshotSubscriber::$snapshotStorage protected property The snapshot storage used to write configuration changes.
ConfigSnapshotSubscriber::$sourceStorage protected property The source storage used to discover configuration changes.
ConfigSnapshotSubscriber::getSubscribedEvents public static function Registers the methods in this class that should be listeners.
ConfigSnapshotSubscriber::onConfigImporterImport public function Creates a config snapshot.
ConfigSnapshotSubscriber::__construct public function Constructs the ConfigSnapshotSubscriber object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.