class InaccessibleMenuLink
Same name in other branches
- 9 core/lib/Drupal/Core/Menu/InaccessibleMenuLink.php \Drupal\Core\Menu\InaccessibleMenuLink
- 8.9.x core/lib/Drupal/Core/Menu/InaccessibleMenuLink.php \Drupal\Core\Menu\InaccessibleMenuLink
- 10 core/lib/Drupal/Core/Menu/InaccessibleMenuLink.php \Drupal\Core\Menu\InaccessibleMenuLink
A menu link plugin for wrapping another menu link, in sensitive situations.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Menu\MenuLinkBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Menu\MenuLinkInterface
- class \Drupal\Core\Menu\InaccessibleMenuLink extends \Drupal\Core\Menu\MenuLinkBase
- class \Drupal\Core\Menu\MenuLinkBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Menu\MenuLinkInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of InaccessibleMenuLink
See also
\Drupal\Core\Menu\DefaultMenuLinkTreeManipulators::checkAccess()
1 file declares its use of InaccessibleMenuLink
- MenuLinkTreeTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Menu/ MenuLinkTreeTest.php
File
-
core/
lib/ Drupal/ Core/ Menu/ InaccessibleMenuLink.php, line 12
Namespace
Drupal\Core\MenuView source
class InaccessibleMenuLink extends MenuLinkBase {
/**
* The wrapped menu link.
*
* @var \Drupal\Core\Menu\MenuLinkInterface
*/
protected $wrappedLink;
/**
* Constructs a new InaccessibleMenuLink.
*
* @param \Drupal\Core\Menu\MenuLinkInterface $wrapped_link
* The menu link to wrap.
*/
public function __construct(MenuLinkInterface $wrapped_link) {
$this->wrappedLink = $wrapped_link;
$plugin_definition = [
'route_name' => '<front>',
'route_parameters' => [],
'url' => NULL,
] + $this->wrappedLink
->getPluginDefinition();
parent::__construct([], $this->wrappedLink
->getPluginId(), $plugin_definition);
}
/**
* {@inheritdoc}
*/
public function getTitle() {
return $this->t('Inaccessible');
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return '';
}
/**
* {@inheritdoc}
*/
public function getCacheContexts() {
return $this->wrappedLink
->getCacheContexts();
}
/**
* {@inheritdoc}
*/
public function getCacheTags() {
return $this->wrappedLink
->getCacheTags();
}
/**
* {@inheritdoc}
*/
public function getCacheMaxAge() {
return $this->wrappedLink
->getCacheMaxAge();
}
/**
* {@inheritdoc}
*/
public function updateLink(array $new_definition_values, $persist) {
throw new PluginException('Inaccessible menu link plugins do not support updating');
}
}
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 | |
InaccessibleMenuLink::$wrappedLink | protected | property | The wrapped menu link. | ||
InaccessibleMenuLink::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides MenuLinkBase::getCacheContexts | |
InaccessibleMenuLink::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides MenuLinkBase::getCacheMaxAge | |
InaccessibleMenuLink::getCacheTags | public | function | The cache tags associated with this object. | Overrides MenuLinkBase::getCacheTags | |
InaccessibleMenuLink::getDescription | public | function | Returns the description of the menu link. | Overrides MenuLinkInterface::getDescription | |
InaccessibleMenuLink::getTitle | public | function | Returns the localized title to be shown for this link. | Overrides MenuLinkInterface::getTitle | |
InaccessibleMenuLink::updateLink | public | function | Updates the definition values for a menu link. | Overrides MenuLinkInterface::updateLink | |
InaccessibleMenuLink::__construct | public | function | Constructs a new InaccessibleMenuLink. | ||
MenuLinkBase::$overrideAllowed | protected | property | The list of definition values where an override is allowed. | 3 | |
MenuLinkBase::deleteLink | public | function | Deletes a menu link. | Overrides MenuLinkInterface::deleteLink | 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::getResetRoute | public | function | Returns route information for a route to reset the menu link. | Overrides MenuLinkInterface::getResetRoute | 1 |
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::isResettable | public | function | Returns whether this link can be reset. | Overrides MenuLinkInterface::isResettable | 1 |
MenuLinkBase::isTranslatable | public | function | Returns whether this link can be translated. | Overrides MenuLinkInterface::isTranslatable | 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.