public function MenuLinkTree::buildForSitemap in Sitemap 8

Returns a rendered menu tree.

This is a clone of the core Drupal\Core\Menu\MenuLinkTree::build() function with the exception of theme('sitemap_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.

Parameters

array $tree: A data structure representing the tree as returned from menu_tree_data.

Return value

array A structured array to be rendered by RendererInterface::render.

File

src/Menu/MenuLinkTree.php, line 31

Class

MenuLinkTree

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

Namespace

Drupal\sitemap\Menu

Code

public function buildForSitemap(array $tree) {
  $config = \Drupal::config('sitemap.settings');
  $build = [];
  $items = [];

  // 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
      ->isAllowed() && ($link
      ->isEnabled() || $config
      ->get('show_menus_hidden'))) {
      $items[] = $data;
    }
  }
  $num_items = count($items);
  foreach ($items as $i => $data) {
    $class = [];
    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 = [];

    // 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'] = 'sitemap_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) : [];
    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 RendererInterface::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'][] = 'sitemap_menu_tree__' . strtr($menu_name, '-', '_');

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