UrlMatcher.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Routing/UrlMatcher.php
  2. 10 core/lib/Drupal/Core/Routing/UrlMatcher.php
  3. 11.x core/lib/Drupal/Core/Routing/UrlMatcher.php

Namespace

Drupal\Core\Routing

File

core/lib/Drupal/Core/Routing/UrlMatcher.php

View source
<?php

namespace Drupal\Core\Routing;

use Drupal\Core\Path\CurrentPathStack;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Matcher\UrlMatcher as BaseUrlMatcher;

/**
 * Drupal-specific URL Matcher; handles the Drupal "system path" mapping.
 */
class UrlMatcher extends BaseUrlMatcher {
    
    /**
     * The current path.
     *
     * @var \Drupal\Core\Path\CurrentPathStack
     */
    protected $currentPath;
    
    /**
     * Constructs a new UrlMatcher.
     *
     * The parent class has a constructor we need to skip, so just override it
     * with a no-op.
     *
     * @param \Drupal\Core\Path\CurrentPathStack $current_path
     *   The current path.
     */
    public function __construct(CurrentPathStack $current_path) {
        $this->currentPath = $current_path;
    }
    public function finalMatch(RouteCollection $collection, Request $request) {
        $this->routes = $collection;
        $context = new RequestContext();
        $context->fromRequest($request);
        $this->setContext($context);
        return $this->match($this->currentPath
            ->getPath($request));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getAttributes(Route $route, $name, array $attributes) : array {
        if ($route instanceof RouteObjectInterface && is_string($route->getRouteKey())) {
            $name = $route->getRouteKey();
        }
        $attributes[RouteObjectInterface::ROUTE_NAME] = $name;
        $attributes[RouteObjectInterface::ROUTE_OBJECT] = $route;
        return $this->mergeDefaults($attributes, $route->getDefaults());
    }

}

Classes

Title Deprecated Summary
UrlMatcher Drupal-specific URL Matcher; handles the Drupal "system path" mapping.

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