Version 1

[yaffs-website] / web / core / lib / Drupal / Core / Routing / StackedRouteMatchInterface.php

diff --git a/web/core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php b/web/core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php
new file mode 100644 (file)
index 0000000..45b777c
--- /dev/null
+++ b/web/core/lib/Drupal/Core/Routing/StackedRouteMatchInterface.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace Drupal\Core\Routing;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Defines an interface for a stack of route matches.
+ *
+ * This could be for example used on exception pages.
+ */
+interface StackedRouteMatchInterface extends RouteMatchInterface {
+
+  /**
+   * Gets the current route match.
+   *
+   * @return \Drupal\Core\Routing\RouteMatchInterface
+   */
+  public function getCurrentRouteMatch();
+
+  /**
+   * Gets the master route match..
+   *
+   * @return \Drupal\Core\Routing\RouteMatchInterface
+   */
+  public function getMasterRouteMatch();
+
+  /**
+   * Returns the parent route match of the current.
+   *
+   * @return \Drupal\Core\Routing\RouteMatchInterface|null
+   *   The parent route match or NULL, if it the master route match.
+   */
+  public function getParentRouteMatch();
+
+  /**
+   * Returns a route match from a given request, if possible.
+   *
+   * @param \Symfony\Component\HttpFoundation\Request $request
+   *   The request.
+   *
+   * @return \Drupal\Core\Routing\RouteMatchInterface|null
+   *   THe matching route match, or NULL if there is no matching one.
+   */
+  public function getRouteMatchFromRequest(Request $request);
+
+}