class VocabularyForm

Same name in other branches
  1. 9 core/modules/taxonomy/src/VocabularyForm.php \Drupal\taxonomy\VocabularyForm
  2. 8.9.x core/modules/taxonomy/src/VocabularyForm.php \Drupal\taxonomy\VocabularyForm
  3. 10 core/modules/taxonomy/src/VocabularyForm.php \Drupal\taxonomy\VocabularyForm

Base form for vocabulary edit forms.

@internal

Hierarchy

Expanded class hierarchy of VocabularyForm

1 file declares its use of VocabularyForm
Vocabulary.php in core/modules/taxonomy/src/Entity/Vocabulary.php

File

core/modules/taxonomy/src/VocabularyForm.php, line 17

Namespace

Drupal\taxonomy
View source
class VocabularyForm extends BundleEntityFormBase {
    
    /**
     * The vocabulary storage.
     *
     * @var \Drupal\taxonomy\VocabularyStorageInterface
     */
    protected $vocabularyStorage;
    
    /**
     * Constructs a new vocabulary form.
     *
     * @param \Drupal\taxonomy\VocabularyStorageInterface $vocabulary_storage
     *   The vocabulary storage.
     */
    public function __construct(VocabularyStorageInterface $vocabulary_storage) {
        $this->vocabularyStorage = $vocabulary_storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('entity_type.manager')
            ->getStorage('taxonomy_vocabulary'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildEntity(array $form, FormStateInterface $form_state) {
        
        /** @var \Drupal\taxonomy\VocabularyInterface $entity */
        $entity = parent::buildEntity($form, $form_state);
        // The description cannot be an empty string.
        if (trim($form_state->getValue('description')) === '') {
            $entity->set('description', NULL);
        }
        return $entity;
    }
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        $vocabulary = $this->entity;
        if ($vocabulary->isNew()) {
            $form['#title'] = $this->t('Add vocabulary');
        }
        else {
            $form['#title'] = $this->t('Edit vocabulary');
        }
        $form['name'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Name'),
            '#default_value' => $vocabulary->label(),
            '#maxlength' => 255,
            '#required' => TRUE,
        ];
        $form['vid'] = [
            '#type' => 'machine_name',
            '#default_value' => $vocabulary->id(),
            '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
            '#machine_name' => [
                'exists' => [
                    $this,
                    'exists',
                ],
                'source' => [
                    'name',
                ],
            ],
        ];
        $form['description'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Description'),
            '#default_value' => $vocabulary->getDescription(),
        ];
        $form['revision'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Create new revision'),
            '#default_value' => $vocabulary->shouldCreateNewRevision(),
            '#description' => $this->t('Create a new revision by default for this vocabulary.'),
        ];
        // $form['langcode'] is not wrapped in an
        // if ($this->moduleHandler->moduleExists('language')) check because the
        // language_select form element works also without the language module being
        // installed. https://www.drupal.org/node/1749954 documents the new element.
        $form['langcode'] = [
            '#type' => 'language_select',
            '#title' => $this->t('Vocabulary language'),
            '#languages' => LanguageInterface::STATE_ALL,
            '#default_value' => $vocabulary->language()
                ->getId(),
        ];
        if ($this->moduleHandler
            ->moduleExists('language')) {
            $form['default_terms_language'] = [
                '#type' => 'details',
                '#title' => $this->t('Term language'),
                '#open' => TRUE,
            ];
            $form['default_terms_language']['default_language'] = [
                '#type' => 'language_configuration',
                '#entity_information' => [
                    'entity_type' => 'taxonomy_term',
                    'bundle' => $vocabulary->id(),
                ],
                '#default_value' => ContentLanguageSettings::loadByEntityTypeBundle('taxonomy_term', $vocabulary->id()),
            ];
        }
        // Set the hierarchy to "multiple parents" by default. This simplifies the
        // vocabulary form and standardizes the term form.
        $form['hierarchy'] = [
            '#type' => 'value',
            '#value' => '0',
        ];
        $form = parent::form($form, $form_state);
        return $this->protectBundleIdElement($form);
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $vocabulary = $this->entity;
        $vocabulary->setNewRevision($form_state->getValue([
            'revision',
        ]));
        // Prevent leading and trailing spaces in vocabulary names.
        $vocabulary->set('name', trim($vocabulary->label()));
        $status = $vocabulary->save();
        $edit_link = $this->entity
            ->toLink($this->t('Edit'), 'edit-form')
            ->toString();
        switch ($status) {
            case SAVED_NEW:
                $this->messenger()
                    ->addStatus($this->t('Created new vocabulary %name.', [
                    '%name' => $vocabulary->label(),
                ]));
                $this->logger('taxonomy')
                    ->notice('Created new vocabulary %name.', [
                    '%name' => $vocabulary->label(),
                    'link' => $edit_link,
                ]);
                $form_state->setRedirectUrl($vocabulary->toUrl('overview-form'));
                break;
            case SAVED_UPDATED:
                $this->messenger()
                    ->addStatus($this->t('Updated vocabulary %name.', [
                    '%name' => $vocabulary->label(),
                ]));
                $this->logger('taxonomy')
                    ->notice('Updated vocabulary %name.', [
                    '%name' => $vocabulary->label(),
                    'link' => $edit_link,
                ]);
                $form_state->setRedirectUrl($vocabulary->toUrl('collection'));
                break;
        }
        $form_state->setValue('vid', $vocabulary->id());
        $form_state->set('vid', $vocabulary->id());
    }
    
    /**
     * Determines if the vocabulary already exists.
     *
     * @param string $vid
     *   The vocabulary ID.
     *
     * @return bool
     *   TRUE if the vocabulary exists, FALSE otherwise.
     */
    public function exists($vid) {
        $action = $this->vocabularyStorage
            ->load($vid);
        return !empty($action);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BundleEntityFormBase::protectBundleIdElement protected function Protects the bundle entity's ID property's form element against changes.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
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::actions protected function Returns an array of supported actions for the current entity form. 36
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::buildForm public function Overrides FormInterface::buildForm 13
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 11
EntityForm::getBaseFormId public function Overrides BaseFormIdInterface::getBaseFormId 4
EntityForm::getEntity public function Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getFormId public function Overrides FormInterface::getFormId 13
EntityForm::getOperation public function 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 Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Overrides EntityFormInterface::setOperation
EntityForm::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 FormInterface::submitForm 21
FormBase::$configFactory protected property The config factory. 2
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. 2
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::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 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 '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. 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
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
VocabularyForm::$vocabularyStorage protected property The vocabulary storage.
VocabularyForm::buildEntity public function Overrides EntityForm::buildEntity
VocabularyForm::create public static function Overrides FormBase::create
VocabularyForm::exists public function Determines if the vocabulary already exists.
VocabularyForm::form public function Overrides EntityForm::form
VocabularyForm::save public function Overrides EntityForm::save
VocabularyForm::__construct public function Constructs a new vocabulary form.

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