interface ConfigImportModuleUninstallValidatorInterface in Drupal 10

Special interface for module uninstall validators for configuration import.

A module uninstall validator that needs different functionality prior to a configuration import should implement this interface and be defined in a Drupal service that is tagged module_install.uninstall_validator.

Hierarchy

• interface \Drupal\Core\Extension\ModuleUninstallValidatorInterface
  • interface \Drupal\Core\Extension\ConfigImportModuleUninstallValidatorInterface

2 files declare their use of ConfigImportModuleUninstallValidatorInterface

ConfigImportSubscriber.php in core/lib/Drupal/Core/EventSubscriber/ConfigImportSubscriber.php

FieldUninstallValidator.php in core/modules/field/src/FieldUninstallValidator.php

File

core/lib/Drupal/Core/Extension/ConfigImportModuleUninstallValidatorInterface.php, line 15

Namespace

Drupal\Core\Extension

interface ConfigImportModuleUninstallValidatorInterface extends ModuleUninstallValidatorInterface {

  /**
   * Determines reasons a module can not be uninstalled prior to config import.
   *
   * @param string $module
   *   A module name.
   * @param \Drupal\Core\Config\StorageInterface $source_storage
   *   Storage object used to read configuration that is about to be imported.
   *
   * @return string[]
   *   An array of reasons the module can not be uninstalled, empty if it can.
   *   Each reason should not end with any punctuation since multiple reasons
   *   can be displayed together.
   *
   * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber::validateModules()
   */
  public function validateConfigImport(string $module, StorageInterface $source_storage) : array;

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigImportModuleUninstallValidatorInterface::validateConfigImport	public	function	Determines reasons a module can not be uninstalled prior to config import.	3
ModuleUninstallValidatorInterface::validate	public	function	Determines the reasons a module can not be uninstalled.	9