interface InboundPathProcessorInterface in Drupal 10

Defines an interface for classes that process the inbound path.

Hierarchy

• interface \Drupal\Core\PathProcessor\InboundPathProcessorInterface

12 files declare their use of InboundPathProcessorInterface

AliasPathProcessor.php in core/modules/path_alias/src/PathProcessor/AliasPathProcessor.php

BrokenInboundPathProcessor.php in core/modules/system/tests/modules/update_script_test/src/PathProcessor/BrokenInboundPathProcessor.php

ConfigTranslationController.php in core/modules/config_translation/src/Controller/ConfigTranslationController.php

LanguageNegotiationUrl.php in core/modules/language/src/Plugin/LanguageNegotiation/LanguageNegotiationUrl.php

PathBasedBreadcrumbBuilder.php in core/modules/system/src/PathBasedBreadcrumbBuilder.php

... See full list

File

core/lib/Drupal/Core/PathProcessor/InboundPathProcessorInterface.php, line 10

Namespace

Drupal\Core\PathProcessor

interface InboundPathProcessorInterface {

  /**
   * Processes the inbound path.
   *
   * Implementations may make changes to the request object passed in but should
   * avoid all other side effects. This method can be called to process requests
   * other than the current request.
   *
   * @param string $path
   *   The path to process, with a leading slash.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The HttpRequest object representing the request to process. Note, if this
   *   method is being called via the path_processor_manager service and is not
   *   part of routing, the current request object must be cloned before being
   *   passed in.
   *
   * @return string
   *   The processed path.
   */
  public function processInbound($path, Request $request);

}