class BookNavigationBlock

Same name in other branches
  1. 9 core/modules/book/src/Plugin/Block/BookNavigationBlock.php \Drupal\book\Plugin\Block\BookNavigationBlock
  2. 8.9.x core/modules/book/src/Plugin/Block/BookNavigationBlock.php \Drupal\book\Plugin\Block\BookNavigationBlock
  3. 10 core/modules/book/src/Plugin/Block/BookNavigationBlock.php \Drupal\book\Plugin\Block\BookNavigationBlock

Provides a 'Book navigation' block.

Hierarchy

Expanded class hierarchy of BookNavigationBlock

File

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

Namespace

Drupal\book\Plugin\Block
View source
class BookNavigationBlock extends BlockBase implements ContainerFactoryPluginInterface {
    
    /**
     * The current route match.
     *
     * @var \Drupal\Core\Routing\RouteMatchInterface
     */
    protected $routeMatch;
    
    /**
     * 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 \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The current route match.
     * @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, RouteMatchInterface $route_match, BookManagerInterface $book_manager, EntityStorageInterface $node_storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->routeMatch = $route_match;
        $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('current_route_match'), $container->get('book.manager'), $container->get('entity_type.manager')
            ->getStorage('node'));
    }
    
    /**
     * {@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->getValue('book_block_mode');
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        $current_bid = 0;
        $node = $this->routeMatch
            ->getParameter('node');
        if ($node instanceof NodeInterface && !empty($node->book['bid'])) {
            $current_bid = $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
                        ->bookTreeOutput($data);
                }
                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
                        ->load($book['nid']);
                    $book['access'] = $book_node->access('view');
                    $pseudo_tree[0]['link'] = $book;
                    $book_menus[$book_id] = $this->bookManager
                        ->bookTreeOutput($pseudo_tree);
                }
                $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')->accessCheck(TRUE)
                ->condition('nid', $node->book['bid'], '=')
                ->condition('status', NodeInterface::PUBLISHED)
                ->execute();
            // 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
                    ->bookTreeOutput($data['below']);
                if (!empty($below)) {
                    return $below;
                }
            }
        }
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        return Cache::mergeContexts(parent::getCacheContexts(), [
            'route.book_navigation',
        ]);
    }
    
    /**
     * {@inheritdoc}
     *
     * @todo Make cacheable in https://www.drupal.org/node/2483181
     */
    public function getCacheMaxAge() {
        return 0;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$inPreview protected property Whether the plugin is being rendered in preview mode.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 18
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::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.
Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function 1
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setInPreview public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission
handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation
for a specific block type, override BlockBase::blockValidate().
1
BookNavigationBlock::$bookManager protected property The book manager.
BookNavigationBlock::$nodeStorage protected property The node storage.
BookNavigationBlock::$routeMatch protected property The current route match.
BookNavigationBlock::blockForm public function Overrides BlockPluginTrait::blockForm
BookNavigationBlock::blockSubmit public function Overrides BlockPluginTrait::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 Overrides BlockPluginTrait::defaultConfiguration
BookNavigationBlock::getCacheContexts public function Overrides ContextAwarePluginTrait::getCacheContexts
BookNavigationBlock::getCacheMaxAge public function @todo Make cacheable in https://www.drupal.org/node/2483181 Overrides ContextAwarePluginTrait::getCacheMaxAge
BookNavigationBlock::__construct public function Constructs a new BookNavigationBlock instance. Overrides BlockPluginTrait::__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.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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