class 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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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 #[\ReturnTypeWillChange] 2
InaccessibleMenuLink::$wrappedLink protected property The wrapped menu link.
InaccessibleMenuLink::getCacheContexts public function Overrides MenuLinkBase::getCacheContexts
InaccessibleMenuLink::getCacheMaxAge public function Overrides MenuLinkBase::getCacheMaxAge
InaccessibleMenuLink::getCacheTags public function Overrides MenuLinkBase::getCacheTags
InaccessibleMenuLink::getDescription public function Overrides MenuLinkInterface::getDescription
InaccessibleMenuLink::getTitle public function Overrides MenuLinkInterface::getTitle
InaccessibleMenuLink::updateLink public function 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 Overrides MenuLinkInterface::deleteLink 2
MenuLinkBase::getDeleteRoute public function Overrides MenuLinkInterface::getDeleteRoute 1
MenuLinkBase::getEditRoute public function Overrides MenuLinkInterface::getEditRoute 1
MenuLinkBase::getFormClass public function Overrides MenuLinkInterface::getFormClass
MenuLinkBase::getMenuName public function Overrides MenuLinkInterface::getMenuName
MenuLinkBase::getMetaData public function Overrides MenuLinkInterface::getMetaData
MenuLinkBase::getOptions public function Overrides MenuLinkInterface::getOptions
MenuLinkBase::getParent public function Overrides MenuLinkInterface::getParent
MenuLinkBase::getProvider public function Overrides MenuLinkInterface::getProvider
MenuLinkBase::getRouteName public function Overrides MenuLinkInterface::getRouteName 2
MenuLinkBase::getRouteParameters public function Overrides MenuLinkInterface::getRouteParameters
MenuLinkBase::getTranslateRoute public function Overrides MenuLinkInterface::getTranslateRoute 1
MenuLinkBase::getUrlObject public function Overrides MenuLinkInterface::getUrlObject
MenuLinkBase::getWeight public function Overrides MenuLinkInterface::getWeight
MenuLinkBase::isDeletable public function Overrides MenuLinkInterface::isDeletable 2
MenuLinkBase::isEnabled public function Overrides MenuLinkInterface::isEnabled
MenuLinkBase::isExpanded public function Overrides MenuLinkInterface::isExpanded 1
MenuLinkBase::isResettable public function Overrides MenuLinkInterface::isResettable 1
MenuLinkBase::isTranslatable public function 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 Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable 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.

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