class ConfigImporterEvent

Same name in other branches
  1. 9 core/lib/Drupal/Core/Config/ConfigImporterEvent.php \Drupal\Core\Config\ConfigImporterEvent
  2. 10 core/lib/Drupal/Core/Config/ConfigImporterEvent.php \Drupal\Core\Config\ConfigImporterEvent
  3. 11.x core/lib/Drupal/Core/Config/ConfigImporterEvent.php \Drupal\Core\Config\ConfigImporterEvent

Hierarchy

Expanded class hierarchy of ConfigImporterEvent

7 files declare their use of ConfigImporterEvent
BundleConfigImportValidate.php in core/lib/Drupal/Core/Entity/Event/BundleConfigImportValidate.php
ConfigImportSubscriber.php in core/modules/content_moderation/src/EventSubscriber/ConfigImportSubscriber.php
ConfigImportSubscriber.php in core/lib/Drupal/Core/EventSubscriber/ConfigImportSubscriber.php
ConfigSnapshotSubscriber.php in core/lib/Drupal/Core/EventSubscriber/ConfigSnapshotSubscriber.php
ConfigSubscriber.php in core/modules/config/src/ConfigSubscriber.php

... See full list

File

core/lib/Drupal/Core/Config/ConfigImporterEvent.php, line 7

Namespace

Drupal\Core\Config
View source 
class ConfigImporterEvent extends Event {
    
    /**
     * Configuration import object.
     *
     * @var \Drupal\Core\Config\ConfigImporter
     */
    protected $configImporter;
    
    /**
     * Constructs ConfigImporterEvent.
     *
     * @param \Drupal\Core\Config\ConfigImporter $config_importer
     *   A config import object to notify listeners about.
     */
    public function __construct(ConfigImporter $config_importer) {
        $this->configImporter = $config_importer;
    }
    
    /**
     * Gets the config import object.
     *
     * @return \Drupal\Core\Config\ConfigImporter
     *   The ConfigImporter object.
     */
    public function getConfigImporter() {
        return $this->configImporter;
    }
    
    /**
     * Gets the list of changes that will be imported.
     *
     * @param string $op
     *   (optional) A change operation. Either delete, create or update. If
     *   supplied the returned list will be limited to this operation.
     * @param string $collection
     *   (optional) The collection to get the changelist for. Defaults to the
     *   default collection.
     *
     * @return array
     *   An array of config changes that are yet to be imported.
     *
     * @see \Drupal\Core\Config\StorageComparerInterface::getChangelist()
     */
    public function getChangelist($op = NULL, $collection = StorageInterface::DEFAULT_COLLECTION) {
        return $this->configImporter
            ->getStorageComparer()
            ->getChangelist($op, $collection);
    }

}

Members

Title Modifiers Object type Summary
ConfigImporterEvent::$configImporter protected property Configuration import object.
ConfigImporterEvent::getChangelist public function Gets the list of changes that will be imported.
ConfigImporterEvent::getConfigImporter public function Gets the config import object.
ConfigImporterEvent::__construct public function Constructs ConfigImporterEvent.

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