Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. LocalActionManager.php

class LocalActionManager

Provides the default local action manager using YML as primary definition.

Hierarchy

  • class \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryTrait
    • class \Drupal\Core\Plugin\DefaultPluginManager extends \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait
      • class \Drupal\Core\Menu\LocalActionManager extends \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Core\Menu\LocalActionManagerInterface

Expanded class hierarchy of LocalActionManager

File

core/lib/Drupal/Core/Menu/LocalActionManager.php, line 24

Namespace

Drupal\Core\Menu
View source
class LocalActionManager extends DefaultPluginManager implements LocalActionManagerInterface {
    
    /**
     * Provides some default values for all local action plugins.
     *
     * @var array
     */
    protected $defaults = [
        // The plugin id. Set by the plugin system based on the top-level YAML key.
'id' => NULL,
        // The static title for the local action.
'title' => '',
        // The weight of the local action.
'weight' => NULL,
        // (Required) the route name used to generate a link.
'route_name' => NULL,
        // Default route parameters for generating links.
'route_parameters' => [],
        // Associative array of link options.
'options' => [],
        // The route names where this local action appears.
'appears_on' => [],
        // Default class for local action implementations.
'class' => 'Drupal\\Core\\Menu\\LocalActionDefault',
    ];
    
    /**
     * An argument resolver object.
     *
     * @var \Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface
     */
    protected $argumentResolver;
    
    /**
     * The request stack.
     *
     * @var \Symfony\Component\HttpFoundation\RequestStack
     */
    protected $requestStack;
    
    /**
     * The current route match.
     *
     * @var \Drupal\Core\Routing\RouteMatchInterface
     */
    protected $routeMatch;
    
    /**
     * The route provider to load routes by name.
     *
     * @var \Drupal\Core\Routing\RouteProviderInterface
     */
    protected $routeProvider;
    
    /**
     * The access manager.
     *
     * @var \Drupal\Core\Access\AccessManagerInterface
     */
    protected $accessManager;
    
    /**
     * The current user.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $account;
    
    /**
     * The language manager.
     *
     * @var \Drupal\Core\Language\LanguageManagerInterface
     */
    protected LanguageManagerInterface $languageManager;
    
    /**
     * The plugin instances.
     *
     * @var \Drupal\Core\Menu\LocalActionInterface[]
     */
    protected $instances = [];
    
    /**
     * Constructs a LocalActionManager object.
     *
     * @param \Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface $argument_resolver
     *   An object to use in resolving route arguments.
     * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
     *   The request stack.
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The current route match.
     * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
     *   The route provider.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler.
     * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
     *   Cache backend instance to use.
     * @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.
     */
    public function __construct(ArgumentResolverInterface $argument_resolver, RequestStack $request_stack, RouteMatchInterface $route_match, RouteProviderInterface $route_provider, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, AccessManagerInterface $access_manager, AccountInterface $account) {
        // Skip calling the parent constructor, since that assumes annotation-based
        // discovery.
        $this->factory = new ContainerFactory($this, 'Drupal\\Core\\Menu\\LocalActionInterface');
        $this->argumentResolver = $argument_resolver;
        $this->requestStack = $request_stack;
        $this->routeMatch = $route_match;
        $this->routeProvider = $route_provider;
        $this->accessManager = $access_manager;
        $this->moduleHandler = $module_handler;
        $this->account = $account;
        $this->languageManager = $language_manager;
        $this->alterInfo('menu_local_actions');
        $this->setCacheBackend($cache_backend, 'local_action_plugins:' . $language_manager->getCurrentLanguage()
            ->getId());
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getDiscovery() {
        if (!isset($this->discovery)) {
            $yaml_discovery = new YamlDiscovery('links.action', $this->moduleHandler
                ->getModuleDirectories());
            $yaml_discovery->addTranslatableProperty('title', 'title_context');
            $this->discovery = new ContainerDerivativeDiscoveryDecorator($yaml_discovery);
        }
        return $this->discovery;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getTitle(LocalActionInterface $local_action) {
        $controller = [
            $local_action,
            'getTitle',
        ];
        $arguments = $this->argumentResolver
            ->getArguments($this->requestStack
            ->getCurrentRequest(), $controller);
        return call_user_func_array($controller, $arguments);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getActionsForRoute($route_appears) {
        if (!isset($this->instances[$route_appears])) {
            $route_names = [];
            $this->instances[$route_appears] = [];
            // @todo Optimize this lookup by compiling or caching.
            foreach ($this->getDefinitions() as $plugin_id => $action_info) {
                if (in_array($route_appears, $action_info['appears_on'])) {
                    $plugin = $this->createInstance($plugin_id);
                    $route_names[] = $plugin->getRouteName();
                    $this->instances[$route_appears][$plugin_id] = $plugin;
                }
            }
            // Pre-fetch all the action route objects. This reduces the number of SQL
            // queries that would otherwise be triggered by the access manager.
            if (!empty($route_names)) {
                $this->routeProvider
                    ->getRoutesByNames($route_names);
            }
        }
        $links = [];
        $cacheability = new CacheableMetadata();
        $cacheability->addCacheContexts([
            'route',
        ]);
        
        /** @var \Drupal\Core\Menu\LocalActionInterface $plugin */
        foreach ($this->instances[$route_appears] as $plugin_id => $plugin) {
            $route_name = $plugin->getRouteName();
            $route_parameters = $plugin->getRouteParameters($this->routeMatch);
            $access = $this->accessManager
                ->checkNamedRoute($route_name, $route_parameters, $this->account, TRUE);
            $links[$plugin_id] = [
                '#theme' => 'menu_local_action',
                '#link' => [
                    'title' => $this->getTitle($plugin),
                    'url' => Url::fromRoute($route_name, $route_parameters),
                    'localized_options' => $plugin->getOptions($this->routeMatch),
                ],
                '#access' => $access,
                '#weight' => $plugin->getWeight(),
            ];
            $cacheability->addCacheableDependency($access)
                ->addCacheableDependency($plugin);
        }
        $cacheability->applyTo($links);
        return $links;
    }
    
    /**
     * {@inheritdoc}
     */
    public function clearCachedDefinitions() {
        $cids = [];
        foreach ($this->languageManager
            ->getLanguages() as $language) {
            $cids[] = 'local_action_plugins:' . $language->getId();
        }
        $this->cacheBackend
            ->deleteMultiple($cids);
        $this->definitions = NULL;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional annotation namespaces.
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::$moduleExtensionList protected property The module extension list.
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object of root paths that are traversable.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginDefinitionAttributeName protected property The name of the attribute 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.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 4
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
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 1
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 14
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 5
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
LocalActionManager::$accessManager protected property The access manager.
LocalActionManager::$account protected property The current user.
LocalActionManager::$argumentResolver protected property An argument resolver object.
LocalActionManager::$defaults protected property Provides some default values for all local action plugins. Overrides DefaultPluginManager::$defaults
LocalActionManager::$instances protected property The plugin instances.
LocalActionManager::$languageManager protected property The language manager.
LocalActionManager::$requestStack protected property The request stack.
LocalActionManager::$routeMatch protected property The current route match.
LocalActionManager::$routeProvider protected property The route provider to load routes by name.
LocalActionManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides DefaultPluginManager::clearCachedDefinitions
LocalActionManager::getActionsForRoute public function Finds all local actions that appear on a named route. Overrides LocalActionManagerInterface::getActionsForRoute
LocalActionManager::getDiscovery protected function Gets the plugin discovery. Overrides DefaultPluginManager::getDiscovery
LocalActionManager::getTitle public function Gets the title for a local action. Overrides LocalActionManagerInterface::getTitle
LocalActionManager::__construct public function Constructs a LocalActionManager object. Overrides DefaultPluginManager::__construct
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 14
PluginManagerBase::getFallbackPluginId protected function Gets a fallback id for a missing plugin. 5
PluginManagerBase::getInstance public function 6
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.
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.
RSS feed
Powered by Drupal