Mercurial > hg > isophonics-drupal-site
view core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php @ 16:c2387f117808
Routine composer update
author | Chris Cannam |
---|---|
date | Tue, 10 Jul 2018 15:07:59 +0100 |
parents | 4c8ae668cc8c |
children |
line wrap: on
line source
<?php namespace Drupal\Core\Menu; /** * Defines an interface for the active menu trail service. * * The active trail of a given menu is the trail from the current page to the * root of that menu's tree. */ interface MenuActiveTrailInterface { /** * Gets the active trail IDs of the specified menu tree. * * @param string|null $menu_name * (optional) The menu name of the requested tree. If omitted, all menu * trees will be searched. * * @return array * An array containing the active trail: a list of plugin IDs. */ public function getActiveTrailIds($menu_name); /** * Fetches a menu link which matches the route name, parameters and menu name. * * @param string|null $menu_name * (optional) The menu within which to find the active link. If omitted, all * menus will be searched. * * @return \Drupal\Core\Menu\MenuLinkInterface|null * The menu link for the given route name, parameters and menu, or NULL if * there is no matching menu link or the current user cannot access the * current page (i.e. we have a 403 response). */ public function getActiveLink($menu_name = NULL); }