You are here

public function FieldUninstallValidator::validate in Zircon Profile 8

Same name in this branch
  1. 8 core/modules/field/src/FieldUninstallValidator.php \Drupal\field\FieldUninstallValidator::validate()
  2. 8 core/modules/field/src/ProxyClass/FieldUninstallValidator.php \Drupal\field\ProxyClass\FieldUninstallValidator::validate()
Same name and namespace in other branches
  1. 8.0 core/modules/field/src/FieldUninstallValidator.php \Drupal\field\FieldUninstallValidator::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/modules/field/src/FieldUninstallValidator.php, line 45
Contains \Drupal\field\FieldUninstallValidator.

Class

FieldUninstallValidator
Prevents uninstallation of modules providing active field storage.

Namespace

Drupal\field

Code

public function validate($module) {
  $reasons = [];
  if ($field_storages = $this
    ->getFieldStoragesByModule($module)) {

    // Provide an explanation message (only mention pending deletions if there
    // remain no actual, non-deleted fields.)
    $non_deleted = FALSE;
    foreach ($field_storages as $field_storage) {
      if (!$field_storage
        ->isDeleted()) {
        $non_deleted = TRUE;
        break;
      }
    }
    if ($non_deleted) {
      $reasons[] = $this
        ->t('Fields type(s) in use');
    }
    else {
      $reasons[] = $this
        ->t('Fields pending deletion');
    }
  }
  return $reasons;
}