function FieldUninstallValidator::validate

Same name in this branch
  1. 11.x core/modules/field/src/ProxyClass/FieldUninstallValidator.php \Drupal\field\ProxyClass\FieldUninstallValidator::validate()
Same name in other branches
  1. 9 core/modules/field/src/ProxyClass/FieldUninstallValidator.php \Drupal\field\ProxyClass\FieldUninstallValidator::validate()
  2. 9 core/modules/field/src/FieldUninstallValidator.php \Drupal\field\FieldUninstallValidator::validate()
  3. 8.9.x core/modules/field/src/ProxyClass/FieldUninstallValidator.php \Drupal\field\ProxyClass\FieldUninstallValidator::validate()
  4. 8.9.x core/modules/field/src/FieldUninstallValidator.php \Drupal\field\FieldUninstallValidator::validate()
  5. 10 core/modules/field/src/ProxyClass/FieldUninstallValidator.php \Drupal\field\ProxyClass\FieldUninstallValidator::validate()
  6. 10 core/modules/field/src/FieldUninstallValidator.php \Drupal\field\FieldUninstallValidator::validate()

Overrides ModuleUninstallValidatorInterface::validate

File

core/modules/field/src/FieldUninstallValidator.php, line 52

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.)
        $fields_in_use = [];
        foreach ($field_storages as $field_storage) {
            if (!$field_storage->isDeleted()) {
                $fields_in_use[$field_storage->getType()][] = $field_storage->getLabel();
            }
        }
        if (!empty($fields_in_use)) {
            foreach ($fields_in_use as $field_type => $field_storages) {
                $field_type_label = $this->getFieldTypeLabel($field_type);
                $reasons[] = $this->formatPlural(count($fields_in_use[$field_type]), 'The %field_type_label field type is used in the following field: @fields', 'The %field_type_label field type is used in the following fields: @fields', [
                    '%field_type_label' => $field_type_label,
                    '@fields' => implode(', ', $field_storages),
                ]);
            }
        }
        else {
            $reasons[] = $this->t('Fields pending deletion');
        }
    }
    return $reasons;
}

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