class MenuLinkResetForm

Same name in other branches
  1. 8.9.x core/modules/menu_ui/src/Form/MenuLinkResetForm.php \Drupal\menu_ui\Form\MenuLinkResetForm
  2. 10 core/modules/menu_ui/src/Form/MenuLinkResetForm.php \Drupal\menu_ui\Form\MenuLinkResetForm
  3. 11.x core/modules/menu_ui/src/Form/MenuLinkResetForm.php \Drupal\menu_ui\Form\MenuLinkResetForm

Defines a confirmation form for resetting a single modified menu link.

@internal

Hierarchy

Expanded class hierarchy of MenuLinkResetForm

1 string reference to 'MenuLinkResetForm'
menu_ui.routing.yml in core/modules/menu_ui/menu_ui.routing.yml
core/modules/menu_ui/menu_ui.routing.yml

File

core/modules/menu_ui/src/Form/MenuLinkResetForm.php, line 18

Namespace

Drupal\menu_ui\Form
View source
class MenuLinkResetForm extends ConfirmFormBase {
    
    /**
     * The menu link manager.
     *
     * @var \Drupal\Core\Menu\MenuLinkManagerInterface
     */
    protected $menuLinkManager;
    
    /**
     * The menu link.
     *
     * @var \Drupal\Core\Menu\MenuLinkInterface
     */
    protected $link;
    
    /**
     * Constructs a MenuLinkResetForm object.
     *
     * @param \Drupal\Core\Menu\MenuLinkManagerInterface $menu_link_manager
     *   The menu link manager.
     */
    public function __construct(MenuLinkManagerInterface $menu_link_manager) {
        $this->menuLinkManager = $menu_link_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('plugin.manager.menu.link'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'menu_link_reset_confirm';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getQuestion() {
        return $this->t('Are you sure you want to reset the link %item to its default values?', [
            '%item' => $this->link
                ->getTitle(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCancelUrl() {
        return new Url('entity.menu.edit_form', [
            'menu' => $this->link
                ->getMenuName(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return $this->t('Any customizations will be lost. This action cannot be undone.');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfirmText() {
        return $this->t('Reset');
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, MenuLinkInterface $menu_link_plugin = NULL) {
        $this->link = $menu_link_plugin;
        $form = parent::buildForm($form, $form_state);
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->link = $this->menuLinkManager
            ->resetLink($this->link
            ->getPluginId());
        $this->messenger()
            ->addStatus($this->t('The menu link was reset to its default settings.'));
        $form_state->setRedirectUrl($this->getCancelUrl());
    }
    
    /**
     * Checks access based on whether the link can be reset.
     *
     * @param \Drupal\Core\Menu\MenuLinkInterface $menu_link_plugin
     *   The menu link plugin being checked.
     *
     * @return \Drupal\Core\Access\AccessResultInterface
     *   The access result.
     */
    public function linkIsResettable(MenuLinkInterface $menu_link_plugin) {
        return AccessResult::allowedIf($menu_link_plugin->isResettable())
            ->setCacheMaxAge(0);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
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.
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 73
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.
MenuLinkResetForm::$link protected property The menu link.
MenuLinkResetForm::$menuLinkManager protected property The menu link manager.
MenuLinkResetForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
MenuLinkResetForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MenuLinkResetForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
MenuLinkResetForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
MenuLinkResetForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
MenuLinkResetForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MenuLinkResetForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
MenuLinkResetForm::linkIsResettable public function Checks access based on whether the link can be reset.
MenuLinkResetForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
MenuLinkResetForm::__construct public function Constructs a MenuLinkResetForm object.
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. 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.

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