class NavigationMenuLinkTree

Extends MenuLinkTree to add specific theme suggestions for the navigation.

@internal

Hierarchy

Expanded class hierarchy of NavigationMenuLinkTree

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

File

core/modules/navigation/src/Menu/NavigationMenuLinkTree.php, line 14

Namespace

Drupal\navigation\Menu
View source 
final class NavigationMenuLinkTree extends MenuLinkTree {
    
    /**
     * {@inheritdoc}
     */
    public function build(array $tree) : array {
        if (!$tree) {
            return [];
        }
        $build = parent::build($tree);
        if (empty($build['#items'])) {
            return [];
        }
        
        /** @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'] = 'navigation_menu__' . strtr($menu_name, '-', '_');
        // Loop through menu items and add the plugin id as a class.
        foreach ($tree as $item) {
            if ($item->access
                ->isAllowed()) {
                $plugin_id = $item->link
                    ->getPluginId();
                $plugin_class = str_replace('.', '_', $plugin_id);
                $build['#items'][$plugin_id]['class'] = $plugin_class;
            }
        }
        return $build;
    }

}

Members

Title Modifiers Object type Summary Overriden Title
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.
NavigationMenuLinkTree::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.