public function BookManagerInterface::bookTreeGetFlat in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::bookTreeGetFlat()
2. 10 core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::bookTreeGetFlat()

Gets the book for a page and returns it as a linear array.

Parameters

array $book_link: A fully loaded book link that is part of the book hierarchy.

Return value

array A linear array of book links in the order that the links are shown in the book, so the previous and next pages are the elements before and after the element corresponding to the current node. The children of the current node (if any) will come immediately after it in the array, and links will only be fetched as deep as one level deeper than $book_link.

1 method overrides BookManagerInterface::bookTreeGetFlat()

BookManager::bookTreeGetFlat in core/modules/book/src/BookManager.php

Gets the book for a page and returns it as a linear array.

File

core/modules/book/src/BookManagerInterface.php, line 157

Class

BookManagerInterface

Provides an interface defining a book manager.

Namespace

Drupal\book

Code

public function bookTreeGetFlat(array $book_link);