function BookOutlineStorageInterface::getBookMenuTree

Same name in other branches
  1. 9 core/modules/book/src/BookOutlineStorageInterface.php \Drupal\book\BookOutlineStorageInterface::getBookMenuTree()
  2. 8.9.x core/modules/book/src/BookOutlineStorageInterface.php \Drupal\book\BookOutlineStorageInterface::getBookMenuTree()
  3. 10 core/modules/book/src/BookOutlineStorageInterface.php \Drupal\book\BookOutlineStorageInterface::getBookMenuTree()

Builds tree data used for the menu tree.

Parameters

int $bid: The ID of the book that we are building the tree for.

array $parameters: An associative array of build parameters. For info about individual parameters see BookManager::bookTreeBuild().

int $min_depth: The minimum depth of book links in the resulting tree.

int $max_depth: The maximum supported depth of the book tree.

Return value

array Array of loaded book links.

File

core/modules/book/src/BookOutlineStorageInterface.php, line 98

Class

BookOutlineStorageInterface
Defines a common interface for book outline storage classes.

Namespace

Drupal\book

Code

public function getBookMenuTree($bid, $parameters, $min_depth, $max_depth);

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