class MenuLinkTree in Site map 8

Implements the loading, transforming and rendering of menu link trees.

Hierarchy

• class \Drupal\Core\Menu\MenuLinkTree implements MenuLinkTreeInterface
  • class \Drupal\site_map\Menu\MenuLinkTree

File

src/Menu/MenuLinkTree.php, line 11

Namespace

Drupal\site_map\Menu

class MenuLinkTree extends CoreMenuLinkTree {

  /**
   * Returns a rendered menu tree.
   *
   * This is a clone of the core Drupal\Core\Menu\MenuLinkTree::build() function
   * with the exception of theme('site_map_menu_tree') for theming override
   * reasons.
   *
   * The menu item's LI element is given one of the following classes:
   * - expanded: The menu item is showing its submenu.
   * - collapsed: The menu item has a submenu which is not shown.
   * - leaf: The menu item has no submenu.
   *
   * @param array $tree
   *   A data structure representing the tree as returned from menu_tree_data.
   *
   * @return array
   *   A structured array to be rendered by drupal_render().
   */
  public function buildForSiteMap(array $tree) {
    $config = \Drupal::config('site_map.settings');
    $build = array();
    $items = array();

    // Pull out just the menu links we are going to render so that we
    // get an accurate count for the first/last classes.
    // Thanks for fix by zhuber at
    // https://drupal.org/node/1331104#comment-5200266
    foreach ($tree as $data) {

      /** @var \Drupal\Core\Menu\MenuLinkInterface $link */
      $link = $data->link;
      if ($data->access && ($link
        ->isEnabled() || $config
        ->get('show_menus_hidden'))) {
        $items[] = $data;
      }
    }
    $num_items = count($items);
    foreach ($items as $i => $data) {
      $class = array();
      if ($i == 0) {
        $class[] = 'first';
      }
      if ($i == $num_items - 1) {
        $class[] = 'last';
      }

      /** @var \Drupal\Core\Menu\MenuLinkInterface $link */
      $link = $data->link;

      // Set a class for the <li>-tag. Only set 'expanded' class if the link
      // also has visible children within the current tree.
      if ($data->hasChildren && !empty($data->subtree)) {
        $class[] = 'expanded';
      }
      elseif ($data->hasChildren) {
        $class[] = 'collapsed';
      }
      else {
        $class[] = 'leaf';
      }
      $localized_options = array();

      // Set a class if the link is in the active trail.
      if ($data->inActiveTrail) {
        $class[] = 'active-trail';
        $localized_options['attributes']['class'][] = 'active-trail';
      }

      // Normally, l() compares the href of every link with $_GET['q'] and sets
      // the active class accordingly. But local tasks do not appear in menu
      // trees, so if the current path is a local task, and this link is its
      // tab root, then we have to set the class manually.
      if (empty($data->options['attributes']['class']) || !in_array('active', $data->options['attributes']['class'])) {
        $localized_options['attributes']['class'][] = 'active';
      }

      // Allow menu-specific theme overrides.
      $element['#theme'] = 'site_map_menu_link__' . strtr($link
        ->getMenuName(), '-', '_');
      $element['#attributes']['class'] = $class;
      $element['#title'] = $link
        ->getTitle();
      $element['#url'] = $link
        ->getUrlObject();
      $element['#localized_options'] = $localized_options;
      $element['#below'] = $data->subtree ? $this
        ->buildForSiteMap($data->subtree) : array();
      if (isset($data->options)) {
        $element['#url']
          ->setOptions(NestedArray::mergeDeep($element['#url']
          ->getOptions(), $data->options));
      }
      $element['#original_link'] = $link;

      // Index using the link's unique ID.
      $build[$link
        ->getPluginId()] = $element;
    }
    if ($build) {

      // Make sure drupal_render() does not re-order the links.
      $build['#sorted'] = TRUE;

      // Get the menu name from the last link.
      $menu_name = $link
        ->getMenuName();

      // Add the theme wrapper for outer markup.
      // Allow menu-specific theme overrides.
      $build['#theme_wrappers'][] = 'site_map_menu_tree__' . strtr($menu_name, '-', '_');

      // Set cache tag.
      $build['#cache']['tags'][] = 'menu:' . $menu_name;
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::build	public	function	Builds a renderable array from a menu tree. Overrides MenuLinkTreeInterface::build	1
MenuLinkTree::buildForSiteMap	public	function	Returns a rendered menu tree.
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.