www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/drupalmoduleupgrader/src/Routing/RouteWrapperInterface.php

   1 <?php
   2
   3 namespace Drupal\drupalmoduleupgrader\Routing;
   4
   5 /**
   6  * Common interface implemented by classes which wrap around Drupal 7 or
   7  * Drupal 8 routes.
   8  */
   9 interface RouteWrapperInterface {
  10
  11   /**
  12    * Returns an identifier for this route.
  13    *
  14    * @return string
  15    */
  16   public function getIdentifier();
  17
  18   /**
  19    * Returns a PathUtilityInterface implementation for the route.
  20    *
  21    * @return \Drupal\drupalmoduleupgrader\Utility\Path\PathUtilityInterface
  22    */
  23   public function getPath();
  24
  25   /**
  26    * Returns if this route has a parent.
  27    *
  28    * @return boolean
  29    */
  30   public function hasParent();
  31
  32   /**
  33    * Gets the parent route, if there is one. The parent should also be wrapped.
  34    *
  35    * @return static|NULL
  36    */
  37   public function getParent();
  38
  39   /**
  40    * Returns the original, unwrapped route.
  41    *
  42    * @return mixed
  43    */
  44   public function unwrap();
  45
  46   /**
  47    * React to the router (i.e., the collection of routes defined by the
  48    * module) being completely built.
  49    *
  50    * @param RouterBuiltEvent $event
  51    *  The event object.
  52    */
  53   public function onRouterBuilt(RouterBuiltEvent $event);
  54
  55 }