You are here

class InaccessibleMenuLink in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Menu/InaccessibleMenuLink.php \Drupal\Core\Menu\InaccessibleMenuLink

A menu link plugin for wrapping another menu link, in sensitive situations.

Hierarchy

Expanded class hierarchy of InaccessibleMenuLink

See also

\Drupal\Core\Menu\DefaultMenuLinkTreeManipulators::checkAccess()

File

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

Namespace

Drupal\Core\Menu
View 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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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. Overrides PluginBase::__construct
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::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::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
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.