1. class
  2. Drupal
  3. \
  4. book
  5. \
  6. BookOutline

BookOutline

class BookOutline (View source)

Provides handling to render the book outline.

Properties

protected BookManagerInterface $bookManager

The book manager.

Methods

__construct(BookManagerInterface $book_manager)

Constructs a new BookOutline.

array
prevLink(array $book_link)

Fetches the book link for the previous page of the book.

array
nextLink(array $book_link)

Fetches the book link for the next page of the book.

array
childrenLinks(array $book_link)

Formats the book links for the child pages of the current page.

Details

at line 23
__construct(BookManagerInterface $book_manager)

Constructs a new BookOutline.

Parameters

BookManagerInterface $book_manager

The book manager.

Fetches the book link for the previous page of the book.

Parameters

array $book_link

A fully loaded book link that is part of the book hierarchy.

Return Value

array

A fully loaded book link for the page before the one represented in $book_link.

Fetches the book link for the next page of the book.

Parameters

array $book_link

A fully loaded book link that is part of the book hierarchy.

Return Value

array

A fully loaded book link for the page after the one represented in $book_link.

Formats the book links for the child pages of the current page.

Parameters

array $book_link

A fully loaded book link that is part of the book hierarchy.

Return Value

array

HTML for the links to the child pages of the current page.