class LocalTasksBlock

Same name in other branches
  1. 9 core/lib/Drupal/Core/Menu/Plugin/Block/LocalTasksBlock.php \Drupal\Core\Menu\Plugin\Block\LocalTasksBlock
  2. 8.9.x core/lib/Drupal/Core/Menu/Plugin/Block/LocalTasksBlock.php \Drupal\Core\Menu\Plugin\Block\LocalTasksBlock
  3. 11.x core/lib/Drupal/Core/Menu/Plugin/Block/LocalTasksBlock.php \Drupal\Core\Menu\Plugin\Block\LocalTasksBlock

Provides a "Tabs" block to display the local tasks.

Hierarchy

Expanded class hierarchy of LocalTasksBlock

File

core/lib/Drupal/Core/Menu/Plugin/Block/LocalTasksBlock.php, line 20

Namespace

Drupal\Core\Menu\Plugin\Block
View source
class LocalTasksBlock extends BlockBase implements ContainerFactoryPluginInterface {
    
    /**
     * The local task manager.
     *
     * @var \Drupal\Core\Menu\LocalTaskManagerInterface
     */
    protected $localTaskManager;
    
    /**
     * The route match.
     *
     * @var \Drupal\Core\Routing\RouteMatchInterface
     */
    protected $routeMatch;
    
    /**
     * Creates a LocalTasksBlock 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\Menu\LocalTaskManagerInterface $local_task_manager
     *   The local task manager.
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The route match.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, LocalTaskManagerInterface $local_task_manager, RouteMatchInterface $route_match) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->localTaskManager = $local_task_manager;
        $this->routeMatch = $route_match;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('plugin.manager.menu.local_task'), $container->get('current_route_match'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'label_display' => FALSE,
            'primary' => TRUE,
            'secondary' => TRUE,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        $config = $this->configuration;
        $cacheability = new CacheableMetadata();
        $cacheability->addCacheableDependency($this->localTaskManager);
        // If the current route belongs to an entity, include cache tags of that
        // entity as well.
        $route_parameters = $this->routeMatch
            ->getParameters()
            ->all();
        foreach ($route_parameters as $parameter) {
            if ($parameter instanceof CacheableDependencyInterface) {
                $cacheability->addCacheableDependency($parameter);
            }
        }
        $tabs = [
            '#theme' => 'menu_local_tasks',
        ];
        // Add only selected levels for the printed output.
        if ($config['primary']) {
            $links = $this->localTaskManager
                ->getLocalTasks($this->routeMatch
                ->getRouteName(), 0);
            $cacheability = $cacheability->merge($links['cacheability']);
            // Do not display single tabs.
            $tabs += [
                '#primary' => count(Element::getVisibleChildren($links['tabs'])) > 1 ? $links['tabs'] : [],
            ];
        }
        if ($config['secondary']) {
            $links = $this->localTaskManager
                ->getLocalTasks($this->routeMatch
                ->getRouteName(), 1);
            $cacheability = $cacheability->merge($links['cacheability']);
            // Do not display single tabs.
            $tabs += [
                '#secondary' => count(Element::getVisibleChildren($links['tabs'])) > 1 ? $links['tabs'] : [],
            ];
        }
        $build = [];
        $cacheability->applyTo($build);
        if (empty($tabs['#primary']) && empty($tabs['#secondary'])) {
            return $build;
        }
        return $build + $tabs;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) {
        $config = $this->configuration;
        $defaults = $this->defaultConfiguration();
        $form['levels'] = [
            '#type' => 'details',
            '#title' => $this->t('Shown tabs'),
            '#description' => $this->t('Select tabs being shown in the block'),
            // Open if not set to defaults.
'#open' => $defaults['primary'] !== $config['primary'] || $defaults['secondary'] !== $config['secondary'],
        ];
        $form['levels']['primary'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Show primary tabs'),
            '#default_value' => $config['primary'],
        ];
        $form['levels']['secondary'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Show secondary tabs'),
            '#default_value' => $config['secondary'],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockSubmit($form, FormStateInterface $form_state) {
        $levels = $form_state->getValue('levels');
        $this->configuration['primary'] = $levels['primary'];
        $this->configuration['secondary'] = $levels['secondary'];
    }

}

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
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::getCacheContexts public function 10
ContextAwarePluginTrait::getCacheMaxAge public function 6
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
LocalTasksBlock::$localTaskManager protected property The local task manager.
LocalTasksBlock::$routeMatch protected property The route match.
LocalTasksBlock::blockForm public function Overrides BlockPluginTrait::blockForm
LocalTasksBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
LocalTasksBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
LocalTasksBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LocalTasksBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
LocalTasksBlock::__construct public function Creates a LocalTasksBlock instance. Overrides BlockPluginTrait::__construct
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. 2
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.