Mercurial > hg > isophonics-drupal-site
view core/lib/Drupal/Core/Menu/LocalActionInterface.php @ 17:129ea1e6d783
Update, including to Drupal core 8.6.10
author | Chris Cannam |
---|---|
date | Thu, 28 Feb 2019 13:21:36 +0000 |
parents | 4c8ae668cc8c |
children |
line wrap: on
line source
<?php namespace Drupal\Core\Menu; use Drupal\Core\Routing\RouteMatchInterface; /** * Defines an interface for menu local actions. */ interface LocalActionInterface { /** * Get the route name from the settings. * * @return string * The name of the route this action links to. */ public function getRouteName(); /** * Returns the route parameters needed to render a link for the local action. * * @param \Drupal\Core\Routing\RouteMatchInterface $route_match * The current route match. * * @return array * An array of parameter names and values. */ public function getRouteParameters(RouteMatchInterface $route_match); /** * Returns the weight for the local action. * * @return int */ public function getWeight(); /** * Returns options for rendering a link for the local action. * * @param \Drupal\Core\Routing\RouteMatchInterface $route_match * The current route match. * * @return array * An associative array of options. */ public function getOptions(RouteMatchInterface $route_match); /** * Returns the localized title to be shown for this action. * * Subclasses may add optional arguments like NodeInterface $node = NULL that * will be supplied by the ControllerResolver. * * @return string * The title to be shown for this action. * * @see \Drupal\Core\Menu\LocalActionManager::getTitle() */ public function getTitle(); }