class MenuDeleteForm in Drupal 10
Same name and namespace in other branches
- 8 core/modules/menu_ui/src/Form/MenuDeleteForm.php \Drupal\menu_ui\Form\MenuDeleteForm
- 9 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 ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\EntityDeleteForm uses EntityDeleteFormTrait
- class \Drupal\menu_ui\Form\MenuDeleteForm
- class \Drupal\Core\Entity\EntityDeleteForm uses EntityDeleteFormTrait
- class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
- class \Drupal\Core\Entity\EntityForm implements 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigDependencyDeleteFormTrait:: |
protected | function | Adds form elements to list affected configuration entities. | |
ConfigDependencyDeleteFormTrait:: |
abstract protected | function | Translates a string to the current language or to a given language. | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityConfirmFormBase:: |
protected | function | 1 | |
EntityConfirmFormBase:: |
public | function | The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. | |
EntityConfirmFormBase:: |
public | function | ||
EntityConfirmFormBase:: |
public | function | ||
EntityConfirmFormBase:: |
public | function | ||
EntityConfirmFormBase:: |
public | function | The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. | |
EntityDeleteForm:: |
public | function |
Form constructor. Overrides EntityConfirmFormBase:: |
6 |
EntityDeleteForm:: |
protected | function | Gets the configuration manager. | |
EntityDeleteForm:: |
protected | function | Returns config names to delete for the deletion confirmation form. | 1 |
EntityDeleteFormTrait:: |
public | function | 3 | |
EntityDeleteFormTrait:: |
public | function | 1 | |
EntityDeleteFormTrait:: |
protected | function | Gets the message to display to the user after deleting the entity. | 3 |
EntityDeleteFormTrait:: |
abstract public | function | Gets the entity of this form. | |
EntityDeleteFormTrait:: |
public | function | 4 | |
EntityDeleteFormTrait:: |
protected | function | Returns the URL where the user should be redirected after deletion. | 4 |
EntityDeleteFormTrait:: |
abstract protected | function | Gets the logger for a specific channel. | |
EntityForm:: |
protected | property | The entity being used by this form. | 11 |
EntityForm:: |
protected | property | The entity type manager. | 2 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties. | 9 |
EntityForm:: |
public | function | Gets the actual form array to be built. | 27 |
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
3 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
11 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The request stack. | |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Returns a redirect response object for the specified route. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
65 |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MenuDeleteForm:: |
protected | property | The database connection. | |
MenuDeleteForm:: |
protected | property | The menu link manager. | |
MenuDeleteForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
MenuDeleteForm:: |
public | function |
Returns additional text to display as a description. Overrides EntityConfirmFormBase:: |
|
MenuDeleteForm:: |
protected | function |
Logs a message about the deleted entity. Overrides EntityDeleteFormTrait:: |
|
MenuDeleteForm:: |
public | function |
Overrides EntityDeleteFormTrait:: |
|
MenuDeleteForm:: |
public | function | Constructs a new MenuDeleteForm. | |
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 1 |