class MenuLinkDefault

Same name in other branches
  1. 9 core/lib/Drupal/Core/Menu/MenuLinkDefault.php \Drupal\Core\Menu\MenuLinkDefault
  2. 8.9.x core/lib/Drupal/Core/Menu/MenuLinkDefault.php \Drupal\Core\Menu\MenuLinkDefault
  3. 11.x core/lib/Drupal/Core/Menu/MenuLinkDefault.php \Drupal\Core\Menu\MenuLinkDefault

Provides a default implementation for menu link plugins.

Hierarchy

Expanded class hierarchy of MenuLinkDefault

4 files declare their use of MenuLinkDefault
LoginLogoutMenuLink.php in core/modules/user/src/Plugin/Menu/LoginLogoutMenuLink.php
MenuLinkDefaultFormTest.php in core/tests/Drupal/Tests/Core/Menu/MenuLinkDefaultFormTest.php
MenuLinkDefaultTest.php in core/tests/Drupal/Tests/Core/Menu/MenuLinkDefaultTest.php
MenuLinkParentTest.php in core/modules/migrate/tests/src/Unit/process/MenuLinkParentTest.php

File

core/lib/Drupal/Core/Menu/MenuLinkDefault.php, line 12

Namespace

Drupal\Core\Menu
View source
class MenuLinkDefault extends MenuLinkBase implements ContainerFactoryPluginInterface {
    
    /**
     * {@inheritdoc}
     */
    protected $overrideAllowed = [
        'menu_name' => 1,
        'parent' => 1,
        'weight' => 1,
        'expanded' => 1,
        'enabled' => 1,
    ];
    
    /**
     * The static menu link service used to store updates to weight/parent etc.
     *
     * @var \Drupal\Core\Menu\StaticMenuLinkOverridesInterface
     */
    protected $staticOverride;
    
    /**
     * Constructs a new MenuLinkDefault.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Menu\StaticMenuLinkOverridesInterface $static_override
     *   The static override storage.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, StaticMenuLinkOverridesInterface $static_override) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->staticOverride = $static_override;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('menu_link.static.overrides'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTitle() {
        return (string) $this->pluginDefinition['title'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDescription() {
        return (string) $this->pluginDefinition['description'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function isResettable() {
        // The link can be reset if it has an override.
        return (bool) $this->staticOverride
            ->loadOverride($this->getPluginId());
    }
    
    /**
     * {@inheritdoc}
     */
    public function getResetRoute() : Url {
        return Url::fromRoute('menu_ui.link_reset', [
            'menu_link_plugin' => $this->getPluginId(),
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    public function updateLink(array $new_definition_values, $persist) {
        // Filter the list of updates to only those that are allowed.
        $overrides = array_intersect_key($new_definition_values, $this->overrideAllowed);
        // Update the definition.
        $this->pluginDefinition = $overrides + $this->getPluginDefinition();
        if ($persist) {
            // Always save the menu name as an override to avoid defaulting to tools.
            $overrides['menu_name'] = $this->pluginDefinition['menu_name'];
            $this->staticOverride
                ->saveOverride($this->getPluginId(), $this->pluginDefinition);
        }
        return $this->pluginDefinition;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
MenuLinkBase::deleteLink public function Deletes a menu link. Overrides MenuLinkInterface::deleteLink 2
MenuLinkBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 3
MenuLinkBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 2
MenuLinkBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 2
MenuLinkBase::getDeleteRoute public function Returns route information for a route to delete the menu link. Overrides MenuLinkInterface::getDeleteRoute 1
MenuLinkBase::getEditRoute public function Returns route information for a custom edit form for the menu link. Overrides MenuLinkInterface::getEditRoute 1
MenuLinkBase::getFormClass public function Returns the name of a class that can build an editing form for this link. Overrides MenuLinkInterface::getFormClass
MenuLinkBase::getMenuName public function Returns the menu name of the menu link. Overrides MenuLinkInterface::getMenuName
MenuLinkBase::getMetaData public function Returns any metadata for this link. Overrides MenuLinkInterface::getMetaData
MenuLinkBase::getOperations public function Provides an array of information to build a list of operation links. Overrides MenuLinkInterface::getOperations 1
MenuLinkBase::getOptions public function Returns the options for this link. Overrides MenuLinkInterface::getOptions
MenuLinkBase::getParent public function Returns the plugin ID of the menu link's parent, or an empty string. Overrides MenuLinkInterface::getParent
MenuLinkBase::getProvider public function Returns the provider (module name) of the menu link. Overrides MenuLinkInterface::getProvider
MenuLinkBase::getRouteName public function Returns the route name, if available. Overrides MenuLinkInterface::getRouteName 2
MenuLinkBase::getRouteParameters public function Returns the route parameters, if available. Overrides MenuLinkInterface::getRouteParameters
MenuLinkBase::getTranslateRoute public function Returns route information for a route to translate the menu link. Overrides MenuLinkInterface::getTranslateRoute 1
MenuLinkBase::getUrlObject public function Returns a URL object containing either the external path or route. Overrides MenuLinkInterface::getUrlObject
MenuLinkBase::getWeight public function Returns the weight of the menu link. Overrides MenuLinkInterface::getWeight
MenuLinkBase::isDeletable public function Returns whether this link can be deleted. Overrides MenuLinkInterface::isDeletable 2
MenuLinkBase::isEnabled public function Returns whether the menu link is enabled (not hidden). Overrides MenuLinkInterface::isEnabled
MenuLinkBase::isExpanded public function Returns whether the child menu links should always been shown. Overrides MenuLinkInterface::isExpanded 1
MenuLinkBase::isTranslatable public function Returns whether this link can be translated. Overrides MenuLinkInterface::isTranslatable 1
MenuLinkDefault::$overrideAllowed protected property The list of definition values where an override is allowed. Overrides MenuLinkBase::$overrideAllowed
MenuLinkDefault::$staticOverride protected property The static menu link service used to store updates to weight/parent etc.
MenuLinkDefault::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
MenuLinkDefault::getDescription public function Returns the description of the menu link. Overrides MenuLinkInterface::getDescription
MenuLinkDefault::getResetRoute public function Returns route information for a route to reset the menu link. Overrides MenuLinkBase::getResetRoute
MenuLinkDefault::getTitle public function Returns the localized title to be shown for this link. Overrides MenuLinkInterface::getTitle 1
MenuLinkDefault::isResettable public function Returns whether this link can be reset. Overrides MenuLinkBase::isResettable
MenuLinkDefault::updateLink public function Updates the definition values for a menu link. Overrides MenuLinkInterface::updateLink
MenuLinkDefault::__construct public function Constructs a new MenuLinkDefault. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2

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