VocabularyResetForm.php

Same filename in other branches
  1. 9 core/modules/taxonomy/src/Form/VocabularyResetForm.php
  2. 8.9.x core/modules/taxonomy/src/Form/VocabularyResetForm.php
  3. 10 core/modules/taxonomy/src/Form/VocabularyResetForm.php

Namespace

Drupal\taxonomy\Form

File

core/modules/taxonomy/src/Form/VocabularyResetForm.php

View source
<?php

namespace Drupal\taxonomy\Form;

use Drupal\Core\Entity\EntityConfirmFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\taxonomy\TermStorageInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides confirmation form for resetting a vocabulary to alphabetical order.
 *
 * @internal
 */
class VocabularyResetForm extends EntityConfirmFormBase {
    
    /**
     * The term storage.
     *
     * @var \Drupal\taxonomy\TermStorageInterface
     */
    protected $termStorage;
    
    /**
     * Constructs a new VocabularyResetForm object.
     *
     * @param \Drupal\taxonomy\TermStorageInterface $term_storage
     *   The term storage.
     */
    public function __construct(TermStorageInterface $term_storage) {
        $this->termStorage = $term_storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager')
            ->getStorage('taxonomy_term'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'taxonomy_vocabulary_confirm_reset_alphabetical';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to reset the vocabulary %title to alphabetical order?', [
            '%title' => $this->entity
                ->label(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return $this->entity
            ->toUrl('overview-form');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->t('Resetting a vocabulary will discard all custom ordering and sort items alphabetically.');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Reset to alphabetical');
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        parent::submitForm($form, $form_state);
        $this->termStorage
            ->resetWeights($this->entity
            ->id());
        $this->messenger()
            ->addStatus($this->t('Reset vocabulary %name to alphabetical order.', [
            '%name' => $this->entity
                ->label(),
        ]));
        $this->logger('taxonomy')
            ->notice('Reset vocabulary %name to alphabetical order.', [
            '%name' => $this->entity
                ->label(),
        ]);
        $form_state->setRedirectUrl($this->getCancelUrl());
    }

}

Classes

Title Deprecated Summary
VocabularyResetForm Provides confirmation form for resetting a vocabulary to alphabetical order.

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