BookManager::getTableOfContents

public BookManager::getTableOfContents($bid, $depth_limit, array $exclude = array())

Returns an array of book pages in table of contents order.

Parameters

int $bid: The ID of the book whose pages are to be listed.

int $depth_limit: Any link deeper than this value will be excluded (along with its children).

array $exclude: (optional) An array of menu link ID values. Any link whose menu link ID is in this array will be excluded (along with its children). Defaults to an empty array.

Return value

array An array of (menu link ID, title) pairs for use as options for selecting a book page.

Overrides BookManagerInterface::getTableOfContents

File

core/modules/book/src/BookManager.php, line 420

Class

BookManager

Defines a book manager.

Namespace

Drupal\book

Code

public function getTableOfContents($bid, $depth_limit, array $exclude = array()) {
  $tree = $this->bookTreeAllData($bid);
  $toc = array();
  $this->recurseTableOfContents($tree, '', $toc, $exclude, $depth_limit);

  return $toc;
}