class ToolbarMenuLinkTree

Same name in other branches
  1. 8.9.x core/modules/toolbar/src/Menu/ToolbarMenuLinkTree.php \Drupal\toolbar\Menu\ToolbarMenuLinkTree
  2. 10 core/modules/toolbar/src/Menu/ToolbarMenuLinkTree.php \Drupal\toolbar\Menu\ToolbarMenuLinkTree
  3. 11.x core/modules/toolbar/src/Menu/ToolbarMenuLinkTree.php \Drupal\toolbar\Menu\ToolbarMenuLinkTree

Extends MenuLinkTree to add specific theme suggestions for the toolbar.

Hierarchy

Expanded class hierarchy of ToolbarMenuLinkTree

1 string reference to 'ToolbarMenuLinkTree'
toolbar.services.yml in core/modules/toolbar/toolbar.services.yml
core/modules/toolbar/toolbar.services.yml
1 service uses ToolbarMenuLinkTree
toolbar.menu_tree in core/modules/toolbar/toolbar.services.yml
Drupal\toolbar\Menu\ToolbarMenuLinkTree

File

core/modules/toolbar/src/Menu/ToolbarMenuLinkTree.php, line 10

Namespace

Drupal\toolbar\Menu
View source 
class ToolbarMenuLinkTree extends MenuLinkTree {
    
    /**
     * {@inheritdoc}
     */
    public function build(array $tree, $level = 0) {
        if ($level == 0) {
            if (!$tree) {
                return [];
            }
            $build = parent::build($tree, $level);
            
            /** @var \Drupal\Core\Menu\MenuLinkInterface $link */
            $first_link = reset($tree)->link;
            // Get the menu name of the first link.
            $menu_name = $first_link->getMenuName();
            // Add a more specific theme suggestion to differentiate this rendered
            // menu from others.
            $build['#menu_name'] = $menu_name;
            $build['#theme'] = 'menu__toolbar__' . strtr($menu_name, '-', '_');
            return $build;
        }
        else {
            return parent::build($tree, $level);
        }
    }

}

Members

Title Modifiers Object type Summary Overriden Title
MenuLinkTree::$controllerResolver protected property The controller resolver.
MenuLinkTree::$menuActiveTrail protected property The active menu trail service.
MenuLinkTree::$menuLinkManager protected property The menu link plugin manager.
MenuLinkTree::$routeProvider protected property The route provider to load routes by name.
MenuLinkTree::$treeStorage protected property The menu link tree storage.
MenuLinkTree::buildItems protected function Builds the #items property for a menu tree's renderable array.
MenuLinkTree::createInstances protected function Returns a tree containing of MenuLinkTreeElement based upon tree data.
MenuLinkTree::getCurrentRouteMenuTreeParameters public function Gets the link tree parameters for rendering a specific menu. Overrides MenuLinkTreeInterface::getCurrentRouteMenuTreeParameters
MenuLinkTree::getExpanded public function Finds expanded links in a menu given a set of possible parents. Overrides MenuLinkTreeInterface::getExpanded
MenuLinkTree::getSubtreeHeight public function Finds the height of a subtree rooted by of the given ID. Overrides MenuLinkTreeInterface::getSubtreeHeight
MenuLinkTree::load public function Loads a menu tree with a menu link plugin instance at each element. Overrides MenuLinkTreeInterface::load
MenuLinkTree::maxDepth public function Returns the maximum depth of tree that is supported. Overrides MenuLinkTreeInterface::maxDepth
MenuLinkTree::transform public function Applies menu link tree manipulators to transform the given tree. Overrides MenuLinkTreeInterface::transform
MenuLinkTree::__construct public function Constructs a \Drupal\Core\Menu\MenuLinkTree object.
ToolbarMenuLinkTree::build public function Builds a renderable array from a menu tree. Overrides MenuLinkTree::build

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