FieldDeleteForm.php in Display Suite 8.4

Namespace

Drupal\ds\Form

File

src/Form/FieldDeleteForm.php

<?php

namespace Drupal\ds\Form;

use Drupal\Core\Cache\CacheTagsInvalidatorInterface;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Form\ConfigFormBaseTrait;
use Drupal\Core\Form\ConfirmFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;

/**
 * Provides a form to delete a DS field.
 */
class FieldDeleteForm extends ConfirmFormBase implements ContainerInjectionInterface {
  use ConfigFormBaseTrait;

  /**
   * Holds the cache invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $cacheInvalidator;

  /**
   * The field being deleted.
   *
   * @var array
   */
  protected $field;

  /**
   * Constructs a FieldDeleteForm object.
   *
   * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $cache_invalidator
   *   The cache invalidator.
   */
  public function __construct(CacheTagsInvalidatorInterface $cache_invalidator) {
    $this->cacheInvalidator = $cache_invalidator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('cache_tags.invalidator'));
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to delete @field ?', [
      '@field' => $this->field['label'],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('ds.fields_list');
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'field_delete_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, Request $request = NULL, $field_key = '') {
    $config = $this
      ->config('ds.field.' . $field_key);
    $this->field = $config
      ->get();
    if (empty($this->field)) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('Field not found.'));
      return new RedirectResponse('/admin/structure/ds/fields');
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $field = $this->field;

    // Remove field and clear caches.
    $this
      ->config('ds.field.' . $field['id'])
      ->delete();
    $this->cacheInvalidator
      ->invalidateTags([
      'ds_fields_info',
    ]);

    // Also clear the ds plugin cache.
    \Drupal::service('plugin.manager.ds')
      ->clearCachedDefinitions();

    // Redirect.
    $url = new Url('ds.fields_list');
    $form_state
      ->setRedirectUrl($url);
    $this
      ->messenger()
      ->addMessage($this
      ->t('The field @field has been deleted.', [
      '@field' => $field['label'],
    ]));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    if ($this->field) {
      return [
        'ds.field.' . $this->field['id'],
      ];
    }
    return [];
  }

}

Classes

Name	Description
FieldDeleteForm	Provides a form to delete a DS field.