interface 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

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface; interface \Drupal\Component\Plugin\Factory\FactoryInterface; interface \Drupal\Component\Plugin\Mapper\MapperInterface
  • interface \Drupal\Component\Plugin\PluginManagerInterface extends \Drupal\Component\Plugin\Discovery\DiscoveryInterface \Drupal\Component\Plugin\Factory\FactoryInterface \Drupal\Component\Plugin\Mapper\MapperInterface
    • interface \Drupal\Core\Menu\LocalActionManagerInterface extends \Drupal\Component\Plugin\PluginManagerInterface

Expanded class hierarchy of LocalActionManagerInterface

All classes that implement LocalActionManagerInterface

File

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

Namespace

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