class MenuLinkDefault in Drupal 9
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Menu/MenuLinkDefault.php \Drupal\Core\Menu\MenuLinkDefault
Provides a default implementation for menu link plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Menu\MenuLinkBase implements MenuLinkInterface
- class \Drupal\Core\Menu\MenuLinkDefault implements ContainerFactoryPluginInterface
- class \Drupal\Core\Menu\MenuLinkBase implements MenuLinkInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
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 11
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 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MenuLinkBase:: |
public | function |
Deletes a menu link. Overrides MenuLinkInterface:: |
2 |
MenuLinkBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
3 |
MenuLinkBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
2 |
MenuLinkBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
2 |
MenuLinkBase:: |
public | function |
Returns route information for a route to delete the menu link. Overrides MenuLinkInterface:: |
1 |
MenuLinkBase:: |
public | function |
Returns route information for a custom edit form for the menu link. Overrides MenuLinkInterface:: |
1 |
MenuLinkBase:: |
public | function |
Returns the name of a class that can build an editing form for this link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the menu name of the menu link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns any metadata for this link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the options for this link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the plugin ID of the menu link's parent, or an empty string. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the provider (module name) of the menu link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the route name, if available. Overrides MenuLinkInterface:: |
2 |
MenuLinkBase:: |
public | function |
Returns the route parameters, if available. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns route information for a route to translate the menu link. Overrides MenuLinkInterface:: |
1 |
MenuLinkBase:: |
public | function |
Returns a URL object containing either the external path or route. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns the weight of the menu link. Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns whether this link can be deleted. Overrides MenuLinkInterface:: |
2 |
MenuLinkBase:: |
public | function |
Returns whether the menu link is enabled (not hidden). Overrides MenuLinkInterface:: |
|
MenuLinkBase:: |
public | function |
Returns whether the child menu links should always been shown. Overrides MenuLinkInterface:: |
1 |
MenuLinkBase:: |
public | function |
Returns whether this link can be translated. Overrides MenuLinkInterface:: |
1 |
MenuLinkDefault:: |
protected | property |
The list of definition values where an override is allowed. Overrides MenuLinkBase:: |
|
MenuLinkDefault:: |
protected | property | The static menu link service used to store updates to weight/parent etc. | |
MenuLinkDefault:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
1 |
MenuLinkDefault:: |
public | function |
Returns the description of the menu link. Overrides MenuLinkInterface:: |
|
MenuLinkDefault:: |
public | function |
Returns the localized title to be shown for this link. Overrides MenuLinkInterface:: |
1 |
MenuLinkDefault:: |
public | function |
Returns whether this link can be reset. Overrides MenuLinkBase:: |
|
MenuLinkDefault:: |
public | function |
Updates the definition values for a menu link. Overrides MenuLinkInterface:: |
|
MenuLinkDefault:: |
public | function |
Constructs a new MenuLinkDefault. Overrides PluginBase:: |
1 |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |