Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Menu/LocalActionManagerInterface.php \Drupal\Core\Menu\LocalActionManagerInterface
  2. 9 core/lib/Drupal/Core/Menu/LocalActionManagerInterface.php \Drupal\Core\Menu\LocalActionManagerInterface

Manages discovery and instantiation of menu local action plugins.

Menu local actions are links that lead to actions like "add new". The plugin format allows them (if needed) to dynamically generate a title or the path they link to. The annotation on the plugin provides the default title, and the list of routes where the action should be rendered.

Hierarchy

Expanded class hierarchy of LocalActionManagerInterface

All classes that implement LocalActionManagerInterface

1 file declares its use of LocalActionManagerInterface
BlockLibraryController.php in core/modules/block/src/Controller/BlockLibraryController.php

File

core/lib/Drupal/Core/Menu/LocalActionManagerInterface.php, line 15

Namespace

Drupal\Core\Menu
View source 
interface LocalActionManagerInterface extends PluginManagerInterface {

  /**
   * Gets the title for a local action.
   *
   * @param \Drupal\Core\Menu\LocalActionInterface $local_action
   *   An object to get the title from.
   *
   * @return string
   *   The title (already localized).
   *
   * @throws \BadMethodCallException
   *   If the plugin does not implement the getTitle() method.
   */
  public function getTitle(LocalActionInterface $local_action);

  /**
   * Finds all local actions that appear on a named route.
   *
   * @param string $route_appears
   *   The route name for which to find local actions.
   *
   * @return array
   *   An array of link render arrays.
   */
  public function getActionsForRoute($route_appears);

}

Members

Namesort descending Modifiers Type Description Overrides
DiscoveryInterface::getDefinition public function Gets a specific plugin definition. 2
DiscoveryInterface::getDefinitions public function Gets the definition of all plugins for this type. 3
DiscoveryInterface::hasDefinition public function Indicates if a specific plugin definition exists.
FactoryInterface::createInstance public function Creates a plugin instance based on the provided ID and configuration. 6
LocalActionManagerInterface::getActionsForRoute public function Finds all local actions that appear on a named route.
LocalActionManagerInterface::getTitle public function Gets the title for a local action.
MapperInterface::getInstance public function Gets or creates a plugin instance that satisfies the given options. 2