You are here

class DeleteTermsForm in Taxonomy Manager 2.0.x

Same name and namespace in other branches
  1. 8 src/Form/DeleteTermsForm.php \Drupal\taxonomy_manager\Form\DeleteTermsForm

Form for deleting given terms.

Hierarchy

Expanded class hierarchy of DeleteTermsForm

1 string reference to 'DeleteTermsForm'
taxonomy_manager.routing.yml in ./taxonomy_manager.routing.yml
taxonomy_manager.routing.yml

File

src/Form/DeleteTermsForm.php, line 15

Namespace

Drupal\taxonomy_manager\Form
View source
class DeleteTermsForm extends FormBase {

  /**
   * The current request.
   *
   * @var \Drupal\taxonomy\TermStorageInterface
   */
  protected $termStorage;

  /**
   * The taxonomy messenger helper.
   *
   * @var \Drupal\taxonomy_manager\TaxonomyManagerHelper
   */
  protected $taxonomyManagerHelper;

  /**
   * DeleteTermsForm constructor.
   *
   * @param \Drupal\taxonomy\TermStorage $term_storage
   *   Object with convenient methods to manage terms.
   * @param \Drupal\taxonomy_manager\TaxonomyManagerHelper $taxonomy_manager_helper
   *   The taxonomy messenger helper.
   */
  public function __construct(TermStorage $term_storage, TaxonomyManagerHelper $taxonomy_manager_helper) {
    $this->termStorage = $term_storage;
    $this->taxonomyManagerHelper = $taxonomy_manager_helper;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager')
      ->getStorage('taxonomy_term'), $container
      ->get('taxonomy_manager.helper'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, VocabularyInterface $taxonomy_vocabulary = NULL, $selected_terms = []) {
    if (empty($selected_terms)) {
      $form['info'] = [
        '#markup' => $this
          ->t('Please select the terms you want to delete.'),
      ];
      return $form;
    }

    // Cache form state so that we keep the parents in the modal dialog.
    $form_state
      ->setCached(TRUE);
    $form['voc'] = [
      '#type' => 'value',
      '#value' => $taxonomy_vocabulary,
    ];
    $form['selected_terms']['#tree'] = TRUE;
    $items = [];
    foreach ($selected_terms as $t) {
      $term = $this->termStorage
        ->load($t);
      $items[] = $term
        ->getName();
      $form['selected_terms'][$t] = [
        '#type' => 'value',
        '#value' => $t,
      ];
    }
    $form['terms'] = [
      '#theme' => 'item_list',
      '#items' => $items,
      '#title' => $this
        ->t('Selected terms for deletion:'),
    ];
    $form['delete_orphans'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Delete children of selected terms, if there are any'),
    ];
    $form['delete'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $taxonomy_vocabulary = $form_state
      ->getValue('voc');
    $selected_terms = $form_state
      ->getValue('selected_terms');
    $delete_orphans = $form_state
      ->getValue('delete_orphans');
    $info = $this->taxonomyManagerHelper
      ->deleteTerms($selected_terms, $delete_orphans);
    $this
      ->messenger()
      ->addMessage($this
      ->t("Deleted terms: %deleted_term_names", [
      '%deleted_term_names' => implode(', ', $info['deleted_terms']),
    ]));
    if (count($info['remaining_child_terms'])) {
      $this
        ->messenger()
        ->addMessage($this
        ->t("Remaining child terms with different parents: %remaining_child_term_names", [
        '%remaining_child_term_names' => implode(', ', $info['remaining_child_terms']),
      ]));
    }
    $form_state
      ->setRedirect('taxonomy_manager.admin_vocabulary', [
      'taxonomy_vocabulary' => $taxonomy_vocabulary
        ->id(),
    ]);
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
DeleteTermsForm::$taxonomyManagerHelper protected property The taxonomy messenger helper.
DeleteTermsForm::$termStorage protected property The current request.
DeleteTermsForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
DeleteTermsForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
DeleteTermsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DeleteTermsForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DeleteTermsForm::__construct public function DeleteTermsForm constructor.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
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 72
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' 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. 4
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
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.