class NavigationMenuBlock

Same name in other branches
  1. 10 core/modules/navigation/src/Plugin/Block/NavigationMenuBlock.php \Drupal\navigation\Plugin\Block\NavigationMenuBlock

Provides a generic menu navigation block.

@internal

Hierarchy

Expanded class hierarchy of NavigationMenuBlock

3 files declare their use of NavigationMenuBlock
NavigationMenuBlockTest.php in core/modules/navigation/tests/src/Kernel/NavigationMenuBlockTest.php
NavigationMenuMarkupTest.php in core/modules/navigation/tests/src/Kernel/NavigationMenuMarkupTest.php
SystemMenuNavigationBlockTest.php in core/modules/navigation/tests/src/Kernel/SystemMenuNavigationBlockTest.php

File

core/modules/navigation/src/Plugin/Block/NavigationMenuBlock.php, line 21

Namespace

Drupal\navigation\Plugin\Block
View source
final class NavigationMenuBlock extends SystemMenuBlock implements ContainerFactoryPluginInterface {
    const NAVIGATION_MAX_DEPTH = 3;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : static {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('navigation.menu_tree'), $container->get('menu.active_trail'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() : array {
        return [
            'level' => 1,
            'depth' => 0,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) : array {
        $form = parent::blockForm($form, $form_state);
        unset($form['menu_levels']['expand_all_items']);
        $form['menu_levels']['depth']['#options'] = range(1, static::NAVIGATION_MAX_DEPTH);
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockSubmit($form, FormStateInterface $form_state) : void {
        $this->configuration['level'] = $form_state->getValue('level');
        $this->configuration['depth'] = $form_state->getValue('depth');
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() : array {
        $menu_name = $this->getDerivativeId();
        $level = $this->configuration['level'];
        $depth = $this->configuration['depth'];
        $parameters = new MenuTreeParameters();
        $parameters->setMinDepth($level)
            ->setMaxDepth(min($level + $depth, $this->menuTree
            ->maxDepth()))
            ->onlyEnabledLinks();
        $tree = $this->menuTree
            ->load($menu_name, $parameters);
        $manipulators = [
            [
                'callable' => 'menu.default_tree_manipulators:checkAccess',
            ],
            [
                'callable' => 'menu.default_tree_manipulators:generateIndexAndSort',
            ],
        ];
        $tree = $this->menuTree
            ->transform($tree, $manipulators);
        $build = $this->menuTree
            ->build($tree);
        if (!empty($build)) {
            $build['#title'] = $this->configuration['label'];
        }
        return $build;
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        return [
            'module' => [
                'system',
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() : array {
        // We don't use menu active trails here.
        return array_filter(parent::getCacheContexts(), static fn(string $tag) => !str_starts_with($tag, 'route.menu_active_trails'));
    }

}

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::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
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::getCacheMaxAge public function 6
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.
NavigationMenuBlock::blockForm public function Overrides SystemMenuBlock::blockForm
NavigationMenuBlock::blockSubmit public function Overrides SystemMenuBlock::blockSubmit
NavigationMenuBlock::build public function Builds and returns the renderable array for this block plugin. Overrides SystemMenuBlock::build
NavigationMenuBlock::calculateDependencies public function Overrides BlockPluginTrait::calculateDependencies
NavigationMenuBlock::create public static function Creates an instance of the plugin. Overrides SystemMenuBlock::create
NavigationMenuBlock::defaultConfiguration public function Overrides SystemMenuBlock::defaultConfiguration
NavigationMenuBlock::getCacheContexts public function Overrides SystemMenuBlock::getCacheContexts
NavigationMenuBlock::NAVIGATION_MAX_DEPTH constant
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.
SystemMenuBlock::$menuActiveTrail protected property The active menu trail service.
SystemMenuBlock::$menuTree protected property The menu link tree service.
SystemMenuBlock::getCacheTags public function Overrides ContextAwarePluginTrait::getCacheTags
SystemMenuBlock::processMenuLevelParents public static function Form API callback: Processes the menu_levels field element.
SystemMenuBlock::__construct public function Constructs a new SystemMenuBlock. Overrides BlockPluginTrait::__construct

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