class FieldConfigDeleteForm

Same name in other branches
  1. 9 core/modules/field_ui/src/Form/FieldConfigDeleteForm.php \Drupal\field_ui\Form\FieldConfigDeleteForm
  2. 8.9.x core/modules/field_ui/src/Form/FieldConfigDeleteForm.php \Drupal\field_ui\Form\FieldConfigDeleteForm
  3. 11.x core/modules/field_ui/src/Form/FieldConfigDeleteForm.php \Drupal\field_ui\Form\FieldConfigDeleteForm

Provides a form for removing a field from a bundle.

@internal

Hierarchy

Expanded class hierarchy of FieldConfigDeleteForm

File

core/modules/field_ui/src/Form/FieldConfigDeleteForm.php, line 19

Namespace

Drupal\field_ui\Form
View source
class FieldConfigDeleteForm extends EntityDeleteForm {
    
    /**
     * The entity type bundle info service.
     *
     * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
     */
    protected $entityTypeBundleInfo;
    
    /**
     * Constructs a new FieldConfigDeleteForm object.
     *
     * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
     *   The entity type bundle info service.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface|null $entity_type_manager
     *   The entity type manager service.
     */
    public function __construct(EntityTypeBundleInfoInterface $entity_type_bundle_info, ?EntityTypeManagerInterface $entity_type_manager = NULL) {
        $this->entityTypeBundleInfo = $entity_type_bundle_info;
        if (!$entity_type_manager) {
            @trigger_error('Calling ' . __METHOD__ . '() without the $entity_type_manager argument is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. See https://www.drupal.org/node/3396525', E_USER_DEPRECATED);
            $entity_type_manager = \Drupal::service('entity_type.manager');
        }
        $this->entityTypeManager = $entity_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.bundle.info'), $container->get('entity_type.manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form = parent::buildForm($form, $form_state);
        // If we are adding the field storage as a dependency to delete, then that
        // will list the field as a dependency. That is confusing, so remove it.
        // Also remove the entity type and the whole entity deletions details
        // element if nothing else is in there.
        if (isset($form['entity_deletes']['field_config']['#items']) && isset($form['entity_deletes']['field_config']['#items'][$this->entity
            ->id()])) {
            unset($form['entity_deletes']['field_config']['#items'][$this->entity
                ->id()]);
            if (empty($form['entity_deletes']['field_config']['#items'])) {
                unset($form['entity_deletes']['field_config']);
                if (!Element::children($form['entity_deletes'])) {
                    $form['entity_deletes']['#access'] = FALSE;
                }
            }
        }
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getConfigNamesToDelete(ConfigEntityInterface $entity) {
        
        /** @var \Drupal\field\FieldStorageConfigInterface $field_storage */
        $field_storage = $entity->getFieldStorageDefinition();
        $config_names = [
            $entity->getConfigDependencyName(),
        ];
        // If there is only one bundle left for this field storage, it will be
        // deleted too, notify the user about dependencies.
        if (count($field_storage->getBundles()) <= 1) {
            $config_names[] = $field_storage->getConfigDependencyName();
        }
        return $config_names;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return FieldUI::getOverviewRouteInfo($this->entity
            ->getTargetEntityTypeId(), $this->entity
            ->getTargetBundle());
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $field_storage = $this->entity
            ->getFieldStorageDefinition();
        $target_entity_type_id = $this->entity
            ->getTargetEntityTypeId();
        $target_bundle = $this->entity
            ->getTargetBundle();
        $target_entity_definition = $this->entityTypeManager
            ->getDefinition($target_entity_type_id);
        $target_entity_bundle_entity_type_id = $target_entity_definition->getBundleEntityType();
        if (empty($target_entity_bundle_entity_type_id)) {
            $source_label = $this->t('entity type');
        }
        else {
            $target_entity_bundle_entity_type_definition = $this->entityTypeManager
                ->getDefinition($target_entity_bundle_entity_type_id);
            $source_label = strtolower($target_entity_bundle_entity_type_definition->getLabel());
        }
        $bundles = $this->entityTypeBundleInfo
            ->getBundleInfo($target_entity_type_id);
        $bundle_label = $bundles[$target_bundle]['label'];
        if ($field_storage && !$field_storage->isLocked()) {
            $this->entity
                ->delete();
            $this->messenger()
                ->addStatus($this->t('The field %field has been deleted from the %type %source_label.', [
                '%field' => $this->entity
                    ->label(),
                '%type' => $bundle_label,
                '%source_label' => $source_label,
            ]));
        }
        else {
            $this->messenger()
                ->addError($this->t('There was a problem removing the %field from the %type %source_label.', [
                '%field' => $this->entity
                    ->label(),
                '%type' => $bundle_label,
                '%source_label' => $source_label,
            ]));
        }
        $form_state->setRedirectUrl($this->getCancelUrl());
        // Fields are purged on cron. However field module prevents disabling
        // modules when field types they provided are used in a field until it is
        // fully purged. In the case that a field has minimal or no content, a
        // single call to field_purge_batch() will remove it from the system. Call
        // this with a low batch limit to avoid administrators having to wait for
        // cron runs when removing fields that meet this criteria.
        field_purge_batch(10);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigDependencyDeleteFormTrait::addDependencyListsToForm protected function Adds form elements to list affected configuration entities.
ConfigDependencyDeleteFormTrait::t abstract protected function Translates a string to the current language or to a given language.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityConfirmFormBase::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions 1
EntityConfirmFormBase::delete public function The delete() method is not used in EntityConfirmFormBase. This overrides
the default implementation that redirects to the delete-form confirmation
form.
EntityConfirmFormBase::getBaseFormId public function Returns a string identifying the base form. Overrides EntityForm::getBaseFormId
EntityConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
EntityConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
EntityConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
EntityConfirmFormBase::save public function The save() method is not used in EntityConfirmFormBase. This overrides the
default implementation that saves the entity.
Overrides EntityForm::save
EntityDeleteForm::getConfigManager protected function Gets the configuration manager.
EntityDeleteFormTrait::getConfirmText public function 1
EntityDeleteFormTrait::getDeletionMessage protected function Gets the message to display to the user after deleting the entity. 3
EntityDeleteFormTrait::getEntity abstract public function Gets the entity of this form.
EntityDeleteFormTrait::getQuestion public function 4
EntityDeleteFormTrait::getRedirectUrl protected function Returns the URL where the user should be redirected after deletion. 4
EntityDeleteFormTrait::logDeletionMessage protected function Logs a message about the deleted entity. 2
EntityDeleteFormTrait::logger abstract protected function Gets the logger for a specific channel.
EntityForm::$entity protected property The entity being used by this form. 11
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service. 2
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data. 1
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 5
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 11
EntityForm::form public function Gets the actual form array to be built. 36
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 13
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
FieldConfigDeleteForm::$entityTypeBundleInfo protected property The entity type bundle info service.
FieldConfigDeleteForm::buildForm public function Form constructor. Overrides EntityDeleteForm::buildForm
FieldConfigDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
FieldConfigDeleteForm::getCancelUrl public function Overrides EntityDeleteFormTrait::getCancelUrl
FieldConfigDeleteForm::getConfigNamesToDelete protected function Returns config names to delete for the deletion confirmation form. Overrides EntityDeleteForm::getConfigNamesToDelete
FieldConfigDeleteForm::submitForm public function Overrides EntityDeleteFormTrait::submitForm
FieldConfigDeleteForm::__construct public function Constructs a new FieldConfigDeleteForm object.
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user. 2
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 57
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2

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