function megamenu_theme_menu_tree in Megamenu 7

Same name and namespace in other branches

1. 6 megamenu.module \megamenu_theme_menu_tree()

Theme a menu tree.

This function takes a menu tree, such as primary links, and generates HTML markup of the menu so that it can be styled as a mega menu. It takes the first three nested levels of the menu tree and creates a structure of nested lists with appropriate classes and IDs assigned (even, odd, active, etc.).

First, we iterate through the first level of menu items (branch/tier-1/megamenu-bin). Each item will be the megamenu-parent of the second level of links (twig/tier-2/megamenu-slot). Next we iterate through the twigs of the menu tree to fill the megamenu-bins. A bin is an unordered list which contains slots (twig/tier-2 items). To fill the slots we iterate through each twig, where the leaves are the deepest level of the menu tree (tier-3). Each leaf is a list item containing a tier-3 menu link.

Abbreviations: t1, t2, & t3 stands for tier-1, tier-2, and tier-3 respectively. They represent nested level menu items.

Parameters

string $menu_name: The menu tree to be marked up (i.e. primary_links).

Return value

string HTML markup for a mega menu

1 call to megamenu_theme_menu_tree()

megamenu_block_view in ./megamenu.module

Implements hook_block_view().

File

./megamenu.module, line 178

Takes existing menus and produces blocks that render the menu as a megamenu.

Code

function megamenu_theme_menu_tree($menu_name) {
  $menu_tree = _megamenu_get_menu_tree($menu_name);
  if (function_exists('i18n_menu_localize_tree')) {
    $menu_tree = i18n_menu_localize_tree($menu_tree);
  }
  $skin = _megamenu_get_skin_by_name($menu_name);

  // @todo Currently, these attributes are set menu wide. Eventually these might should be set per menu level?

  /* @todo temp value, should be attached to branch level in admin interface */
  $slot_orientation = _megamenu_get_slot_orientation_by_name($menu_name);

  /* @todo temp value, should be attached to twig level in admin interface. */

  //_megamenu_get_slot_attributes_by_name($menu_name);
  $slot_attributes = '';
  $t1_position = 0;
  $branch_count = count($menu_tree);
  $branch_items = array();

  // Branch iteration.
  foreach ($menu_tree as $branch) {
    $twig_items_list = '';
    if ($branch['below']) {
      $t2_position = 0;
      $twig_count = count($branch['below']);

      // Twig iteration.
      foreach ($branch['below'] as $twig) {
        $leaf_items_list = '';

        // Leaf detection.
        if ($twig['below']) {
          $t3_position = 0;
          $leaf_count = count($twig['below']);

          // Leaf iteration.
          foreach ($twig['below'] as $leaf) {

            // Active or active-trail?
            $active = _megamenu_active_classes($leaf);

            // $leaf_link_options['attributes'] = array('class'=>$active);
            $t3_count_attributes = _megamenu_count_attributes($t3_position, $leaf_count);
            $t3_position++;
            $leaf_items[] = array(
              'data' => l($leaf['link']['link_title'], $leaf['link']['href'], $leaf['link']['options']),
              'id' => 'megamenu-mlid-' . $leaf['link']['mlid'],
              'class' => array(
                'megamenu-item',
                'megamenu-item-' . $t3_count_attributes,
                $active,
              ),
            );
          }

          // Build leaf list.
          $leaf_list_options = array(
            'class' => array(
              'megamenu-items',
              $slot_attributes,
            ),
          );
          $leaf_items_list = theme('item_list', array(
            'items' => $leaf_items,
            'attributes' => $leaf_list_options,
          ));
          $leaf_items_list = _megamenu_strip_list_wrapper($leaf_items_list);
          unset($leaf_items);
        }
        $t2_count_attributes = _megamenu_count_attributes($t2_position, $twig_count);
        $t2_position++;

        // Are we active / active-trail ?
        $active = _megamenu_active_classes($twig);

        //$link_options['attributes'] = array('class'=>$active);

        // This twig's <li> content.
        $twig_data = '<h3 class="megamenu-slot-title">' . l(_megamenu_get_translated_menu_title($menu_name, $twig['link']['mlid']), $twig['link']['href'], $twig['link']['options']) . '</h3>' . $leaf_items_list;
        $twig_items[] = array(
          'data' => $twig_data,
          'id' => 'megamenu-mlid-' . $twig['link']['mlid'],
          'class' => array(
            'megamenu-slot',
            'megamenu-slot-' . $t2_count_attributes,
            $active,
          ),
        );
      }

      // Build twig list.
      $twig_list_options = array(
        'class' => array(
          'megamenu-bin',
          'megamenu-slots-' . $slot_orientation,
        ),
      );
      $twig_items_list = theme('item_list', array(
        'items' => $twig_items,
        'attributes' => $twig_list_options,
      ));
      $twig_items_list = _megamenu_strip_list_wrapper($twig_items_list);
      unset($twig_items);
    }

    // END twig detection
    // Setup active link classes.
    $active = _megamenu_active_classes($branch);

    // Link options.
    $branch_link_options['attributes'] = array(
      'class' => $active,
    );

    // Setup $t1_count_attributes (classes).
    $t1_count_attributes = _megamenu_count_attributes($t1_position, $branch_count);
    $t1_position++;
    $branch_link = l(_megamenu_get_translated_menu_title($menu_name, $branch['link']['mlid']), $branch['link']['href'], $branch['link']['options']);
    $branch_items[] = array(
      'data' => '<h2 class="megamenu-parent-title">' . $branch_link . '</h2>' . $twig_items_list,
      'id' => 'megamenu-mlid-' . $branch['link']['mlid'],
      'class' => array(
        'megamenu-parent',
        'megamenu-parent-' . $t1_count_attributes,
        'menu-' . $branch['link']['mlid'],
        $active,
      ),
    );
    unset($twig_items_list);
  }

  // Build branch list.
  $branch_list_options = array(
    'id' => 'megamenu-' . $menu_name,
    'class' => array(
      'megamenu-menu',
      $slot_orientation,
      'megamenu-skin-' . $skin,
    ),
  );
  $output = theme('item_list', array(
    'items' => $branch_items,
    'attributes' => $branch_list_options,
  ));
  $output = _megamenu_strip_list_wrapper($output);
  return $output;
}