Same name and namespace in other branches
  1. 8.9.x core/modules/taxonomy/src/Form/VocabularyResetForm.php \Drupal\taxonomy\Form\VocabularyResetForm
  2. 9 core/modules/taxonomy/src/Form/VocabularyResetForm.php \Drupal\taxonomy\Form\VocabularyResetForm

Provides confirmation form for resetting a vocabulary to alphabetical order.

@internal

Hierarchy

Expanded class hierarchy of VocabularyResetForm

File

core/modules/taxonomy/src/Form/VocabularyResetForm.php, line 15

Namespace

Drupal\taxonomy\Form
View source
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());
  }

}

Members

Name Modifierssort descending Type Description Overrides
FormBase::container private function Returns the service container.
EntityConfirmFormBase::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions 1
EntityForm::init protected function Initialize the form state and the entity before the first form build. 2
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 2
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 2
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::currentUser protected function Gets the current user.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::logger protected function Gets the logger for a specific channel.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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.
VocabularyResetForm::$termStorage protected property The term storage.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$moduleHandler protected property The module handler service. 2
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$entity protected property The entity being used by this form. 8
FormBase::$requestStack protected property The request stack. 1
FormBase::$configFactory protected property The config factory. 2
FormBase::$routeMatch protected property The route match.
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::$_entityStorages protected property
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
MessengerTrait::$messenger protected property The messenger. 10
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
VocabularyResetForm::__construct public function Constructs a new VocabularyResetForm object.
VocabularyResetForm::getFormId public function Returns a unique string identifying the form. Overrides EntityForm::getFormId
VocabularyResetForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
VocabularyResetForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
VocabularyResetForm::getDescription public function Returns additional text to display as a description. Overrides EntityConfirmFormBase::getDescription
VocabularyResetForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides EntityConfirmFormBase::getConfirmText
VocabularyResetForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides EntityForm::submitForm
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::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
EntityConfirmFormBase::buildForm public function Form constructor. Overrides EntityForm::buildForm 4
EntityConfirmFormBase::save public function The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. Overrides EntityForm::save
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.
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::form public function Gets the actual form array to be built. 30
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 4
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 51
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setRequestStack public function Sets the request stack object to use.
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::setMessenger public function Sets the messenger.
MessengerTrait::messenger public function Gets the messenger. 10
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
VocabularyResetForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create