class MenuLinkEditForm

Same name and namespace in other branches
  1. 9 core/modules/menu_ui/src/Form/MenuLinkEditForm.php \Drupal\menu_ui\Form\MenuLinkEditForm
  2. 8.9.x core/modules/menu_ui/src/Form/MenuLinkEditForm.php \Drupal\menu_ui\Form\MenuLinkEditForm
  3. 10 core/modules/menu_ui/src/Form/MenuLinkEditForm.php \Drupal\menu_ui\Form\MenuLinkEditForm

Defines a generic edit form for all menu link plugin types.

The menu link plugin defines which class defines the corresponding form.

@internal

Hierarchy

Expanded class hierarchy of MenuLinkEditForm

See also

\Drupal\Core\Menu\MenuLinkInterface::getFormClass()

1 string reference to 'MenuLinkEditForm'
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/MenuLinkEditForm.php, line 20

Namespace

Drupal\menu_ui\Form
View source
class MenuLinkEditForm extends FormBase {
    
    /**
     * The class resolver.
     *
     * @var \Drupal\Core\DependencyInjection\ClassResolverInterface
     */
    protected $classResolver;
    
    /**
     * Constructs a MenuLinkEditForm object.
     *
     * @param \Drupal\Core\DependencyInjection\ClassResolverInterface $class_resolver
     *   The class resolver.
     */
    public function __construct(ClassResolverInterface $class_resolver) {
        $this->classResolver = $class_resolver;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('class_resolver'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'menu_link_edit';
    }
    
    /**
     * {@inheritdoc}
     *
     * @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.
     * @param \Drupal\Core\Menu\MenuLinkInterface $menu_link_plugin
     *   The plugin instance to use for this form.
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?MenuLinkInterface $menu_link_plugin = NULL) {
        $form['menu_link_id'] = [
            '#type' => 'value',
            '#value' => $menu_link_plugin->getPluginId(),
        ];
        $class_name = $menu_link_plugin->getFormClass();
        $form['#plugin_form'] = $this->classResolver
            ->getInstanceFromDefinition($class_name);
        $form['#plugin_form']->setMenuLinkInstance($menu_link_plugin);
        $form += $form['#plugin_form']->buildConfigurationForm($form, $form_state);
        $form['actions'] = [
            '#type' => 'actions',
        ];
        $form['actions']['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Save'),
            '#button_type' => 'primary',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        $form['#plugin_form']->validateConfigurationForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $link = $form['#plugin_form']->submitConfigurationForm($form, $form_state);
        $this->messenger()
            ->addStatus($this->t('The menu link has been saved.'));
        $form_state->setRedirect('entity.menu.edit_form', [
            'menu' => $link->getMenuName(),
        ]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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. 2
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. 2
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::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.
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.
MenuLinkEditForm::$classResolver protected property The class resolver.
MenuLinkEditForm::buildForm public function Overrides FormInterface::buildForm
MenuLinkEditForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MenuLinkEditForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MenuLinkEditForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
MenuLinkEditForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
MenuLinkEditForm::__construct public function Constructs a MenuLinkEditForm object.
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
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.