www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/RouteProcessor/OutboundRouteProcessorInterface.php

   1 <?php
   2
   3 namespace Drupal\Core\RouteProcessor;
   4
   5 use Drupal\Core\Render\BubbleableMetadata;
   6 use Symfony\Component\Routing\Route;
   7
   8 /**
   9  * Defines an interface for classes that process the outbound route.
  10  */
  11 interface OutboundRouteProcessorInterface {
  12
  13   /**
  14    * Processes the outbound route.
  15    *
  16    * @param string $route_name
  17    *   The route name.
  18    * @param \Symfony\Component\Routing\Route $route
  19    *   The outbound route to process.
  20    * @param array $parameters
  21    *   An array of parameters to be passed to the route compiler. Passed by
  22    *   reference.
  23    * @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata
  24    *   (optional) Object to collect route processors' bubbleable metadata.
  25    *
  26    * @return
  27    *   The processed path.
  28    */
  29   public function processOutbound($route_name, Route $route, array &$parameters, BubbleableMetadata $bubbleable_metadata = NULL);
  30
  31 }