blob: 31e0fd77d098bea8fb7e753ca90078e8bc1e033e (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
<?php
namespace Drupal\Core\Menu;
use Drupal\Core\Routing\RouteMatchInterface;
/**
* 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.
*
* @see \Drupal\Core\Menu\LocalTaskManagerInterface
*/
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();
}
|
