OutboundRouteProcessorInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/RouteProcessor/OutboundRouteProcessorInterface.php
  2. 10 core/lib/Drupal/Core/RouteProcessor/OutboundRouteProcessorInterface.php
  3. 11.x core/lib/Drupal/Core/RouteProcessor/OutboundRouteProcessorInterface.php

Namespace

Drupal\Core\RouteProcessor

File

core/lib/Drupal/Core/RouteProcessor/OutboundRouteProcessorInterface.php

View source
<?php

namespace Drupal\Core\RouteProcessor;

use Drupal\Core\Render\BubbleableMetadata;
use Symfony\Component\Routing\Route;

/**
 * Defines an interface for classes that process the outbound route.
 */
interface OutboundRouteProcessorInterface {
    
    /**
     * Processes the outbound route.
     *
     * @param string $route_name
     *   The route name.
     * @param \Symfony\Component\Routing\Route $route
     *   The outbound route to process.
     * @param array $parameters
     *   An array of parameters to be passed to the route compiler. Passed by
     *   reference.
     * @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata
     *   (optional) Object to collect route processors' bubbleable metadata.
     *
     * @return
     *   The processed path.
     */
    public function processOutbound($route_name, Route $route, array &$parameters, BubbleableMetadata $bubbleable_metadata = NULL);

}

Interfaces

Title Deprecated Summary
OutboundRouteProcessorInterface Defines an interface for classes that process the outbound route.

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