abstract class MenuLinkBase in Drupal 8

Defines a base menu link class.

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

3 files declare their use of MenuLinkBase

MenuLinkContent.php in core/modules/menu_link_content/src/Plugin/Menu/MenuLinkContent.php

MenuLinkMock.php in core/tests/Drupal/Tests/Core/Menu/MenuLinkMock.php

ViewsMenuLink.php in core/modules/views/src/Plugin/Menu/ViewsMenuLink.php

File

core/lib/Drupal/Core/Menu/MenuLinkBase.php, line 13

Namespace

Drupal\Core\Menu

abstract class MenuLinkBase extends PluginBase implements MenuLinkInterface {

  /**
   * The list of definition values where an override is allowed.
   *
   * The keys are definition names. The values are ignored.
   *
   * @var array
   */
  protected $overrideAllowed = [];

  /**
   * {@inheritdoc}
   */
  public function getWeight() {

    // By default the weight is 0.
    if (!isset($this->pluginDefinition['weight'])) {
      $this->pluginDefinition['weight'] = 0;
    }
    return $this->pluginDefinition['weight'];
  }

  /**
   * {@inheritdoc}
   */
  public function getMenuName() {
    return $this->pluginDefinition['menu_name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getProvider() {
    return $this->pluginDefinition['provider'];
  }

  /**
   * {@inheritdoc}
   */
  public function getParent() {
    return $this->pluginDefinition['parent'];
  }

  /**
   * {@inheritdoc}
   */
  public function isEnabled() {
    return (bool) $this->pluginDefinition['enabled'];
  }

  /**
   * {@inheritdoc}
   */
  public function isExpanded() {
    return (bool) $this->pluginDefinition['expanded'];
  }

  /**
   * {@inheritdoc}
   */
  public function isResettable() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function isTranslatable() {
    return (bool) $this
      ->getTranslateRoute();
  }

  /**
   * {@inheritdoc}
   */
  public function isDeletable() {
    return (bool) $this
      ->getDeleteRoute();
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    return $this->pluginDefinition['options'] ?: [];
  }

  /**
   * {@inheritdoc}
   */
  public function getMetaData() {
    return $this->pluginDefinition['metadata'] ?: [];
  }

  /**
   * {@inheritdoc}
   */
  public function getRouteName() {
    return isset($this->pluginDefinition['route_name']) ? $this->pluginDefinition['route_name'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getRouteParameters() {
    return isset($this->pluginDefinition['route_parameters']) ? $this->pluginDefinition['route_parameters'] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function getUrlObject($title_attribute = TRUE) {
    $options = $this
      ->getOptions();
    if ($title_attribute && ($description = $this
      ->getDescription())) {
      $options['attributes']['title'] = $description;
    }
    if (empty($this->pluginDefinition['url'])) {
      return new Url($this
        ->getRouteName(), $this
        ->getRouteParameters(), $options);
    }
    else {
      return Url::fromUri($this->pluginDefinition['url'], $options);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getFormClass() {
    return $this->pluginDefinition['form_class'];
  }

  /**
   * {@inheritdoc}
   */
  public function getDeleteRoute() {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getEditRoute() {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getTranslateRoute() {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteLink() {
    throw new PluginException("Menu link plugin with ID '{$this->getPluginId()}' does not support deletion");
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return Cache::PERMANENT;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	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		1
DependencySerializationTrait::__wakeup	public	function		2
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::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::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
MenuLinkInterface::getDescription	public	function	Returns the description of the menu link.	5
MenuLinkInterface::getTitle	public	function	Returns the localized title to be shown for this link.	5
MenuLinkInterface::updateLink	public	function	Updates the definition values for a menu link.	5
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.