interface LocalTaskInterface
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Menu/LocalTaskInterface.php \Drupal\Core\Menu\LocalTaskInterface
- 10 core/lib/Drupal/Core/Menu/LocalTaskInterface.php \Drupal\Core\Menu\LocalTaskInterface
- 11.x core/lib/Drupal/Core/Menu/LocalTaskInterface.php \Drupal\Core\Menu\LocalTaskInterface
Defines an interface for menu local tasks.
Menu local tasks are typically rendered as navigation tabs above the content region, though other presentations are possible. It is convention that the titles of these tasks should be short verbs if possible.
Hierarchy
- interface \Drupal\Core\Menu\LocalTaskInterface
Expanded class hierarchy of LocalTaskInterface
All classes that implement LocalTaskInterface
See also
\Drupal\Core\Menu\LocalTaskManagerInterface
1 file declares its use of LocalTaskInterface
- LocalTaskManagerTest.php in core/
tests/ Drupal/ Tests/ Core/ Menu/ LocalTaskManagerTest.php
File
-
core/
lib/ Drupal/ Core/ Menu/ LocalTaskInterface.php, line 16
Namespace
Drupal\Core\MenuView source
interface LocalTaskInterface {
/**
* Get the route name from the settings.
*
* @return string
* The name of the route this local task links to.
*/
public function getRouteName();
/**
* Returns the localized title to be shown for this tab.
*
* Subclasses may add optional arguments like NodeInterface $node = NULL that
* will be supplied by the ControllerResolver.
*
* @return string
* The title of the local task.
*/
public function getTitle();
/**
* Returns the route parameters needed to render a link for the local task.
*
* @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 of the local task.
*
* @return int|null
* The weight of the task or NULL.
*/
public function getWeight();
/**
* Returns options for rendering a link to the local task.
*
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The current route match.
*
* @return array
* An associative array of options.
*/
public function getOptions(RouteMatchInterface $route_match);
/**
* Sets the active status.
*
* @param bool $active
* Sets whether this tab is active (e.g. a parent of the current tab).
*
* @return $this
* The called object for chaining.
*/
public function setActive($active = TRUE);
/**
* Gets the active status.
*
* @return bool
* TRUE if the local task is active, FALSE otherwise.
*
* @see \Drupal\system\Plugin\MenuLocalTaskInterface::setActive()
*/
public function getActive();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
LocalTaskInterface::getActive | public | function | Gets the active status. | 1 |
LocalTaskInterface::getOptions | public | function | Returns options for rendering a link to the local task. | 1 |
LocalTaskInterface::getRouteName | public | function | Get the route name from the settings. | 1 |
LocalTaskInterface::getRouteParameters | public | function | Returns the route parameters needed to render a link for the local task. | 1 |
LocalTaskInterface::getTitle | public | function | Returns the localized title to be shown for this tab. | 1 |
LocalTaskInterface::getWeight | public | function | Returns the weight of the local task. | 1 |
LocalTaskInterface::setActive | public | function | Sets the active status. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.