function BookManager::bookTreeAllData

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

Gets the data structure representing a named menu tree.

Since this can be the full tree including hidden items, the data returned may be used for generating an admin interface or a select.

Note: based on menu_tree_all_data().

Parameters

int $bid: The Book ID to find links for.

array|null $link: (optional) A fully loaded menu link, or NULL. If a link is supplied, only the path to root will be included in the returned tree - as if this link represented the current page in a visible menu.

int|null $max_depth: (optional) Maximum depth of links to retrieve. Typically useful if only one or two levels of a sub tree are needed in conjunction with a non-NULL $link, in which case $max_depth should be greater than $link['depth'].

Return value

array A tree of menu links in an array, in the order they should be rendered.

Overrides BookManagerInterface::bookTreeAllData

File

core/modules/book/src/ProxyClass/BookManager.php, line 147

Class

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

Namespace

Drupal\book\ProxyClass

Code

public function bookTreeAllData($bid, $link = NULL, $max_depth = NULL) {
  return $this->lazyLoadItself()
    ->bookTreeAllData($bid, $link, $max_depth);
}

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