interface ImportableEntityStorageInterface

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

Provides an interface for responding to configuration imports.

When configuration is synchronized between storages, the entity storage must handle the synchronization of configuration data for its entity.

Hierarchy

Expanded class hierarchy of ImportableEntityStorageInterface

All classes that implement ImportableEntityStorageInterface

1 file declares its use of ImportableEntityStorageInterface
ConfigImporter.php in core/lib/Drupal/Core/Config/ConfigImporter.php

File

core/lib/Drupal/Core/Config/Entity/ImportableEntityStorageInterface.php, line 13

Namespace

Drupal\Core\Config\Entity
View source 
interface ImportableEntityStorageInterface {
    
    /**
     * Creates entities upon synchronizing configuration changes.
     *
     * @param string $name
     *   The name of the configuration object.
     * @param \Drupal\Core\Config\Config $new_config
     *   A configuration object containing the new configuration data.
     * @param \Drupal\Core\Config\Config $old_config
     *   A configuration object containing the old configuration data.
     */
    public function importCreate($name, Config $new_config, Config $old_config);
    
    /**
     * Updates entities upon synchronizing configuration changes.
     *
     * @param string $name
     *   The name of the configuration object.
     * @param \Drupal\Core\Config\Config $new_config
     *   A configuration object containing the new configuration data.
     * @param \Drupal\Core\Config\Config $old_config
     *   A configuration object containing the old configuration data.
     *
     * @throws \Drupal\Core\Config\ConfigImporterException
     *   Thrown when the config entity that should be updated can not be found.
     */
    public function importUpdate($name, Config $new_config, Config $old_config);
    
    /**
     * Delete entities upon synchronizing configuration changes.
     *
     * @param string $name
     *   The name of the configuration object.
     * @param \Drupal\Core\Config\Config $new_config
     *   A configuration object containing the new configuration data.
     * @param \Drupal\Core\Config\Config $old_config
     *   A configuration object containing the old configuration data.
     */
    public function importDelete($name, Config $new_config, Config $old_config);
    
    /**
     * Renames entities upon synchronizing configuration changes.
     *
     * @param string $old_name
     *   The original name of the configuration object.
     * @param \Drupal\Core\Config\Config $new_config
     *   A configuration object containing the new configuration data.
     * @param \Drupal\Core\Config\Config $old_config
     *   A configuration object containing the old configuration data.
     */
    public function importRename($old_name, Config $new_config, Config $old_config);

}

Members

Title Modifiers Object type Summary Overrides
ImportableEntityStorageInterface::importCreate public function Creates entities upon synchronizing configuration changes. 1
ImportableEntityStorageInterface::importDelete public function Delete entities upon synchronizing configuration changes. 1
ImportableEntityStorageInterface::importRename public function Renames entities upon synchronizing configuration changes. 1
ImportableEntityStorageInterface::importUpdate public function Updates entities upon synchronizing configuration changes. 1

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