Version 1

[yaffs-website] / web / core / lib / Drupal / Core / Menu / MenuActiveTrailInterface.php

diff --git a/web/core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php b/web/core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php
new file mode 100644 (file)
index 0000000..8410e5a
--- /dev/null
+++ b/web/core/lib/Drupal/Core/Menu/MenuActiveTrailInterface.php
@@ -0,0 +1,39 @@
+<?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);
+
+}