Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Menu\MenuActiveTrailInterface.
6	*/
7
8	namespace Drupal\Core\Menu;
9
10	/**
11	* Defines an interface for the active menu trail service.
12	*
13	* The active trail of a given menu is the trail from the current page to the
14	* root of that menu's tree.
15	*/
16	interface MenuActiveTrailInterface {
17
18	/**
19	* Gets the active trail IDs of the specified menu tree.
20	*
21	* @param string\|NULL $menu_name
22	* (optional) The menu name of the requested tree. If omitted, all menu
23	* trees will be searched.
24	*
25	* @return array
26	* An array containing the active trail: a list of plugin IDs.
27	*/
28	public function getActiveTrailIds($menu_name);
29
30	/**
31	* Fetches a menu link which matches the route name, parameters and menu name.
32	*
33	* @param string\|NULL $menu_name
34	* (optional) The menu within which to find the active link. If omitted, all
35	* menus will be searched.
36	*
37	* @return \Drupal\Core\Menu\MenuLinkInterface\|NULL
38	* The menu link for the given route name, parameters and menu, or NULL if
39	* there is no matching menu link or the current user cannot access the
40	* current page (i.e. we have a 403 response).
41	*/
42	public function getActiveLink($menu_name = NULL);
43
44	}