class ContextualLinkManager

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Menu/ContextualLinkManager.php \Drupal\Core\Menu\ContextualLinkManager
  2. 10 core/lib/Drupal/Core/Menu/ContextualLinkManager.php \Drupal\Core\Menu\ContextualLinkManager
  3. 11.x core/lib/Drupal/Core/Menu/ContextualLinkManager.php \Drupal\Core\Menu\ContextualLinkManager

Defines a contextual link plugin manager to deal with contextual links.


Expanded class hierarchy of ContextualLinkManager

See also


1 string reference to 'ContextualLinkManager' in core/
1 service uses ContextualLinkManager in core/


core/lib/Drupal/Core/Menu/ContextualLinkManager.php, line 23


View source
class ContextualLinkManager extends DefaultPluginManager implements ContextualLinkManagerInterface {
     * Provides default values for a contextual link definition.
     * @var array
    protected $defaults = [
        // (required) The name of the route to link to.
'route_name' => '',
        // (required) The contextual links group.
'group' => '',
        // The static title text for the link.
'title' => '',
        // The default link options.
'options' => [],
        // The weight of the link.
'weight' => NULL,
        // Default class for contextual link implementations.
'class' => '\\Drupal\\Core\\Menu\\ContextualLinkDefault',
        // The plugin id. Set by the plugin system based on the top-level YAML key.
'id' => '',
     * A controller resolver object.
     * @var \Symfony\Component\HttpKernel\Controller\ControllerResolverInterface
    protected $controllerResolver;
     * The access manager.
     * @var \Drupal\Core\Access\AccessManagerInterface
    protected $accessManager;
     * The current user.
     * @var \Drupal\Core\Session\AccountInterface
    protected $account;
     * The request stack.
     * @var \Symfony\Component\HttpFoundation\RequestStack
    protected $requestStack;
     * A static cache of all the contextual link plugins by group name.
     * @var array
    protected $pluginsByGroup;
     * Constructs a new ContextualLinkManager instance.
     * @param \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver
     *   The controller resolver.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler.
     * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
     *   The cache backend.
     * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
     *   The language manager.
     * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
     *   The access manager.
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The current user.
     * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
     *   The request stack.
    public function __construct(ControllerResolverInterface $controller_resolver, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, AccessManagerInterface $access_manager, AccountInterface $account, RequestStack $request_stack) {
        $this->factory = new ContainerFactory($this, '\\Drupal\\Core\\Menu\\ContextualLinkInterface');
        $this->controllerResolver = $controller_resolver;
        $this->accessManager = $access_manager;
        $this->account = $account;
        $this->moduleHandler = $module_handler;
        $this->requestStack = $request_stack;
        $this->setCacheBackend($cache_backend, 'contextual_links_plugins:' . $language_manager->getCurrentLanguage()
            ->getId(), [
     * {@inheritdoc}
    protected function getDiscovery() {
        if (!isset($this->discovery)) {
            $yaml_discovery = new YamlDiscovery('links.contextual', $this->moduleHandler
            $yaml_discovery->addTranslatableProperty('title', 'title_context');
            $this->discovery = new ContainerDerivativeDiscoveryDecorator($yaml_discovery);
        return $this->discovery;
     * {@inheritdoc}
    public function processDefinition(&$definition, $plugin_id) {
        parent::processDefinition($definition, $plugin_id);
        // If there is no route name, this is a broken definition.
        if (empty($definition['route_name'])) {
            throw new PluginException(sprintf('Contextual link plugin (%s) definition must include "route_name".', $plugin_id));
        // If there is no group name, this is a broken definition.
        if (empty($definition['group'])) {
            throw new PluginException(sprintf('Contextual link plugin (%s) definition must include "group".', $plugin_id));
     * {@inheritdoc}
    public function getContextualLinkPluginsByGroup($group_name) {
        if (isset($this->pluginsByGroup[$group_name])) {
            $contextual_links = $this->pluginsByGroup[$group_name];
        elseif ($cache = $this->cacheBackend
            ->get($this->cacheKey . ':' . $group_name)) {
            $contextual_links = $cache->data;
            $this->pluginsByGroup[$group_name] = $contextual_links;
        else {
            $contextual_links = [];
            foreach ($this->getDefinitions() as $plugin_id => $plugin_definition) {
                if ($plugin_definition['group'] == $group_name) {
                    $contextual_links[$plugin_id] = $plugin_definition;
                ->set($this->cacheKey . ':' . $group_name, $contextual_links);
            $this->pluginsByGroup[$group_name] = $contextual_links;
        return $contextual_links;
     * {@inheritdoc}
    public function getContextualLinksArrayByGroup($group_name, array $route_parameters, array $metadata = []) {
        $links = [];
        $request = $this->requestStack
        foreach ($this->getContextualLinkPluginsByGroup($group_name) as $plugin_id => $plugin_definition) {
            /** @var $plugin \Drupal\Core\Menu\ContextualLinkInterface */
            $plugin = $this->createInstance($plugin_id);
            $route_name = $plugin->getRouteName();
            // Check access.
            if (!$this->accessManager
                ->checkNamedRoute($route_name, $route_parameters, $this->account)) {
            $links[$plugin_id] = [
                'route_name' => $route_name,
                'route_parameters' => $route_parameters,
                'title' => $plugin->getTitle($request),
                'weight' => $plugin->getWeight(),
                'localized_options' => $plugin->getOptions(),
                'metadata' => $metadata,
            ->alter('contextual_links', $links, $group_name, $route_parameters);
        return $links;



Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContextualLinkManager::$accessManager protected property The access manager.
ContextualLinkManager::$account protected property The current user.
ContextualLinkManager::$controllerResolver protected property A controller resolver object.
ContextualLinkManager::$defaults protected property Provides default values for a contextual link definition. Overrides DefaultPluginManager::$defaults
ContextualLinkManager::$pluginsByGroup protected property A static cache of all the contextual link plugins by group name.
ContextualLinkManager::$requestStack protected property The request stack.
ContextualLinkManager::getContextualLinkPluginsByGroup public function Gets the contextual link plugins by contextual link group. Overrides ContextualLinkManagerInterface::getContextualLinkPluginsByGroup
ContextualLinkManager::getContextualLinksArrayByGroup public function Gets the contextual links prepared as expected by links.html.twig. Overrides ContextualLinkManagerInterface::getContextualLinksArrayByGroup
ContextualLinkManager::getDiscovery protected function Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
ContextualLinkManager::processDefinition public function Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
ContextualLinkManager::__construct public function Constructs a new ContextualLinkManager instance. Overrides DefaultPluginManager::__construct
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional namespaces the annotation discovery mechanism should scan for
annotation definitions.
DefaultPluginManager::$alterHook protected property Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey protected property The cache key.
DefaultPluginManager::$cacheTags protected property An array of cache tags to use for the cached definitions.
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object that implements \Traversable which contains the root paths
keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface protected property The interface each plugin should implement. 1
DefaultPluginManager::$subdir protected property The subdirectory within a namespace to look for plugins, or FALSE if the
plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions protected function Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions 2
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 3
DefaultPluginManager::setCacheBackend public function Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches public function Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches 1
DiscoveryCachedTrait::$definitions protected property Cached definitions array. 1
DiscoveryCachedTrait::getDefinition public function Overrides DiscoveryTrait::getDefinition 3
DiscoveryTrait::doGetDefinition protected function Gets a specific plugin definition.
DiscoveryTrait::hasDefinition public function
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance public function 12
PluginManagerBase::getInstance public function 7
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
UseCacheBackendTrait::$cacheBackend protected property Cache backend instance.
UseCacheBackendTrait::$useCaches protected property Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet protected function Fetches from the cache backend, respecting the use caches flag. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.

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