interface MenuTreeStorageInterface

Defines an interface for storing a menu tree containing menu link IDs.

The tree contains a hierarchy of menu links which have an ID as well as a route name or external URL.

Hierarchy

• interface \Drupal\Core\Menu\MenuTreeStorageInterface

File

core/lib/Drupal/Core/Menu/MenuTreeStorageInterface.php, line 11

Namespace

Drupal\Core\Menu

Members

Name	Modifiers	Type	Description
MenuTreeStorageInterface::countMenuLinks	public	function	Counts the total number of menu links in one menu or all menus.
MenuTreeStorageInterface::delete	public	function	Deletes a menu link definition from the storage.
MenuTreeStorageInterface::getAllChildIds	public	function	Loads all the IDs for menu links that are below the given ID.
MenuTreeStorageInterface::getExpanded	public	function	Finds expanded links in a menu given a set of possible parents.
MenuTreeStorageInterface::getMenuNames	public	function	Returns the used menu names in the tree storage.
MenuTreeStorageInterface::getRootPathIds	public	function	Returns all the IDs that represent the path to the root of the tree.
MenuTreeStorageInterface::getSubtreeHeight	public	function	Finds the height of a subtree rooted by the given ID.
MenuTreeStorageInterface::load	public	function	Loads a menu link plugin definition from the storage.
MenuTreeStorageInterface::loadAllChildren	public	function	Loads all the enabled menu links that are below the given ID.
MenuTreeStorageInterface::loadByProperties	public	function	Loads multiple plugin definitions from the storage based on properties.
MenuTreeStorageInterface::loadByRoute	public	function	Loads multiple plugin definitions from the storage based on route.
MenuTreeStorageInterface::loadMultiple	public	function	Loads multiple plugin definitions from the storage.
MenuTreeStorageInterface::loadSubtreeData	public	function	Loads a subtree rooted by the given ID.
MenuTreeStorageInterface::loadTreeData	public	function	Loads a menu link tree from the storage.
MenuTreeStorageInterface::maxDepth	public	function	The maximum depth of tree the storage implementation supports.
MenuTreeStorageInterface::menuNameInUse	public	function	Determines whether a specific menu name is used in the tree.
MenuTreeStorageInterface::rebuild	public	function	Rebuilds the stored menu link definitions.
MenuTreeStorageInterface::resetDefinitions	public	function	Clears all definitions cached in memory.
MenuTreeStorageInterface::save	public	function	Saves a plugin definition to the storage.