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

   1 <?php
   2
   3 namespace Drupal\Core\PathProcessor;
   4
   5 use Symfony\Component\HttpFoundation\Request;
   6
   7 /**
   8  * Defines an interface for classes that process the inbound path.
   9  */
  10 interface InboundPathProcessorInterface {
  11
  12   /**
  13    * Processes the inbound path.
  14    *
  15    * Implementations may make changes to the request object passed in but should
  16    * avoid all other side effects. This method can be called to process requests
  17    * other than the current request.
  18    *
  19    * @param string $path
  20    *   The path to process, with a leading slash.
  21    * @param \Symfony\Component\HttpFoundation\Request $request
  22    *   The HttpRequest object representing the request to process. Note, if this
  23    *   method is being called via the path_processor_manager service and is not
  24    *   part of routing, the current request object must be cloned before being
  25    *   passed in.
  26    *
  27    * @return string
  28    *   The processed path.
  29    */
  30   public function processInbound($path, Request $request);
  31
  32 }