TraceableUrlMatcher.php in Zircon Profile 8

Namespace

Symfony\Component\Routing\Matcher

File

vendor/symfony/routing/Matcher/TraceableUrlMatcher.php

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\Routing\Matcher;

use Symfony\Component\Routing\Exception\ExceptionInterface;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

/**
 * TraceableUrlMatcher helps debug path info matching by tracing the match.
 *
 * @author Fabien Potencier <[e-mail]>
 */
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,
    );
  }

}

Classes

Name	Description
TraceableUrlMatcher	TraceableUrlMatcher helps debug path info matching by tracing the match.