class ForumForm
Same name in other branches
- 9 core/modules/forum/src/Form/ForumForm.php \Drupal\forum\Form\ForumForm
- 10 core/modules/forum/src/Form/ForumForm.php \Drupal\forum\Form\ForumForm
- 11.x core/modules/forum/src/Form/ForumForm.php \Drupal\forum\Form\ForumForm
Base form for forum 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\Routing\LinkGeneratorTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Routing\UrlGeneratorTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
- class \Drupal\Core\Entity\ContentEntityForm extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Entity\ContentEntityFormInterface
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
Expanded class hierarchy of ForumForm
File
-
core/
modules/ forum/ src/ Form/ ForumForm.php, line 15
Namespace
Drupal\forum\FormView source
class ForumForm extends TermForm {
/**
* Reusable type field to use in status messages.
*
* @var string
*/
protected $forumFormType;
/**
* Reusable url stub to use in watchdog messages.
*
* @var string
*/
protected $urlStub = 'forum';
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
// Build the bulk of the form from the parent taxonomy term form.
$form = parent::form($form, $form_state);
// Set the title and description of the name field.
$form['name']['#title'] = $this->t('Forum name');
$form['name']['#description'] = $this->t('Short but meaningful name for this collection of threaded discussions.');
// Change the description.
$form['description']['#description'] = $this->t('Description and guidelines for discussions within this forum.');
// Re-use the weight field.
$form['weight'] = $form['relations']['weight'];
// Remove the remaining relations fields.
unset($form['relations']);
// Our parent field is different to the taxonomy term.
$form['parent']['#tree'] = TRUE;
$form['parent'][0] = $this->forumParentSelect($this->entity
->id(), $this->t('Parent'));
$form['#theme_wrappers'] = [
'form__forum',
];
$this->forumFormType = $this->t('forum');
return $form;
}
/**
* {@inheritdoc}
*/
public function buildEntity(array $form, FormStateInterface $form_state) {
$term = parent::buildEntity($form, $form_state);
// Assign parents from forum parent select field.
$term->parent = [
$form_state->getValue([
'parent',
0,
]),
];
return $term;
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$term = $this->entity;
$term_storage = $this->entityTypeManager
->getStorage('taxonomy_term');
$status = $term_storage->save($term);
$route_name = $this->urlStub == 'container' ? 'entity.taxonomy_term.forum_edit_container_form' : 'entity.taxonomy_term.forum_edit_form';
$route_parameters = [
'taxonomy_term' => $term->id(),
];
$link = Link::fromTextAndUrl($this->t('Edit'), new Url($route_name, $route_parameters))
->toString();
$view_link = $term->toLink($term->getName())
->toString();
switch ($status) {
case SAVED_NEW:
$this->messenger()
->addStatus($this->t('Created new @type %term.', [
'%term' => $view_link,
'@type' => $this->forumFormType,
]));
$this->logger('forum')
->notice('Created new @type %term.', [
'%term' => $term->getName(),
'@type' => $this->forumFormType,
'link' => $link,
]);
$form_state->setValue('tid', $term->id());
break;
case SAVED_UPDATED:
$this->messenger()
->addStatus($this->t('The @type %term has been updated.', [
'%term' => $term->getName(),
'@type' => $this->forumFormType,
]));
$this->logger('forum')
->notice('Updated @type %term.', [
'%term' => $term->getName(),
'@type' => $this->forumFormType,
'link' => $link,
]);
break;
}
$form_state->setRedirect('forum.overview');
return $term;
}
/**
* {@inheritdoc}
*/
protected function actions(array $form, FormStateInterface $form_state) {
$actions = parent::actions($form, $form_state);
if (!$this->entity
->isNew() && $this->entity
->hasLinkTemplate('forum-delete-form')) {
$actions['delete']['#url'] = $this->entity
->toUrl('forum-delete-form');
}
else {
unset($actions['delete']);
}
return $actions;
}
/**
* Returns a select box for available parent terms.
*
* @param int $tid
* ID of the term that is being added or edited.
* @param string $title
* Title for the select box.
*
* @return array
* A select form element.
*/
protected function forumParentSelect($tid, $title) {
$taxonomy_storage = $this->entityTypeManager
->getStorage('taxonomy_term');
$parents = $taxonomy_storage->loadParents($tid);
if ($parents) {
$parent = array_shift($parents);
$parent = $parent->id();
}
else {
$parent = 0;
}
$vid = $this->config('forum.settings')
->get('vocabulary');
$children = $taxonomy_storage->loadTree($vid, $tid, NULL, TRUE);
// A term can't be the child of itself, nor of its children.
foreach ($children as $child) {
$exclude[] = $child->tid;
}
$exclude[] = $tid;
$tree = $taxonomy_storage->loadTree($vid, 0, NULL, TRUE);
$options[0] = '<' . $this->t('root') . '>';
if ($tree) {
foreach ($tree as $term) {
if (!in_array($term->id(), $exclude)) {
$options[$term->id()] = str_repeat(' -- ', $term->depth) . $term->getName();
}
}
}
$description = $this->t('Forums may be placed at the top (root) level, or inside another container or forum.');
return [
'#type' => 'select',
'#title' => $title,
'#default_value' => $parent,
'#options' => $options,
'#description' => $description,
'#required' => TRUE,
];
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
ContentEntityForm::$entity | protected | property | The entity being used by this form. | Overrides EntityForm::$entity | 10 | |
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 | Copies top-level form values to entity properties | Overrides EntityForm::copyFormValuesToEntity | ||
ContentEntityForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | 10 | |
ContentEntityForm::getBundleEntity | protected | function | Returns the bundle entity of the entity, or NULL if there is none. | |||
ContentEntityForm::getFormDisplay | public | function | Gets the form display. | Overrides ContentEntityFormInterface::getFormDisplay | ||
ContentEntityForm::getFormLangcode | public | function | Gets the code identifying the active form language. | Overrides ContentEntityFormInterface::getFormLangcode | ||
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. | Overrides EntityForm::init | 1 | |
ContentEntityForm::initFormLangcodes | protected | function | Initializes form language code values. | |||
ContentEntityForm::isDefaultFormLangcode | public | function | Checks whether the current form language matches the entity one. | Overrides ContentEntityFormInterface::isDefaultFormLangcode | ||
ContentEntityForm::prepareEntity | protected | function | Prepares the entity object before the form is built first. | Overrides EntityForm::prepareEntity | 1 | |
ContentEntityForm::setFormDisplay | public | function | Sets the form display. | Overrides ContentEntityFormInterface::setFormDisplay | ||
ContentEntityForm::showRevisionUi | protected | function | Checks whether the revision form fields should be added to the form. | |||
ContentEntityForm::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 | 4 | |
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. | 10 | ||
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 | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
EntityForm::$entityTypeManager | protected | property | The entity type manager. | 3 | ||
EntityForm::$moduleHandler | protected | property | The module handler service. | |||
EntityForm::$operation | protected | property | The name of the current operation. | |||
EntityForm::$privateEntityManager | private | property | The entity manager. | |||
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 | Form constructor. | Overrides FormInterface::buildForm | 13 | |
EntityForm::getBaseFormId | public | function | Returns a string identifying the base form. | Overrides BaseFormIdInterface::getBaseFormId | 6 | |
EntityForm::getEntity | public | function | Gets the form entity. | Overrides EntityFormInterface::getEntity | ||
EntityForm::getEntityFromRouteMatch | public | function | Determines which entity will be used by this form from a RouteMatch object. | Overrides EntityFormInterface::getEntityFromRouteMatch | 3 | |
EntityForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | 12 | |
EntityForm::getOperation | public | function | Gets the operation identifying the form. | Overrides EntityFormInterface::getOperation | ||
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 | Sets the form entity. | Overrides EntityFormInterface::setEntity | ||
EntityForm::setEntityManager | public | function | Sets the entity manager for this form. | Overrides EntityFormInterface::setEntityManager | ||
EntityForm::setEntityTypeManager | public | function | Sets the entity type manager for this form. | Overrides EntityFormInterface::setEntityTypeManager | ||
EntityForm::setModuleHandler | public | function | Sets the module handler for this form. | Overrides EntityFormInterface::setModuleHandler | ||
EntityForm::setOperation | public | function | Sets the operation for this form. | Overrides EntityFormInterface::setOperation | ||
EntityForm::__get | public | function | ||||
EntityForm::__set | public | function | ||||
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. | Overrides UrlGeneratorTrait::redirect | ||
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. | |||
ForumForm::$forumFormType | protected | property | Reusable type field to use in status messages. | |||
ForumForm::$urlStub | protected | property | Reusable url stub to use in watchdog messages. | 1 | ||
ForumForm::actions | protected | function | Returns an array of supported actions for the current entity form. | Overrides EntityForm::actions | ||
ForumForm::buildEntity | public | function | Builds an updated entity object based upon the submitted form values. | Overrides TermForm::buildEntity | 1 | |
ForumForm::form | public | function | Gets the actual form array to be built. | Overrides TermForm::form | 1 | |
ForumForm::forumParentSelect | protected | function | Returns a select box for available parent terms. | |||
ForumForm::save | public | function | Form submission handler for the 'save' action. | Overrides TermForm::save | ||
LinkGeneratorTrait::$linkGenerator | protected | property | The link generator. | 1 | ||
LinkGeneratorTrait::getLinkGenerator | Deprecated | protected | function | Returns the link generator. | ||
LinkGeneratorTrait::l | Deprecated | protected | function | Renders a link to a route given a route name and its parameters. | ||
LinkGeneratorTrait::setLinkGenerator | Deprecated | public | function | Sets the link generator service. | ||
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. | 17 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | ||
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. | |||
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. | |||
TermForm::flagViolations | protected | function | Flags violations for the current form. | Overrides ContentEntityForm::flagViolations | ||
TermForm::getEditedFieldNames | protected | function | Gets the names of all fields edited in the form. | Overrides ContentEntityForm::getEditedFieldNames | ||
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 | ||
UrlGeneratorTrait::$urlGenerator | protected | property | The url generator. | |||
UrlGeneratorTrait::getUrlGenerator | Deprecated | protected | function | Returns the URL generator service. | ||
UrlGeneratorTrait::setUrlGenerator | Deprecated | public | function | Sets the URL generator service. | ||
UrlGeneratorTrait::url | Deprecated | protected | function | Generates a URL or path for a specific route based on the given parameters. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.