You are here

class TraceableUrlMatcher in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/symfony/routing/Matcher/TraceableUrlMatcher.php \Symfony\Component\Routing\Matcher\TraceableUrlMatcher

TraceableUrlMatcher helps debug path info matching by tracing the match.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

Expanded class hierarchy of TraceableUrlMatcher

1 file declares its use of TraceableUrlMatcher
TraceableUrlMatcherTest.php in vendor/symfony/routing/Tests/Matcher/TraceableUrlMatcherTest.php

File

vendor/symfony/routing/Matcher/TraceableUrlMatcher.php, line 23

Namespace

Symfony\Component\Routing\Matcher
View source
class TraceableUrlMatcher extends UrlMatcher {
  const ROUTE_DOES_NOT_MATCH = 0;
  const ROUTE_ALMOST_MATCHES = 1;
  const ROUTE_MATCHES = 2;
  protected $traces;
  public function getTraces($pathinfo) {
    $this->traces = array();
    try {
      $this
        ->match($pathinfo);
    } catch (ExceptionInterface $e) {
    }
    return $this->traces;
  }
  protected function matchCollection($pathinfo, RouteCollection $routes) {
    foreach ($routes as $name => $route) {
      $compiledRoute = $route
        ->compile();
      if (!preg_match($compiledRoute
        ->getRegex(), $pathinfo, $matches)) {

        // does it match without any requirements?
        $r = new Route($route
          ->getPath(), $route
          ->getDefaults(), array(), $route
          ->getOptions());
        $cr = $r
          ->compile();
        if (!preg_match($cr
          ->getRegex(), $pathinfo)) {
          $this
            ->addTrace(sprintf('Path "%s" does not match', $route
            ->getPath()), self::ROUTE_DOES_NOT_MATCH, $name, $route);
          continue;
        }
        foreach ($route
          ->getRequirements() as $n => $regex) {
          $r = new Route($route
            ->getPath(), $route
            ->getDefaults(), array(
            $n => $regex,
          ), $route
            ->getOptions());
          $cr = $r
            ->compile();
          if (in_array($n, $cr
            ->getVariables()) && !preg_match($cr
            ->getRegex(), $pathinfo)) {
            $this
              ->addTrace(sprintf('Requirement for "%s" does not match (%s)', $n, $regex), self::ROUTE_ALMOST_MATCHES, $name, $route);
            continue 2;
          }
        }
        continue;
      }

      // check host requirement
      $hostMatches = array();
      if ($compiledRoute
        ->getHostRegex() && !preg_match($compiledRoute
        ->getHostRegex(), $this->context
        ->getHost(), $hostMatches)) {
        $this
          ->addTrace(sprintf('Host "%s" does not match the requirement ("%s")', $this->context
          ->getHost(), $route
          ->getHost()), self::ROUTE_ALMOST_MATCHES, $name, $route);
        continue;
      }

      // check HTTP method requirement
      if ($requiredMethods = $route
        ->getMethods()) {

        // HEAD and GET are equivalent as per RFC
        if ('HEAD' === ($method = $this->context
          ->getMethod())) {
          $method = 'GET';
        }
        if (!in_array($method, $requiredMethods)) {
          $this->allow = array_merge($this->allow, $requiredMethods);
          $this
            ->addTrace(sprintf('Method "%s" does not match any of the required methods (%s)', $this->context
            ->getMethod(), implode(', ', $requiredMethods)), self::ROUTE_ALMOST_MATCHES, $name, $route);
          continue;
        }
      }

      // check condition
      if ($condition = $route
        ->getCondition()) {
        if (!$this
          ->getExpressionLanguage()
          ->evaluate($condition, array(
          'context' => $this->context,
          'request' => $this->request,
        ))) {
          $this
            ->addTrace(sprintf('Condition "%s" does not evaluate to "true"', $condition), self::ROUTE_ALMOST_MATCHES, $name, $route);
          continue;
        }
      }

      // check HTTP scheme requirement
      if ($requiredSchemes = $route
        ->getSchemes()) {
        $scheme = $this->context
          ->getScheme();
        if (!$route
          ->hasScheme($scheme)) {
          $this
            ->addTrace(sprintf('Scheme "%s" does not match any of the required schemes (%s); the user will be redirected to first required scheme', $scheme, implode(', ', $requiredSchemes)), self::ROUTE_ALMOST_MATCHES, $name, $route);
          return true;
        }
      }
      $this
        ->addTrace('Route matches!', self::ROUTE_MATCHES, $name, $route);
      return true;
    }
  }
  private function addTrace($log, $level = self::ROUTE_DOES_NOT_MATCH, $name = null, $route = null) {
    $this->traces[] = array(
      'log' => $log,
      'name' => $name,
      'level' => $level,
      'path' => null !== $route ? $route
        ->getPath() : null,
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
TraceableUrlMatcher::$traces protected property
TraceableUrlMatcher::addTrace private function
TraceableUrlMatcher::getTraces public function
TraceableUrlMatcher::matchCollection protected function Tries to match a URL with a set of routes. Overrides UrlMatcher::matchCollection
TraceableUrlMatcher::ROUTE_ALMOST_MATCHES constant
TraceableUrlMatcher::ROUTE_DOES_NOT_MATCH constant
TraceableUrlMatcher::ROUTE_MATCHES constant
UrlMatcher::$allow protected property
UrlMatcher::$context protected property
UrlMatcher::$expressionLanguage protected property
UrlMatcher::$expressionLanguageProviders protected property
UrlMatcher::$request protected property
UrlMatcher::$routes protected property
UrlMatcher::addExpressionLanguageProvider public function
UrlMatcher::getAttributes protected function Returns an array of values to use as request attributes. 1
UrlMatcher::getContext public function Gets the request context. Overrides RequestContextAwareInterface::getContext
UrlMatcher::getExpressionLanguage protected function
UrlMatcher::handleRouteRequirements protected function Handles specific route requirements. 1
UrlMatcher::match public function Tries to match a URL path with a set of routes. Overrides UrlMatcherInterface::match 5
UrlMatcher::matchRequest public function Tries to match a request with a set of routes. Overrides RequestMatcherInterface::matchRequest
UrlMatcher::mergeDefaults protected function Get merged default parameters.
UrlMatcher::REQUIREMENT_MATCH constant
UrlMatcher::REQUIREMENT_MISMATCH constant
UrlMatcher::ROUTE_MATCH constant
UrlMatcher::setContext public function Sets the request context. Overrides RequestContextAwareInterface::setContext
UrlMatcher::__construct public function Constructor. 4