function BookManagerInterface::bookTreeOutput

Same name in other branches
  1. 9 core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::bookTreeOutput()
  2. 10 core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::bookTreeOutput()
  3. 11.x core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::bookTreeOutput()

Returns a rendered menu tree.

The menu item's LI element is given one of the following classes:

  • expanded: The menu item is showing its submenu.
  • collapsed: The menu item has a submenu which is not shown.

Parameters

array $tree: A data structure representing the tree as returned from buildBookOutlineData.

Return value

array A structured array to be rendered by \Drupal\Core\Render\RendererInterface::render().

See also

\Drupal\Core\Menu\MenuLinkTree::build

1 method overrides BookManagerInterface::bookTreeOutput()
BookManager::bookTreeOutput in core/modules/book/src/BookManager.php
Returns a rendered menu tree.

File

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

Class

BookManagerInterface
Provides an interface defining a book manager.

Namespace

Drupal\book

Code

public function bookTreeOutput(array $tree);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.