class BookNavigationBlock in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/book/src/Plugin/Block/BookNavigationBlock.php \Drupal\book\Plugin\Block\BookNavigationBlock
Provides a 'Book navigation' block.
Plugin annotation
@Block(
id = "book_navigation",
admin_label = @Translation("Book navigation"),
category = @Translation("Menus")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\Block\BlockBase implements BlockPluginInterface uses ContextAwarePluginAssignmentTrait
- class \Drupal\book\Plugin\Block\BookNavigationBlock implements ContainerFactoryPluginInterface
- class \Drupal\Core\Block\BlockBase implements BlockPluginInterface uses ContextAwarePluginAssignmentTrait
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
Expanded class hierarchy of BookNavigationBlock
File
- core/
modules/ book/ src/ Plugin/ Block/ BookNavigationBlock.php, line 28 - Contains \Drupal\book\Plugin\Block\BookNavigationBlock.
Namespace
Drupal\book\Plugin\BlockView 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
->get('entity.manager')
->getStorage('node'));
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return array(
'block_mode' => "all pages",
);
}
/**
* {@inheritdoc}
*/
function blockForm($form, FormStateInterface $form_state) {
$options = array(
'all pages' => $this
->t('Show block on all pages'),
'book pages' => $this
->t('Show block only on book pages'),
);
$form['book_block_mode'] = array(
'#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;
if ($node = $this->requestStack
->getCurrentRequest()
->get('node')) {
$current_bid = empty($node->book['bid']) ? 0 : $node->book['bid'];
}
if ($this->configuration['block_mode'] == 'all pages') {
$book_menus = array();
$pseudo_tree = array(
0 => array(
'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] += array(
'#book_title' => $book['title'],
);
}
if ($book_menus) {
return array(
'#theme' => 'book_all_books_block',
) + $book_menus;
}
}
elseif ($current_bid) {
// Only display this block when the user is browsing a book.
$query = \Drupal::entityQuery('node');
$nid = $query
->condition('nid', $node->book['bid'], '=')
->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 array();
}
/**
* {@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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlockBase:: |
protected | property | The transliteration service. | |
BlockBase:: |
public | function |
Indicates whether the block should be shown. Overrides BlockPluginInterface:: |
|
BlockBase:: |
protected | function | Returns generic default configuration for block plugins. | |
BlockBase:: |
protected | function | Indicates whether the block should be shown. | 12 |
BlockBase:: |
public | function |
Adds block type-specific validation for the block form. Overrides BlockPluginInterface:: |
1 |
BlockBase:: |
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:: |
1 |
BlockBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
BlockBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurablePluginInterface:: |
1 |
BlockBase:: |
public | function |
Suggests a machine name to identify an instance of this block. Overrides BlockPluginInterface:: |
1 |
BlockBase:: |
public | function |
Returns the user-facing block label. Overrides BlockPluginInterface:: |
|
BlockBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface:: |
|
BlockBase:: |
public | function |
Sets a particular value in the block settings. Overrides BlockPluginInterface:: |
|
BlockBase:: |
public | function | Sets the transliteration service. | |
BlockBase:: |
public | function |
Most block plugins should not override this method. To add submission
handling for a specific block type, override BlockBase::blockSubmit(). Overrides PluginFormInterface:: |
|
BlockBase:: |
protected | function | Wraps the transliteration service. | |
BlockBase:: |
public | function |
Most block plugins should not override this method. To add validation
for a specific block type, override BlockBase::blockValidate(). Overrides PluginFormInterface:: |
|
BookNavigationBlock:: |
protected | property | The book manager. | |
BookNavigationBlock:: |
protected | property | The node storage. | |
BookNavigationBlock:: |
protected | property | The request object. | |
BookNavigationBlock:: |
function |
Returns the configuration form elements specific to this block plugin. Overrides BlockBase:: |
||
BookNavigationBlock:: |
public | function |
Adds block type-specific submission handling for the block form. Overrides BlockBase:: |
|
BookNavigationBlock:: |
public | function |
Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface:: |
|
BookNavigationBlock:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
BookNavigationBlock:: |
public | function |
Gets default configuration for this plugin. Overrides BlockBase:: |
|
BookNavigationBlock:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
BookNavigationBlock:: |
public | function |
@todo Make cacheable in https://www.drupal.org/node/2483181 Overrides ContextAwarePluginBase:: |
|
BookNavigationBlock:: |
public | function |
Constructs a new BookNavigationBlock instance. Overrides BlockBase:: |
|
ContextAwarePluginAssignmentTrait:: |
protected | function | Builds a form element for assigning a context to a given slot. | |
ContextAwarePluginAssignmentTrait:: |
protected | function | Wraps the context handler. | |
ContextAwarePluginAssignmentTrait:: |
abstract protected | function | Ensures the t() method is available. | |
ContextAwarePluginBase:: |
protected | property | The data objects representing the context of this plugin. | |
ContextAwarePluginBase:: |
protected | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function | 4 | |
ContextAwarePluginBase:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the value for a defined context. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the values for all defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Set a context on this plugin. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Sets the value for a defined context. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface:: |
|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 1 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 1 |