1. 8.5.x core/modules/book/src/Plugin/Block/BookNavigationBlock.php BookNavigationBlock
  2. 8.0.x core/modules/book/src/Plugin/Block/BookNavigationBlock.php BookNavigationBlock
  3. 8.1.x core/modules/book/src/Plugin/Block/BookNavigationBlock.php BookNavigationBlock
  4. 8.2.x core/modules/book/src/Plugin/Block/BookNavigationBlock.php BookNavigationBlock
  5. 8.3.x core/modules/book/src/Plugin/Block/BookNavigationBlock.php BookNavigationBlock
  6. 8.4.x core/modules/book/src/Plugin/Block/BookNavigationBlock.php BookNavigationBlock
  7. 8.6.x core/modules/book/src/Plugin/Block/BookNavigationBlock.php BookNavigationBlock

Provides a 'Book navigation' block.

Plugin annotation

  id = "book_navigation",
  admin_label = @Translation("Book navigation"),
  category = @Translation("Menus")


Expanded class hierarchy of BookNavigationBlock


core/modules/book/src/Plugin/Block/BookNavigationBlock.php, line 24


View source
class BookNavigationBlock extends BlockBase implements ContainerFactoryPluginInterface {

   * The request object.
   * @var \Symfony\Component\HttpFoundation\RequestStack
  protected $requestStack;

   * The book manager.
   * @var \Drupal\book\BookManagerInterface
  protected $bookManager;

   * The node storage.
   * @var \Drupal\Core\Entity\EntityStorageInterface
  protected $nodeStorage;

   * Constructs a new BookNavigationBlock instance.
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack object.
   * @param \Drupal\book\BookManagerInterface $book_manager
   *   The book manager.
   * @param \Drupal\Core\Entity\EntityStorageInterface $node_storage
   *   The node storage.
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RequestStack $request_stack, BookManagerInterface $book_manager, EntityStorageInterface $node_storage) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->requestStack = $request_stack;
    $this->bookManager = $book_manager;
    $this->nodeStorage = $node_storage;

   * {@inheritdoc}
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('request_stack'), $container
      ->get('book.manager'), $container

   * {@inheritdoc}
  public function defaultConfiguration() {
    return [
      'block_mode' => "all pages",

   * {@inheritdoc}
  public function blockForm($form, FormStateInterface $form_state) {
    $options = [
      'all pages' => $this
        ->t('Show block on all pages'),
      'book pages' => $this
        ->t('Show block only on book pages'),
    $form['book_block_mode'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Book navigation block display'),
      '#options' => $options,
      '#default_value' => $this->configuration['block_mode'],
      '#description' => $this
        ->t("If <em>Show block on all pages</em> is selected, the block will contain the automatically generated menus for all of the site's books. If <em>Show block only on book pages</em> is selected, the block will contain only the one menu corresponding to the current page's book. In this case, if the current page is not in a book, no block will be displayed. The <em>Page specific visibility settings</em> or other visibility settings can be used in addition to selectively display this block."),
    return $form;

   * {@inheritdoc}
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['block_mode'] = $form_state

   * {@inheritdoc}
  public function build() {
    $current_bid = 0;
    if ($node = $this->requestStack
      ->get('node')) {
      $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
    if ($this->configuration['block_mode'] == 'all pages') {
      $book_menus = [];
      $pseudo_tree = [
        0 => [
          'below' => FALSE,
      foreach ($this->bookManager
        ->getAllBooks() as $book_id => $book) {
        if ($book['bid'] == $current_bid) {

          // If the current page is a node associated with a book, the menu
          // needs to be retrieved.
          $data = $this->bookManager
            ->bookTreeAllData($node->book['bid'], $node->book);
          $book_menus[$book_id] = $this->bookManager
        else {

          // Since we know we will only display a link to the top node, there
          // is no reason to run an additional menu tree query for each book.
          $book['in_active_trail'] = FALSE;

          // Check whether user can access the book link.
          $book_node = $this->nodeStorage
          $book['access'] = $book_node
          $pseudo_tree[0]['link'] = $book;
          $book_menus[$book_id] = $this->bookManager
        $book_menus[$book_id] += [
          '#book_title' => $book['title'],
      if ($book_menus) {
        return [
          '#theme' => 'book_all_books_block',
        ] + $book_menus;
    elseif ($current_bid) {

      // Only display this block when the user is browsing a book and do
      // not show unpublished books.
      $nid = \Drupal::entityQuery('node')
        ->condition('nid', $node->book['bid'], '=')
        ->condition('status', NodeInterface::PUBLISHED)

      // Only show the block if the user has view access for the top-level node.
      if ($nid) {
        $tree = $this->bookManager
          ->bookTreeAllData($node->book['bid'], $node->book);

        // There should only be one element at the top level.
        $data = array_shift($tree);
        $below = $this->bookManager
        if (!empty($below)) {
          return $below;
    return [];

   * {@inheritdoc}
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), [

   * {@inheritdoc}
   * @todo Make cacheable in https://www.drupal.org/node/2483181
  public function getCacheMaxAge() {
    return 0;



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
BlockBase::$transliteration protected property The transliteration service.
BlockBase::access public function Indicates whether the block should be shown. Overrides BlockPluginInterface::access
BlockBase::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockBase::blockAccess protected function Indicates whether the block should be shown.
BlockBase::blockValidate public function Adds block type-specific validation for the block form. Overrides BlockPluginInterface::blockValidate
BlockBase::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. Overrides PluginFormInterface::buildConfigurationForm
BlockBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
BlockBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
BlockBase::getMachineNameSuggestion public function Suggests a machine name to identify an instance of this block. Overrides BlockPluginInterface::getMachineNameSuggestion
BlockBase::label public function Returns the user-facing block label. Overrides BlockPluginInterface::label
BlockBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
BlockBase::setConfigurationValue public function Sets a particular value in the block settings. Overrides BlockPluginInterface::setConfigurationValue
BlockBase::setTransliteration public function Sets the transliteration service.
BlockBase::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). Overrides PluginFormInterface::submitConfigurationForm
BlockBase::transliteration protected function Wraps the transliteration service.
BlockBase::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). Overrides PluginFormInterface::validateConfigurationForm
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BookNavigationBlock::$bookManager protected property The book manager.
BookNavigationBlock::$nodeStorage protected property The node storage.
BookNavigationBlock::$requestStack protected property The request object.
BookNavigationBlock::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockBase::blockForm
BookNavigationBlock::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockBase::blockSubmit
BookNavigationBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
BookNavigationBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BookNavigationBlock::defaultConfiguration public function Gets default configuration for this plugin. Overrides BlockBase::defaultConfiguration
BookNavigationBlock::getCacheContexts public function The cache contexts associated with this object. Overrides ContextAwarePluginBase::getCacheContexts
BookNavigationBlock::getCacheMaxAge public function @todo Make cacheable in https://www.drupal.org/node/2483181 Overrides ContextAwarePluginBase::getCacheMaxAge
BookNavigationBlock::__construct public function Constructs a new BookNavigationBlock instance. Overrides BlockBase::__construct
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler. Overrides ContextAwarePluginBase::contextHandler
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available. Overrides StringTranslationTrait::t
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
PluginBase::$configuration protected property Configuration information passed into the plugin.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginWithFormsTrait::getFormClass public function Gets the form class for the given operation. Overrides PluginWithFormsInterface::getFormClass
PluginWithFormsTrait::hasFormClass public function Gets whether the plugin has a form class for the given operation. Overrides PluginWithFormsInterface::hasFormClass
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager.
TypedDataTrait::setTypedDataManager public function Sets the typed data manager.