aleph1.co.uk Git - yaffs-website/blob - web/core/modules/field_ui/src/Form/FieldConfigDeleteForm.php

   1 <?php
   2
   3 namespace Drupal\field_ui\Form;
   4
   5 use Drupal\Core\Config\Entity\ConfigEntityInterface;
   6 use Drupal\Core\Entity\EntityDeleteForm;
   7 use Drupal\Core\Entity\EntityManagerInterface;
   8 use Drupal\Core\Form\FormStateInterface;
   9 use Drupal\Core\Render\Element;
  10 use Drupal\field_ui\FieldUI;
  11 use Symfony\Component\DependencyInjection\ContainerInterface;
  12
  13 /**
  14  * Provides a form for removing a field from a bundle.
  15  *
  16  * @internal
  17  */
  18 class FieldConfigDeleteForm extends EntityDeleteForm {
  19
  20   /**
  21    * The entity manager.
  22    *
  23    * @var \Drupal\Core\Entity\EntityManagerInterface
  24    */
  25   protected $entityManager;
  26
  27   /**
  28    * Constructs a new FieldConfigDeleteForm object.
  29    *
  30    * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
  31    *   The entity manager.
  32    */
  33   public function __construct(EntityManagerInterface $entity_manager) {
  34     $this->entityManager = $entity_manager;
  35   }
  36
  37   /**
  38    * {@inheritdoc}
  39    */
  40   public static function create(ContainerInterface $container) {
  41     return new static(
  42       $container->get('entity.manager')
  43     );
  44   }
  45
  46   /**
  47    * {@inheritdoc}
  48    */
  49   public function buildForm(array $form, FormStateInterface $form_state) {
  50     $form = parent::buildForm($form, $form_state);
  51
  52     // If we are adding the field storage as a dependency to delete, then that
  53     // will list the field as a dependency. That is confusing, so remove it.
  54     // Also remove the entity type and the whole entity deletions details
  55     // element if nothing else is in there.
  56     if (isset($form['entity_deletes']['field_config']['#items']) && isset($form['entity_deletes']['field_config']['#items'][$this->entity->id()])) {
  57       unset($form['entity_deletes']['field_config']['#items'][$this->entity->id()]);
  58       if (empty($form['entity_deletes']['field_config']['#items'])) {
  59         unset($form['entity_deletes']['field_config']);
  60         if (!Element::children($form['entity_deletes'])) {
  61           $form['entity_deletes']['#access'] = FALSE;
  62         }
  63       }
  64     }
  65     return $form;
  66   }
  67
  68   /**
  69    * {@inheritdoc}
  70    */
  71   protected function getConfigNamesToDelete(ConfigEntityInterface $entity) {
  72     /** @var \Drupal\field\FieldStorageConfigInterface $field_storage */
  73     $field_storage = $entity->getFieldStorageDefinition();
  74     $config_names = [$entity->getConfigDependencyName()];
  75
  76     // If there is only one bundle left for this field storage, it will be
  77     // deleted too, notify the user about dependencies.
  78     if (count($field_storage->getBundles()) <= 1) {
  79       $config_names[] = $field_storage->getConfigDependencyName();
  80     }
  81     return $config_names;
  82   }
  83
  84   /**
  85    * {@inheritdoc}
  86    */
  87   public function getCancelUrl() {
  88     return FieldUI::getOverviewRouteInfo($this->entity->getTargetEntityTypeId(), $this->entity->getTargetBundle());
  89   }
  90
  91   /**
  92    * {@inheritdoc}
  93    */
  94   public function submitForm(array &$form, FormStateInterface $form_state) {
  95     $field_storage = $this->entity->getFieldStorageDefinition();
  96     $bundles = $this->entityManager->getBundleInfo($this->entity->getTargetEntityTypeId());
  97     $bundle_label = $bundles[$this->entity->getTargetBundle()]['label'];
  98
  99     if ($field_storage && !$field_storage->isLocked()) {
 100       $this->entity->delete();
 101       $this->messenger()->addStatus($this->t('The field %field has been deleted from the %type content type.', ['%field' => $this->entity->label(), '%type' => $bundle_label]));
 102     }
 103     else {
 104       $this->messenger()->addError($this->t('There was a problem removing the %field from the %type content type.', ['%field' => $this->entity->label(), '%type' => $bundle_label]));
 105     }
 106
 107     $form_state->setRedirectUrl($this->getCancelUrl());
 108
 109     // Fields are purged on cron. However field module prevents disabling modules
 110     // when field types they provided are used in a field until it is fully
 111     // purged. In the case that a field has minimal or no content, a single call
 112     // to field_purge_batch() will remove it from the system. Call this with a
 113     // low batch limit to avoid administrators having to wait for cron runs when
 114     // removing fields that meet this criteria.
 115     field_purge_batch(10);
 116   }
 117
 118 }