vendor/symfony-cmf/routing/src/NestedMatcher/NestedMatcher.php line 140

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony CMF package.
  5.  *
  6.  * (c) Symfony CMF
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Cmf\Component\Routing\NestedMatcher;
  14. use Symfony\Cmf\Component\Routing\RouteProviderInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\Routing\Exception\ResourceNotFoundException;
  17. use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
  19. /**
  20.  * A more flexible approach to matching. The route collection to match against
  21.  * can be dynamically determined based on the request and users can inject
  22.  * their own filters or use a custom final matching strategy.
  23.  *
  24.  * The nested matcher splits matching into three configurable steps:
  25.  *
  26.  * 1) Get potential matches from a RouteProviderInterface
  27.  * 2) Apply any RouteFilterInterface to reduce the route collection
  28.  * 3) Have FinalMatcherInterface select the best match of the remaining routes
  29.  *
  30.  * @author Larry Garfield
  31.  * @author David Buchmann
  32.  */
  33. class NestedMatcher implements RequestMatcherInterface
  34. {
  35.     /**
  36.      * The route provider responsible for the first-pass match.
  37.      *
  38.      * @var RouteProviderInterface
  39.      */
  40.     protected $routeProvider;
  42.     /**
  43.      * The final matcher.
  44.      *
  45.      * @var FinalMatcherInterface
  46.      */
  47.     protected $finalMatcher;
  49.     /**
  50.      * An array of RouteFilterInterface objects.
  51.      *
  52.      * @var RouteFilterInterface[]
  53.      */
  54.     protected $filters = [];
  56.     /**
  57.      * Array of RouteFilterInterface objects, sorted.
  58.      *
  59.      * @var RouteFilterInterface[]
  60.      */
  61.     protected $sortedFilters = [];
  63.     /**
  64.      * Constructs a new NestedMatcher.
  65.      *
  66.      * @param RouteProviderInterface $provider The route provider this matcher
  67.      *                                         should use
  68.      * @param FinalMatcherInterface  $final    The Final Matcher to match the
  69.      *                                         routes
  70.      */
  71.     public function __construct(
  72.         RouteProviderInterface $provider = null,
  73.         FinalMatcherInterface $final = null
  74.     ) {
  75.         if (null !== $provider) {
  76.             $this->setRouteProvider($provider);
  77.         }
  78.         if (null !== $final) {
  79.             $this->setFinalMatcher($final);
  80.         }
  81.     }
  83.     /**
  84.      * Sets the route provider for the matching plan.
  85.      *
  86.      * @param RouteProviderInterface $provider A source of routes
  87.      *
  88.      * @return NestedMatcher this object to have a fluent interface
  89.      */
  90.     public function setRouteProvider(RouteProviderInterface $provider)
  91.     {
  92.         $this->routeProvider = $provider;
  94.         return $this;
  95.     }
  97.     /**
  98.      * Adds a partial matcher to the matching plan.
  99.      *
  100.      * Partial matchers will be run in the order in which they are added.
  101.      *
  102.      * @param int $priority (optional) The priority of the
  103.      *                      filter. Higher number filters will
  104.      *                      be used first. Defaults to 0
  105.      *
  106.      * @return NestedMatcher this object to have a fluent interface
  107.      */
  108.     public function addRouteFilter(RouteFilterInterface $filter, $priority = 0)
  109.     {
  110.         if (empty($this->filters[$priority])) {
  111.             $this->filters[$priority] = [];
  112.         }
  114.         $this->filters[$priority][] = $filter;
  115.         $this->sortedFilters = [];
  117.         return $this;
  118.     }
  120.     /**
  121.      * Sets the final matcher for the matching plan.
  122.      *
  123.      * @param FinalMatcherInterface $final The final matcher that will have to
  124.      *                                     pick the route that will be used
  125.      *
  126.      * @return NestedMatcher this object to have a fluent interface
  127.      */
  128.     public function setFinalMatcher(FinalMatcherInterface $final)
  129.     {
  130.         $this->finalMatcher = $final;
  132.         return $this;
  133.     }
  135.     /**
  136.      * {@inheritdoc}
  137.      */
  138.     public function matchRequest(Request $request)
  139.     {
  140.         $collection = $this->routeProvider->getRouteCollectionForRequest($request);
  141.         if (!count($collection)) {
  142.             throw new ResourceNotFoundException();
  143.         }
  145.         // Route filters are expected to throw an exception themselves if they
  146.         // end up filtering the list down to 0.
  147.         foreach ($this->getRouteFilters() as $filter) {
  148.             $collection = $filter->filter($collection, $request);
  149.         }
  151.         return $this->finalMatcher->finalMatch($collection, $request);
  152.     }
  154.     /**
  155.      * Sorts the filters and flattens them.
  156.      *
  157.      * @return RouteFilterInterface[] the filters ordered by priority
  158.      */
  159.     public function getRouteFilters()
  160.     {
  161.         if (0 === count($this->sortedFilters)) {
  162.             $this->sortedFilters = $this->sortFilters();
  163.         }
  165.         return $this->sortedFilters;
  166.     }
  168.     /**
  169.      * Sort filters by priority.
  170.      *
  171.      * The highest priority number is the highest priority (reverse sorting).
  172.      *
  173.      * @return RouteFilterInterface[] the sorted filters
  174.      */
  175.     protected function sortFilters()
  176.     {
  177.         if (0 === count($this->filters)) {
  178.             return [];
  179.         }
  181.         krsort($this->filters);
  183.         return call_user_func_array('array_merge', $this->filters);
  184.     }
  185. }