blob: 12f0275584c26c5d40986beb515a51f84eb0c0ca (
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
|
<?php
namespace Drupal\Core\Menu;
/**
* Provides an object which returns the available contextual links.
*/
interface ContextualLinkManagerInterface {
/**
* Gets the contextual link plugins by contextual link group.
*
* @param string $group_name
* The group name.
*
* @return array
* A list of contextual links plugin definitions.
*/
public function getContextualLinkPluginsByGroup($group_name);
/**
* Gets the contextual links prepared as expected by links.html.twig.
*
* @param string $group_name
* The group name.
* @param array $route_parameters
* The incoming route parameters. The route parameters need to have the same
* name on all contextual link routes, e.g. you cannot use 'node' and
* 'entity' in parallel.
* @param array $metadata
* Additional metadata of contextual links, like the position (optional).
*
* @return array
* An array of link information, keyed by the plugin ID. Each entry is an
* associative array with the following keys:
* - route_name: The route name to link to.
* - route_parameters: The route parameters for the contextual link.
* - title: The title of the contextual link.
* - weight: The weight of the contextual link.
* - localized_options: The options of the link, which will be passed
* to the link generator.
* - metadata: The array of additional metadata that was passed in.
*/
public function getContextualLinksArrayByGroup($group_name, array $route_parameters, array $metadata = []);
}
|
