diff --git a/core/modules/book/src/BookStorageInterface.php b/core/modules/book/src/BookStorageInterface.php index 678021d..fa7ab85 100644 --- a/core/modules/book/src/BookStorageInterface.php +++ b/core/modules/book/src/BookStorageInterface.php @@ -73,7 +73,19 @@ public function loadBookChildren($pid); * @param int|string $bid * The ID of the book that we are building the tree for. * @param array $parameters - * See BoookManager::bookTreeBuild(). + * An associative array of build parameters. Possible keys: + * - expanded: An array of parent link ids to return only book links that + * are children of one of the plids in this list. If empty, the whole + * outline is built, unless 'only_active_trail' is TRUE. + * - active_trail: An array of nids, representing the coordinates of the + * currently active book link. + * - only_active_trail: Whether to only return links that are in the active + * trail. This option is ignored, if 'expanded' is non-empty. + * - min_depth: The minimum depth of book links in the resulting tree. + * Defaults to 1, which is the default to build a whole tree for a book. + * - max_depth: The maximum depth of book links in the resulting tree. + * - conditions: An associative array of custom database select query + * condition key/value pairs; see _menu_build_tree() for the actual query. * @param int $min_depth * The minimum depth of book links in the resulting tree. * @param int $max_depth