public function RequiredModuleUninstallValidator::validate in Zircon Profile 8

Same name in this branch

1. 8 core/lib/Drupal/Core/Extension/RequiredModuleUninstallValidator.php \Drupal\Core\Extension\RequiredModuleUninstallValidator::validate()
2. 8 core/lib/Drupal/Core/ProxyClass/Extension/RequiredModuleUninstallValidator.php \Drupal\Core\ProxyClass\Extension\RequiredModuleUninstallValidator::validate()

Same name and namespace in other branches

1. 8.0 core/lib/Drupal/Core/Extension/RequiredModuleUninstallValidator.php \Drupal\Core\Extension\RequiredModuleUninstallValidator::validate()

Determines the reasons a module can not be uninstalled.

Example implementation:

public function validate($module) {
  $entity_types = $this->entityManager->getDefinitions();
  $reasons = array();
  foreach ($entity_types as $entity_type) {
    if ($module == $entity_type->getProvider() && $entity_type instanceof ContentEntityTypeInterface && $this->entityManager->getStorage($entity_type->id())->hasData()) {
      $reasons[] = $this->t('There is content for the entity type: @entity_type', array('@entity_type' => $entity_type->getLabel()));
    }
  }
  return $reasons;
}

Parameters

string $module: A module name.

Return value

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.

Overrides ModuleUninstallValidatorInterface::validate

See also

template_preprocess_system_modules_uninstall()

File

core/lib/Drupal/Core/Extension/RequiredModuleUninstallValidator.php, line 33

Contains \Drupal\Core\Extension\RequiredModuleUninstallValidator.

Class

RequiredModuleUninstallValidator

Ensures that required modules cannot be uninstalled.

Namespace

Drupal\Core\Extension

Code

public function validate($module) {
  $reasons = [];
  $module_info = $this
    ->getModuleInfoByModule($module);
  if (!empty($module_info['required'])) {
    $reasons[] = $this
      ->t('The @module module is required', [
      '@module' => $module_info['name'],
    ]);
  }
  return $reasons;
}