interface MenuLinkInterface

Defines an interface for classes providing a type of menu link.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Core\Cache\CacheableDependencyInterface
  • interface \Drupal\Core\Menu\MenuLinkInterface

File

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

Namespace

Drupal\Core\Menu

Members

Name	Modifiers	Type	Description
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.
MenuLinkInterface::deleteLink	public	function	Deletes a menu link.
MenuLinkInterface::getDeleteRoute	public	function	Returns route information for a route to delete the menu link.
MenuLinkInterface::getDescription	public	function	Returns the description of the menu link.
MenuLinkInterface::getEditRoute	public	function	Returns route information for a custom edit form for the menu link.
MenuLinkInterface::getFormClass	public	function	Returns the name of a class that can build an editing form for this link.
MenuLinkInterface::getMenuName	public	function	Returns the menu name of the menu link.
MenuLinkInterface::getMetaData	public	function	Returns any metadata for this link.
MenuLinkInterface::getOptions	public	function	Returns the options for this link.
MenuLinkInterface::getParent	public	function	Returns the plugin ID of the menu link's parent, or an empty string.
MenuLinkInterface::getProvider	public	function	Returns the provider (module name) of the menu link.
MenuLinkInterface::getRouteName	public	function	Returns the route name, if available.
MenuLinkInterface::getRouteParameters	public	function	Returns the route parameters, if available.
MenuLinkInterface::getTitle	public	function	Returns the localized title to be shown for this link.
MenuLinkInterface::getTranslateRoute	public	function	Returns route information for a route to translate the menu link.
MenuLinkInterface::getUrlObject	public	function	Returns a URL object containing either the external path or route.
MenuLinkInterface::getWeight	public	function	Returns the weight of the menu link.
MenuLinkInterface::isDeletable	public	function	Returns whether this link can be deleted.
MenuLinkInterface::isEnabled	public	function	Returns whether the menu link is enabled (not hidden).
MenuLinkInterface::isExpanded	public	function	Returns whether the child menu links should always been shown.
MenuLinkInterface::isResettable	public	function	Returns whether this link can be reset.
MenuLinkInterface::isTranslatable	public	function	Returns whether this link can be translated.
MenuLinkInterface::updateLink	public	function	Updates the definition values for a menu link.
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.