class MenuDeleteForm
Same name in other branches
- 9 core/modules/menu_ui/src/Form/MenuDeleteForm.php \Drupal\menu_ui\Form\MenuDeleteForm
- 8.9.x core/modules/menu_ui/src/Form/MenuDeleteForm.php \Drupal\menu_ui\Form\MenuDeleteForm
- 11.x core/modules/menu_ui/src/Form/MenuDeleteForm.php \Drupal\menu_ui\Form\MenuDeleteForm
Defines a confirmation form for deletion of a custom menu.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
- class \Drupal\Core\Entity\EntityConfirmFormBase extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\Core\Entity\EntityDeleteForm extends \Drupal\Core\Entity\EntityConfirmFormBase uses \Drupal\Core\Entity\EntityDeleteFormTrait
- class \Drupal\menu_ui\Form\MenuDeleteForm extends \Drupal\Core\Entity\EntityDeleteForm
- class \Drupal\Core\Entity\EntityDeleteForm extends \Drupal\Core\Entity\EntityConfirmFormBase uses \Drupal\Core\Entity\EntityDeleteFormTrait
- class \Drupal\Core\Entity\EntityConfirmFormBase extends \Drupal\Core\Entity\EntityForm implements \Drupal\Core\Form\ConfirmFormInterface
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Form\FormBase implements \Drupal\Core\Entity\EntityFormInterface
Expanded class hierarchy of MenuDeleteForm
File
-
core/
modules/ menu_ui/ src/ Form/ MenuDeleteForm.php, line 16
Namespace
Drupal\menu_ui\FormView source
class MenuDeleteForm extends EntityDeleteForm {
/**
* The menu link manager.
*
* @var \Drupal\Core\Menu\MenuLinkManagerInterface
*/
protected $menuLinkManager;
/**
* The database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
/**
* Constructs a new MenuDeleteForm.
*
* @param \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager
* The menu link manager.
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
*/
public function __construct(MenuLinkManagerInterface $menu_link_manager, Connection $connection) {
$this->menuLinkManager = $menu_link_manager;
$this->connection = $connection;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('plugin.manager.menu.link'), $container->get('database'));
}
/**
* {@inheritdoc}
*/
public function getDescription() {
$caption = '';
$num_links = $this->menuLinkManager
->countMenuLinks($this->entity
->id());
if ($num_links) {
$caption .= '<p>' . $this->formatPlural($num_links, '<strong>Warning:</strong> There is currently 1 menu link in %title. It will be deleted (system-defined links will be reset).', '<strong>Warning:</strong> There are currently @count menu links in %title. They will be deleted (system-defined links will be reset).', [
'%title' => $this->entity
->label(),
]) . '</p>';
}
$caption .= '<p>' . $this->t('This action cannot be undone.') . '</p>';
return $caption;
}
/**
* {@inheritdoc}
*/
protected function logDeletionMessage() {
$this->logger('menu')
->notice('Deleted custom menu %title and all its menu links.', [
'%title' => $this->entity
->label(),
]);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Locked menus may not be deleted.
if ($this->entity
->isLocked()) {
return;
}
// Delete all links to the overview page for this menu.
// @todo Add a more generic helper function to the menu link plugin
// manager to remove links to an entity or other ID used as a route
// parameter that is being removed. Also, consider moving this to
// menu_ui.module as part of a generic response to entity deletion.
// https://www.drupal.org/node/2310329
$menu_links = $this->menuLinkManager
->loadLinksByRoute('entity.menu.edit_form', [
'menu' => $this->entity
->id(),
], TRUE);
foreach ($menu_links as $id => $link) {
$this->menuLinkManager
->removeDefinition($id);
}
parent::submitForm($form, $form_state);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ConfigDependencyDeleteFormTrait::addDependencyListsToForm | protected | function | Adds form elements to list affected configuration entities. | ||
ConfigDependencyDeleteFormTrait::t | abstract protected | function | Translates a string to the current language or to a given language. | ||
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
EntityConfirmFormBase::actions | protected | function | Returns an array of supported actions for the current entity form. | Overrides EntityForm::actions | 1 |
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. |
||
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::save | public | function | The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. |
Overrides EntityForm::save | |
EntityDeleteForm::buildForm | public | function | Form constructor. | Overrides EntityConfirmFormBase::buildForm | 6 |
EntityDeleteForm::getConfigManager | protected | function | Gets the configuration manager. | ||
EntityDeleteForm::getConfigNamesToDelete | protected | function | Returns config names to delete for the deletion confirmation form. | 1 | |
EntityDeleteFormTrait::getCancelUrl | public | function | 3 | ||
EntityDeleteFormTrait::getConfirmText | public | function | 1 | ||
EntityDeleteFormTrait::getDeletionMessage | protected | function | Gets the message to display to the user after deleting the entity. | 3 | |
EntityDeleteFormTrait::getEntity | abstract public | function | Gets the entity of this form. | ||
EntityDeleteFormTrait::getQuestion | public | function | 4 | ||
EntityDeleteFormTrait::getRedirectUrl | protected | function | Returns the URL where the user should be redirected after deletion. | 4 | |
EntityDeleteFormTrait::logger | abstract protected | function | Gets the logger for a specific channel. | ||
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::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::buildEntity | public | function | Builds an updated entity object based upon the submitted form values. | Overrides EntityFormInterface::buildEntity | 5 |
EntityForm::copyFormValuesToEntity | protected | function | Copies top-level form values to entity properties. | 11 | |
EntityForm::form | public | function | Gets the actual form array to be built. | 36 | |
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 | 13 |
EntityForm::getOperation | public | function | Gets the operation identifying the form. | 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 | Sets the form entity. | Overrides EntityFormInterface::setEntity | |
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 | |
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. | 2 | |
FormBase::getRequest | protected | function | Gets the request object. | ||
FormBase::getRouteMatch | protected | function | Gets the route match. | ||
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 | Form validation handler. | 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. | ||
MenuDeleteForm::$connection | protected | property | The database connection. | ||
MenuDeleteForm::$menuLinkManager | protected | property | The menu link manager. | ||
MenuDeleteForm::create | public static | function | Instantiates a new instance of this class. | Overrides FormBase::create | |
MenuDeleteForm::getDescription | public | function | Returns additional text to display as a description. | Overrides EntityConfirmFormBase::getDescription | |
MenuDeleteForm::logDeletionMessage | protected | function | Logs a message about the deleted entity. | Overrides EntityDeleteFormTrait::logDeletionMessage | |
MenuDeleteForm::submitForm | public | function | Overrides EntityDeleteFormTrait::submitForm | ||
MenuDeleteForm::__construct | public | function | Constructs a new MenuDeleteForm. | ||
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.