LocalTaskDefault.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Menu/LocalTaskDefault.php
  2. 8.9.x core/lib/Drupal/Core/Menu/LocalTaskDefault.php
  3. 10 core/lib/Drupal/Core/Menu/LocalTaskDefault.php

Namespace

Drupal\Core\Menu

File

core/lib/Drupal/Core/Menu/LocalTaskDefault.php

View source
<?php

namespace Drupal\Core\Menu;

use Drupal\Component\Plugin\PluginBase;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Cache\CacheableDependencyInterface;
use Drupal\Core\DependencyInjection\DependencySerializationTrait;
use Drupal\Core\Routing\RouteMatchInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Default object used for LocalTaskPlugins.
 */
class LocalTaskDefault extends PluginBase implements LocalTaskInterface, CacheableDependencyInterface {
    use DependencySerializationTrait;
    
    /**
     * The route provider to load routes by name.
     *
     * @var \Drupal\Core\Routing\RouteProviderInterface
     */
    protected $routeProvider;
    
    /**
     * TRUE if this plugin is forced active for options attributes.
     *
     * @var bool
     */
    protected $active = FALSE;
    
    /**
     * {@inheritdoc}
     */
    public function getRouteName() {
        return $this->pluginDefinition['route_name'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRouteParameters(RouteMatchInterface $route_match) {
        $route_parameters = $this->pluginDefinition['route_parameters'] ?? [];
        $route = $this->routeProvider()
            ->getRouteByName($this->getRouteName());
        $variables = $route->compile()
            ->getVariables();
        // Normally the \Drupal\Core\ParamConverter\ParamConverterManager has
        // run, and the route parameters have been upcast. The original values can
        // be retrieved from the raw parameters. For example, if the route's path is
        // /filter/tips/{filter_format} and the path is /filter/tips/plain_text then
        // $raw_parameters->get('filter_format') == 'plain_text'. Parameters that
        // are not represented in the route path as slugs might be added by a route
        // enhancer and will not be present in the raw parameters.
        $raw_parameters = $route_match->getRawParameters();
        $parameters = $route_match->getParameters();
        foreach ($variables as $name) {
            if (isset($route_parameters[$name])) {
                continue;
            }
            if ($raw_parameters->has($name)) {
                $route_parameters[$name] = $raw_parameters->get($name);
            }
            elseif ($parameters->has($name)) {
                $route_parameters[$name] = $parameters->get($name);
            }
        }
        // The UrlGenerator will throw an exception if expected parameters are
        // missing. This method should be overridden if that is possible.
        return $route_parameters;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTitle(?Request $request = NULL) {
        // The title from YAML file discovery may be a TranslatableMarkup object.
        return (string) $this->pluginDefinition['title'];
    }
    
    /**
     * Returns the weight of the local task.
     *
     * @return int
     *   The weight of the task. If not defined in the annotation returns 0 by
     *   default or -10 for the root tab.
     */
    public function getWeight() {
        // By default the weight is 0, or -10 for the root tab.
        if (!isset($this->pluginDefinition['weight'])) {
            if ($this->pluginDefinition['base_route'] == $this->pluginDefinition['route_name']) {
                $this->pluginDefinition['weight'] = -10;
            }
            else {
                $this->pluginDefinition['weight'] = 0;
            }
        }
        return (int) $this->pluginDefinition['weight'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getOptions(RouteMatchInterface $route_match) {
        $options = $this->pluginDefinition['options'];
        if ($this->active) {
            if (empty($options['attributes']['class']) || !in_array('is-active', $options['attributes']['class'])) {
                $options['attributes']['class'][] = 'is-active';
            }
        }
        return (array) $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setActive($active = TRUE) {
        $this->active = $active;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getActive() {
        return $this->active;
    }
    
    /**
     * Returns the route provider.
     *
     * @return \Drupal\Core\Routing\RouteProviderInterface
     *   The route provider.
     */
    protected function routeProvider() {
        if (!$this->routeProvider) {
            $this->routeProvider = \Drupal::service('router.route_provider');
        }
        return $this->routeProvider;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheTags() {
        if (!isset($this->pluginDefinition['cache_tags'])) {
            return [];
        }
        return $this->pluginDefinition['cache_tags'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        if (!isset($this->pluginDefinition['cache_contexts'])) {
            return [];
        }
        return $this->pluginDefinition['cache_contexts'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheMaxAge() {
        if (!isset($this->pluginDefinition['cache_max_age'])) {
            return Cache::PERMANENT;
        }
        return $this->pluginDefinition['cache_max_age'];
    }

}

Classes

Title Deprecated Summary
LocalTaskDefault Default object used for LocalTaskPlugins.

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