BookOutlineStorageInterface::getChildRelativeDepth

public BookOutlineStorageInterface::getChildRelativeDepth($book_link, $max_depth) Gets child relative depth. Parameters array $book_link: The book link. int $max_depth: The maximum supported depth of the book tree. Return value int The depth of the searched book. File core/modules/book/src/BookOutlineStorageInterface.php, line 58 Class BookOutlineStorageInterface Defines a common interface for book outline storage classes. Namespace Drupal\book Code public function getChildRelativeDe

BookOutlineStorageInterface::loadMultiple

public BookOutlineStorageInterface::loadMultiple($nids, $access = TRUE) Loads books. Each book entry consists of the following keys: bid: The node ID of the main book. nid: The node ID of the book entry itself. pid: The parent node ID of the book. has_children: A boolean to indicate whether the book has children. weight: The weight of the book entry to order siblings. depth: The depth in the menu hierarchy the entry is placed into. Parameters array $nids: An array of node IDs. bool $ac

BookOutlineStorageInterface::getBooks

public BookOutlineStorageInterface::getBooks() Gets books (the highest positioned book links). Return value array An array of book IDs. File core/modules/book/src/BookOutlineStorageInterface.php, line 16 Class BookOutlineStorageInterface Defines a common interface for book outline storage classes. Namespace Drupal\book Code public function getBooks();

BookOutlineStorageInterface::loadBookChildren

public BookOutlineStorageInterface::loadBookChildren($pid) Loads book's children using it's parent ID. Parameters int $pid: The book's parent ID. Return value array Array of loaded book items. File core/modules/book/src/BookOutlineStorageInterface.php, line 80 Class BookOutlineStorageInterface Defines a common interface for book outline storage classes. Namespace Drupal\book Code public function loadBookChildren($pid);

BookOutlineStorageInterface::insert

public BookOutlineStorageInterface::insert($link, $parents) Inserts a book link. Parameters array $link: The link array to be inserted in the database. array $parents: The array of parent ids for the link to be inserted. Return value mixed The last insert ID of the query, if one exists. File core/modules/book/src/BookOutlineStorageInterface.php, line 111 Class BookOutlineStorageInterface Defines a common interface for book outline storage classes. Namespace Drupal\book Code public fu

BookOutlineStorageInterface::getBookSubtree

public BookOutlineStorageInterface::getBookSubtree($link, $max_depth) Get book subtree. Parameters array $link: A fully loaded book link. int $max_depth: The maximum supported depth of the book tree. Return value array Array of unordered subtree book items. File core/modules/book/src/BookOutlineStorageInterface.php, line 167 Class BookOutlineStorageInterface Defines a common interface for book outline storage classes. Namespace Drupal\book Code public function getBookSubtree($link, $

BookOutlineStorageInterface::countOriginalLinkChildren

public BookOutlineStorageInterface::countOriginalLinkChildren($original) Count the number of original link children. Parameters array $original: The book link array. Return value int Number of children. File core/modules/book/src/BookOutlineStorageInterface.php, line 154 Class BookOutlineStorageInterface Defines a common interface for book outline storage classes. Namespace Drupal\book Code public function countOriginalLinkChildren($original);

BookOutlineStorageInterface::delete

public BookOutlineStorageInterface::delete($nid) Deletes a book entry. Parameters int $nid: Deletes a book entry. Return value mixed Number of deleted book entries. File core/modules/book/src/BookOutlineStorageInterface.php, line 69 Class BookOutlineStorageInterface Defines a common interface for book outline storage classes. Namespace Drupal\book Code public function delete($nid);

BookOutlineStorageInterface

Defines a common interface for book outline storage classes. Hierarchy interface \Drupal\book\BookOutlineStorageInterface File core/modules/book/src/BookOutlineStorageInterface.php, line 8 Namespace Drupal\book Members Name Modifiers Type Description BookOutlineStorageInterface::countOriginalLinkChildren public function Count the number of original link children. BookOutlineStorageInterface::delete public function Deletes a book entry. BookOutlineStorageInterfa

BookOutlineStorageInterface::getBookMenuTree

public BookOutlineStorageInterface::getBookMenuTree($bid, $parameters, $min_depth, $max_depth) 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 Ar