class TermForm
Same name and namespace in other branches
- 11.x core/modules/taxonomy/src/TermForm.php \Drupal\taxonomy\TermForm
- 10 core/modules/taxonomy/src/TermForm.php \Drupal\taxonomy\TermForm
- 9 core/modules/taxonomy/src/TermForm.php \Drupal\taxonomy\TermForm
- 8.9.x core/modules/taxonomy/src/TermForm.php \Drupal\taxonomy\TermForm
Base for handler for taxonomy term edit forms.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Htmx\HtmxRequestInfoTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\EntityFormInterface extends \Drupal\Core\Form\FormBase
- class \Drupal\Core\Entity\ContentEntityForm implements \Drupal\Core\Entity\ContentEntityFormInterface extends \Drupal\Core\Entity\EntityForm
- class \Drupal\taxonomy\TermForm extends \Drupal\Core\Entity\ContentEntityForm
- class \Drupal\Core\Entity\ContentEntityForm implements \Drupal\Core\Entity\ContentEntityFormInterface extends \Drupal\Core\Entity\EntityForm
- class \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\EntityFormInterface extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of TermForm
File
-
core/
modules/ taxonomy/ src/ TermForm.php, line 14
Namespace
Drupal\taxonomyView source
class TermForm extends ContentEntityForm {
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$term = $this->entity;
$vocab_storage = $this->entityTypeManager
->getStorage('taxonomy_vocabulary');
/** @var \Drupal\taxonomy\TermStorageInterface $taxonomy_storage */
$taxonomy_storage = $this->entityTypeManager
->getStorage('taxonomy_term');
$vocabulary = $vocab_storage->load($term->bundle());
$parent = $this->getParentIds($term);
$form_state->set([
'taxonomy',
'parent',
], $parent);
$form_state->set([
'taxonomy',
'vocabulary',
], $vocabulary);
$form['relations'] = [
'#type' => 'details',
'#title' => $this->t('Relations'),
'#open' => $taxonomy_storage->getVocabularyHierarchyType($vocabulary->id()) == VocabularyInterface::HIERARCHY_MULTIPLE,
'#weight' => 10,
];
// \Drupal\taxonomy\TermStorageInterface::loadTree() and
// \Drupal\taxonomy\TermStorageInterface::loadParents() may contain large
// numbers of items so we check for taxonomy.settings:override_selector
// before loading the full vocabulary. Contrib modules can then intercept
// before hook_form_alter to provide scalable alternatives.
if (!$this->config('taxonomy.settings')
->get('override_selector')) {
$exclude = [];
if (!$term->isNew()) {
$children = $taxonomy_storage->loadTree($vocabulary->id(), $term->id());
// A term can't be the child of itself, nor of its children.
foreach ($children as $child) {
$exclude[] = $child->tid;
}
$exclude[] = $term->id();
}
$tree = $taxonomy_storage->loadTree($vocabulary->id());
$options = [
'<' . $this->t('root') . '>',
];
if (empty($parent)) {
$parent = [
0,
];
}
foreach ($tree as $item) {
if (!in_array($item->tid, $exclude)) {
$options[$item->tid] = str_repeat('-', $item->depth) . $item->name;
}
}
}
else {
$options = [
'<' . $this->t('root') . '>',
];
$parent = [
0,
];
}
if ($this->getRequest()->query
->has('parent')) {
$parent = array_values(array_intersect(array_keys($options), (array) $this->getRequest()->query
->all()['parent']));
}
$form['relations']['parent'] = [
'#type' => 'select',
'#title' => $this->t('Parent terms'),
'#options' => $options,
'#default_value' => $parent,
'#multiple' => TRUE,
];
$form['relations']['weight'] = [
'#type' => 'textfield',
'#title' => $this->t('Weight'),
'#size' => 6,
'#default_value' => $term->getWeight(),
'#description' => $this->t('Terms are displayed in ascending order by weight.'),
'#required' => TRUE,
];
$form['vid'] = [
'#type' => 'value',
'#value' => $vocabulary->id(),
];
$form['tid'] = [
'#type' => 'value',
'#value' => $term->id(),
];
return parent::form($form, $form_state);
}
/**
* {@inheritdoc}
*/
protected function actions(array $form, FormStateInterface $form_state) {
$element = parent::actions($form, $form_state);
if (!$this->getRequest()->query
->has('destination')) {
$element['overview'] = [
'#type' => 'submit',
'#value' => $this->t('Save and go to list'),
'#weight' => 20,
'#submit' => array_merge($element['submit']['#submit'], [
'::overview',
]),
'#access' => $this->currentUser()
->hasPermission('access taxonomy overview'),
];
}
return $element;
}
/**
* Form submission handler for the 'overview' action.
*
* @param array[] $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
public function overview(array $form, FormStateInterface $form_state) : void {
$vocabulary = $this->entityTypeManager
->getStorage('taxonomy_vocabulary')
->load($form_state->getValue('vid'));
$form_state->setRedirectUrl($vocabulary->toUrl('overview-form'));
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
// Ensure numeric values.
if ($form_state->hasValue('weight') && !is_numeric($form_state->getValue('weight'))) {
$form_state->setErrorByName('weight', $this->t('Weight value must be numeric.'));
}
}
/**
* {@inheritdoc}
*/
public function buildEntity(array $form, FormStateInterface $form_state) {
$term = parent::buildEntity($form, $form_state);
// Prevent leading and trailing spaces in term names.
$term->setName(trim($term->getName()));
// Assign parents with proper delta values starting from 0.
$term->parent = array_values($form_state->getValue('parent'));
return $term;
}
/**
* {@inheritdoc}
*/
protected function getEditedFieldNames(FormStateInterface $form_state) {
return array_merge([
'parent',
'weight',
], parent::getEditedFieldNames($form_state));
}
/**
* {@inheritdoc}
*/
protected function flagViolations(EntityConstraintViolationListInterface $violations, array $form, FormStateInterface $form_state) {
// Manually flag violations of fields not handled by the form display. This
// is necessary as entity form displays only flag violations for fields
// contained in the display.
// @see ::form()
foreach ($violations->getByField('parent') as $violation) {
$form_state->setErrorByName('parent', $violation->getMessage());
}
foreach ($violations->getByField('weight') as $violation) {
$form_state->setErrorByName('weight', $violation->getMessage());
}
parent::flagViolations($violations, $form, $form_state);
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$term = $this->entity;
$result = $term->save();
$edit_link = $term->toLink($this->t('Edit'), 'edit-form')
->toString();
$view_link = $term->toLink()
->toString();
switch ($result) {
case SAVED_NEW:
$this->messenger()
->addStatus($this->t('Created new term %term.', [
'%term' => $view_link,
]));
$this->logger('taxonomy')
->info('Created new term %term.', [
'%term' => $term->getName(),
'link' => $edit_link,
]);
break;
case SAVED_UPDATED:
$this->messenger()
->addStatus($this->t('Updated term %term.', [
'%term' => $view_link,
]));
$this->logger('taxonomy')
->info('Updated term %term.', [
'%term' => $term->getName(),
'link' => $edit_link,
]);
// Redirect to term view page if user has access, otherwise the form
// will be displayed again.
$canonicalUrl = $term->toUrl();
if ($canonicalUrl->access()) {
$form_state->setRedirectUrl($canonicalUrl);
}
break;
}
$current_parent_count = count($form_state->getValue('parent'));
// Root doesn't count if it's the only parent.
if ($current_parent_count == 1 && $form_state->hasValue([
'parent',
0,
])) {
$form_state->setValue('parent', []);
}
$form_state->setValue('tid', $term->id());
$form_state->set('tid', $term->id());
}
/**
* Returns term parent IDs, including the root.
*
* @param \Drupal\taxonomy\TermInterface $term
* The taxonomy term entity.
*
* @return array
* A list if parent term IDs.
*/
protected function getParentIds(TermInterface $term) : array {
$parent = [];
// Get the parent directly from the term as
// \Drupal\taxonomy\TermStorageInterface::loadParents() excludes the root.
foreach ($term->get('parent') as $item) {
$parent[] = (int) $item->target_id;
}
return $parent;
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
|---|---|---|---|---|
| ContentEntityForm::$entity | protected | property | The entity being used by this form. | |
| ContentEntityForm::$entityRepository | protected | property | The entity repository service. | |
| ContentEntityForm::$entityTypeBundleInfo | protected | property | The entity type bundle info service. | |
| ContentEntityForm::$time | protected | property | The time service. | |
| ContentEntityForm::addRevisionableFormFields | protected | function | Add revision form fields if the entity enabled the UI. | |
| ContentEntityForm::copyFormValuesToEntity | protected | function | ||
| ContentEntityForm::create | public static | function | ||
| ContentEntityForm::getBundleEntity | protected | function | Returns the bundle entity of the entity, or NULL if there is none. | |
| ContentEntityForm::getFormDisplay | public | function | ||
| ContentEntityForm::getFormLangcode | public | function | ||
| ContentEntityForm::getNewRevisionDefault | protected | function | Should new revisions created on default. | |
| ContentEntityForm::init | protected | function | Initializes the form state and the entity before the first form build. | |
| ContentEntityForm::initFormLangcodes | protected | function | Initializes form language code values. | |
| ContentEntityForm::isDefaultFormLangcode | public | function | ||
| ContentEntityForm::prepareEntity | protected | function | ||
| ContentEntityForm::setFormDisplay | public | function | ||
| ContentEntityForm::showRevisionUi | protected | function | Checks whether the revision form fields should be added to the form. | |
| ContentEntityForm::submitForm | public | function | ||
| ContentEntityForm::updateChangedTime | public | function | Updates the changed time of the entity. | |
| ContentEntityForm::updateFormLangcode | public | function | Updates the form language to reflect any change to the entity language. | |
| ContentEntityForm::__construct | public | function | Constructs a ContentEntityForm object. | |
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |
| DependencySerializationTrait::__sleep | public | function | ||
| DependencySerializationTrait::__wakeup | public | function | ||
| EntityForm::$entityTypeManager | protected | property | The entity type manager. | |
| EntityForm::$moduleHandler | protected | property | The module handler service. | |
| EntityForm::$operation | protected | property | The name of the current operation. | |
| 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. | |
| EntityForm::buildForm | public | function | ||
| EntityForm::getBaseFormId | public | function | ||
| EntityForm::getCallableFromDefinition | protected | function | Gets a callable from a string or array definition if possible. | |
| EntityForm::getEntity | public | function | ||
| EntityForm::getEntityFromRouteMatch | public | function | ||
| EntityForm::getFormId | public | function | ||
| EntityForm::getOperation | public | function | ||
| 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 | ||
| EntityForm::setEntityTypeManager | public | function | ||
| EntityForm::setModuleHandler | public | function | ||
| EntityForm::setOperation | public | function | ||
| FormBase::$configFactory | protected | property | The config factory. | |
| FormBase::$requestStack | protected | property | The request stack. | |
| 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. | |
| 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. | |
| HtmxRequestInfoTrait::getHtmxCurrentUrl | protected | function | Retrieves the URL of the requesting page from an HTMX request header. | |
| HtmxRequestInfoTrait::getHtmxPrompt | protected | function | Retrieves the prompt from an HTMX request header. | |
| HtmxRequestInfoTrait::getHtmxTarget | protected | function | Retrieves the target identifier from an HTMX request header. | |
| HtmxRequestInfoTrait::getHtmxTrigger | protected | function | Retrieves the trigger identifier from an HTMX request header. | |
| HtmxRequestInfoTrait::getHtmxTriggerName | protected | function | Retrieves the trigger name from an HTMX request header. | |
| HtmxRequestInfoTrait::isHtmxBoosted | protected | function | Determines if the request is boosted by HTMX. | |
| HtmxRequestInfoTrait::isHtmxHistoryRestoration | protected | function | Determines if if the request is for history restoration. | |
| HtmxRequestInfoTrait::isHtmxRequest | protected | function | Determines if the request is sent by HTMX. | |
| 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. | |
| MessengerTrait::messenger | public | function | Gets the messenger. | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |
| RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | |
| 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. | |
| 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. | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | |
| TermForm::actions | protected | function | Returns an array of supported actions for the current entity form. | Overrides EntityForm::actions |
| TermForm::buildEntity | public | function | Builds an updated entity object based upon the submitted form values. | Overrides ContentEntityForm::buildEntity |
| TermForm::flagViolations | protected | function | Flags violations for the current form. | Overrides ContentEntityForm::flagViolations |
| TermForm::form | public | function | Gets the actual form array to be built. | Overrides ContentEntityForm::form |
| TermForm::getEditedFieldNames | protected | function | Gets the names of all fields edited in the form. | Overrides ContentEntityForm::getEditedFieldNames |
| TermForm::getParentIds | protected | function | Returns term parent IDs, including the root. | |
| TermForm::overview | public | function | Form submission handler for the 'overview' action. | |
| TermForm::save | public | function | Form submission handler for the 'save' action. | Overrides EntityForm::save |
| TermForm::validateForm | public | function | Button-level validation handlers are highly discouraged for entity forms, as they will prevent entity validation from running. If the entity is going to be saved during the form submission, this method should be manually invoked from the button-level… |
Overrides ContentEntityForm::validateForm |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.