Login Register

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.
BookOutlineStorageInterface::getBookMenuTree	public	function	Builds tree data used for the menu tree.
BookOutlineStorageInterface::getBooks	public	function	Gets books (the highest positioned book links).
BookOutlineStorageInterface::getBookSubtree	public	function	Get book subtree.
BookOutlineStorageInterface::getChildRelativeDepth	public	function	Gets child relative depth.
BookOutlineStorageInterface::hasBooks	public	function	Checks if there are any books.
BookOutlineStorageInterface::insert	public	function	Inserts a book link.
BookOutlineStorageInterface::loadBookChildren	public	function	Loads book's children using it's parent ID.
BookOutlineStorageInterface::loadMultiple	public	function	Loads books.
BookOutlineStorageInterface::update	public	function	Updates book reference for links that were moved between books.
BookOutlineStorageInterface::updateMovedChildren	public	function	Update the book ID of the book link that it's being moved.

Links:

https://api.drupal.org/api/drupal/core%21modules%21book%21src%21BookOutlineStorageInterface.php/interface/BookOutlineStorageInterface/8.2.x

doc_Drupal

2016-10-29 08:48:26

Comments

Leave a Comment

Please login to continue.

Popular Articles

BookOutlineStorageInterface::countOriginalLinkChildren public BookOutlineStorageInterface::countOriginalLinkChildren($original) Count the number of original link children. Parameters array $original: The

BookOutlineStorageInterface::delete public BookOutlineStorageInterface::delete($nid) Deletes a book entry. Parameters int $nid: Deletes a book entry. Return value mixed Number of dele

BookOutlineStorageInterface::hasBooks public BookOutlineStorageInterface::hasBooks() Checks if there are any books. Return value bool TRUE if there are books, FALSE if not. File core/mod

BookOutlineStorageInterface::getBookMenuTree public BookOutlineStorageInterface::getBookMenuTree($bid, $parameters, $min_depth, $max_depth) Builds tree data used for the menu tree. Parameters i

BookOutlineStorageInterface::loadMultiple public BookOutlineStorageInterface::loadMultiple($nids, $access = TRUE) Loads books. Each book entry consists of the following keys: bid: The node I