InboundPathProcessorInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/PathProcessor/InboundPathProcessorInterface.php
  2. 8.9.x core/lib/Drupal/Core/PathProcessor/InboundPathProcessorInterface.php
  3. 10 core/lib/Drupal/Core/PathProcessor/InboundPathProcessorInterface.php

Namespace

Drupal\Core\PathProcessor

File

core/lib/Drupal/Core/PathProcessor/InboundPathProcessorInterface.php

View source
<?php

namespace Drupal\Core\PathProcessor;

use Symfony\Component\HttpFoundation\Request;

/**
 * Defines an interface for classes that process the inbound path.
 */
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);

}

Interfaces

Title Deprecated Summary
InboundPathProcessorInterface Defines an interface for classes that process the inbound path.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.