function BookManager::getTableOfContents

Same name in this branch
  1. 10 core/modules/book/src/BookManager.php \Drupal\book\BookManager::getTableOfContents()
Same name and namespace in other branches
  1. 9 core/modules/book/src/BookManager.php \Drupal\book\BookManager::getTableOfContents()
  2. 8.9.x core/modules/book/src/BookManager.php \Drupal\book\BookManager::getTableOfContents()
  3. 11.x core/modules/book/src/ProxyClass/BookManager.php \Drupal\book\ProxyClass\BookManager::getTableOfContents()
  4. 11.x core/modules/book/src/BookManager.php \Drupal\book\BookManager::getTableOfContents()

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/ProxyClass/BookManager.php, line 130

Class

BookManager
Provides a proxy class for \Drupal\book\BookManager.

Namespace

Drupal\book\ProxyClass

Code

public function getTableOfContents($bid, $depth_limit, array $exclude = array()) {
  return $this->lazyLoadItself()
    ->getTableOfContents($bid, $depth_limit, $exclude);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.