FieldUninstallValidator.php 3.48 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Contains \Drupal\field\FieldUninstallValidator.
 */

namespace Drupal\field;

10
use Drupal\Core\Entity\EntityTypeManagerInterface;
11
use Drupal\Core\Extension\ModuleUninstallValidatorInterface;
12
use Drupal\Core\Field\FieldTypePluginManagerInterface;
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\StringTranslation\TranslationInterface;

/**
 * Prevents uninstallation of modules providing active field storage.
 */
class FieldUninstallValidator implements ModuleUninstallValidatorInterface {

  use StringTranslationTrait;

  /**
   * The field storage config storage.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
   */
  protected $fieldStorageConfigStorage;

30 31 32 33 34 35 36
  /**
   * The field type plugin manager.
   *
   * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
   */
  protected $fieldTypeManager;

37 38 39
  /**
   * Constructs a new FieldUninstallValidator.
   *
40
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
41 42 43
   *   The entity manager.
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
   *   The string translation service.
44 45
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
   *   The field type plugin manager.
46
   */
47 48
  public function __construct(EntityTypeManagerInterface $entity_type_manager, TranslationInterface $string_translation, FieldTypePluginManagerInterface $field_type_manager) {
    $this->fieldStorageConfigStorage = $entity_type_manager->getStorage('field_storage_config');
49
    $this->stringTranslation = $string_translation;
50
    $this->fieldTypeManager = $field_type_manager;
51 52 53 54 55 56 57 58 59 60
  }

  /**
   * {@inheritdoc}
   */
  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.)
61
      $fields_in_use = [];
62 63
      foreach ($field_storages as $field_storage) {
        if (!$field_storage->isDeleted()) {
64
          $fields_in_use[$field_storage->getType()][] = $field_storage->getLabel();
65 66
        }
      }
67 68 69 70 71
      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)]);
        }
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
      }
      else {
        $reasons[] = $this->t('Fields pending deletion');
      }
    }
    return $reasons;
  }

  /**
   * Returns all field storages for a specified module.
   *
   * @param string $module
   *   The module to filter field storages by.
   *
   * @return \Drupal\field\FieldStorageConfigInterface[]
   *   An array of field storages for a specified module.
   */
  protected function getFieldStoragesByModule($module) {
    return $this->fieldStorageConfigStorage->loadByProperties(['module' => $module, 'include_deleted' => TRUE]);
  }

93 94 95 96 97 98 99 100 101 102 103 104 105 106

  /**
   * Returns the label for a specified field type.
   *
   * @param string $field_type
   *   The field type.
   *
   * @return string
   *   The field type label.
   */
  protected function getFieldTypeLabel($field_type) {
    return $this->fieldTypeManager->getDefinitions()[$field_type]['label'];
  }

107
}