book_get_flat_menu

Definition

book_get_flat_menu($book_link)
drupal/modules/book/book.module, line 580

Description

Get the book menu tree for a page, and return it as a linear array.

Parameters

$book_link A fully loaded menu link that is part of the book hierarchy.

Return value

A linear array of menu links in the order that the links are shown in the menu, so the previous and next pages are the elements before and after the element corresponding to $node. The children of $node (if any) will come immediately after it in the array.

Code

function book_get_flat_menu($book_link) {
  static $flat = array();

  if (!isset($flat[$book_link['mlid']])) {
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link);
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
  }

  return $flat[$book_link['mlid']];
}