Defines a book manager.
Hierarchy
- class \Drupal\book\BookManager implements BookManagerInterface uses StringTranslationTrait
File
- core/modules/book/src/BookManager.php, line 20
Namespace
Drupal\book
Members
Name | Modifiers | Type | Description |
---|---|---|---|
BookManager::$bookOutlineStorage | protected | property | Book outline storage. |
BookManager::$books | protected | property | Books Array. |
BookManager::$bookTreeFlattened | protected | property | Stores flattened book trees. |
BookManager::$configFactory | protected | property | Config Factory Service Object. |
BookManager::$entityManager | protected | property | Entity manager Service Object. |
BookManager::$renderer | protected | property | The renderer. |
BookManager::addFormElements | public | function | Builds the common elements of the book form for the node and outline forms. Overrides BookManagerInterface::addFormElements |
BookManager::addParentSelectFormElements | protected | function | Builds the parent selection form element for the node form or outline tab. |
BookManager::bookLinkTranslate | public | function | Provides book loading, access control and translation. Overrides BookManagerInterface::bookLinkTranslate |
BookManager::bookSubtreeData | public | function | Gets the data representing a subtree of the book hierarchy. Overrides BookManagerInterface::bookSubtreeData |
BookManager::bookTreeAllData | public | function | Gets the data structure representing a named menu tree. Overrides BookManagerInterface::bookTreeAllData |
BookManager::bookTreeBuild | protected | function | Builds a book tree, translates links, and checks access. |
BookManager::bookTreeCheckAccess | public | function | Checks access and performs dynamic operations for each link in the tree. Overrides BookManagerInterface::bookTreeCheckAccess |
BookManager::bookTreeCollectNodeLinks | public | function | Collects node links from a given menu tree recursively. Overrides BookManagerInterface::bookTreeCollectNodeLinks |
BookManager::bookTreeGetFlat | public | function | Gets the book for a page and returns it as a linear array. Overrides BookManagerInterface::bookTreeGetFlat |
BookManager::bookTreeOutput | public | function | Returns a rendered menu tree. Overrides BookManagerInterface::bookTreeOutput |
BookManager::BOOK_MAX_DEPTH | constant | Defines the maximum supported depth of the book tree. | |
BookManager::buildBookOutlineData | protected | function | Sorts and returns the built data representing a book tree. |
BookManager::buildBookOutlineRecursive | protected | function | Builds the data representing a book tree. |
BookManager::buildItems | protected | function | Builds the #items property for a book tree's renderable array. |
BookManager::checkNodeIsRemovable | public | function | Determines if a node can be removed from the book. Overrides BookManagerInterface::checkNodeIsRemovable |
BookManager::deleteFromBook | public | function | Deletes node's entry from book table. Overrides BookManagerInterface::deleteFromBook |
BookManager::doBookTreeBuild | protected | function | Builds a book tree. |
BookManager::doBookTreeCheckAccess | protected | function | Sorts the menu tree and recursively checks access for each item. |
BookManager::findChildrenRelativeDepth | protected | function | Determine the relative depth of the children of a given book link. |
BookManager::flatBookTree | protected | function | Recursively converts a tree of menu links to a flat array. |
BookManager::getActiveTrailIds | public | function | Gets the active trail IDs for the specified book at the provided path. Overrides BookManagerInterface::getActiveTrailIds |
BookManager::getAllBooks | public | function | Returns an array of all books. Overrides BookManagerInterface::getAllBooks |
BookManager::getBookParents | public | function | Overrides BookManagerInterface::getBookParents |
BookManager::getLinkDefaults | public | function | Returns an array with default values for a book page's menu link. Overrides BookManagerInterface::getLinkDefaults |
BookManager::getParentDepthLimit | public | function | Finds the depth limit for items in the parent select. Overrides BookManagerInterface::getParentDepthLimit |
BookManager::getTableOfContents | public | function | Returns an array of book pages in table of contents order. Overrides BookManagerInterface::getTableOfContents |
BookManager::loadBookLink | public | function | Loads a single book entry. Overrides BookManagerInterface::loadBookLink |
BookManager::loadBookLinks | public | function | Loads multiple book entries. Overrides BookManagerInterface::loadBookLinks |
BookManager::loadBooks | protected | function | Loads Books Array. |
BookManager::moveChildren | protected | function | Moves children from the original parent to the updated link. |
BookManager::recurseTableOfContents | protected | function | Recursively processes and formats book links for getTableOfContents(). |
BookManager::saveBookLink | public | function | Saves a single book entry. Overrides BookManagerInterface::saveBookLink |
BookManager::setParents | protected | function | Sets the p1 through p9 properties for a book link being saved. |
BookManager::updateOriginalParent | protected | function | Updates the has_children flag of the parent of the original node. |
BookManager::updateOutline | public | function | Handles additions and updates to the book outline. Overrides BookManagerInterface::updateOutline |
BookManager::updateParent | protected | function | Sets the has_children flag of the parent of the node. |
BookManager::__construct | public | function | Constructs a BookManager object. |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. |
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. |
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. |
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Please login to continue.