class MenuLinkDefault
Provides a default implementation for menu link plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\Core\Menu\MenuLinkBase implements \Drupal\Core\Menu\MenuLinkInterface extends \Drupal\Core\Plugin\PluginBase- class \Drupal\Core\Menu\MenuLinkDefault implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface extends \Drupal\Core\Menu\MenuLinkBase
 
 
- class \Drupal\Core\Menu\MenuLinkBase implements \Drupal\Core\Menu\MenuLinkInterface extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of MenuLinkDefault
6 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 
- NavigationMenuLinkTreeManipulators.php in core/modules/ navigation/ src/ Menu/ NavigationMenuLinkTreeManipulators.php 
File
- 
              core/lib/ Drupal/ Core/ Menu/ MenuLinkDefault.php, line 12 
Namespace
Drupal\Core\MenuView 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 | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| 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 | Instantiates a new instance of the implementing class using autowiring. | Overrides PluginBase::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. | Overrides PluginBase::__construct | 1 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
| PluginBase::$pluginId | protected | property | The plugin ID. | |||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
| PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
| 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. | 1 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
