Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony CMF package.
Chris@0:  *
Chris@0:  * (c) 2011-2015 Symfony CMF
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Cmf\Component\Routing\NestedMatcher;
Chris@0: 
Chris@0: use Symfony\Component\HttpFoundation\Request;
Chris@0: use Symfony\Component\Routing\Exception\ResourceNotFoundException;
Chris@0: use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
Chris@0: use Symfony\Cmf\Component\Routing\RouteProviderInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * A more flexible approach to matching. The route collection to match against
Chris@0:  * can be dynamically determined based on the request and users can inject
Chris@0:  * their own filters or use a custom final matching strategy.
Chris@0:  *
Chris@0:  * The nested matcher splits matching into three configurable steps:
Chris@0:  *
Chris@0:  * 1) Get potential matches from a RouteProviderInterface
Chris@0:  * 2) Apply any RouteFilterInterface to reduce the route collection
Chris@0:  * 3) Have FinalMatcherInterface select the best match of the remaining routes
Chris@0:  *
Chris@0:  * @author Larry Garfield
Chris@0:  * @author David Buchmann
Chris@0:  */
Chris@0: class NestedMatcher implements RequestMatcherInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * The route provider responsible for the first-pass match.
Chris@0:      *
Chris@0:      * @var RouteProviderInterface
Chris@0:      */
Chris@0:     protected $routeProvider;
Chris@0: 
Chris@0:     /**
Chris@0:      * The final matcher.
Chris@0:      *
Chris@0:      * @var FinalMatcherInterface
Chris@0:      */
Chris@0:     protected $finalMatcher;
Chris@0: 
Chris@0:     /**
Chris@0:      * An array of RouteFilterInterface objects.
Chris@0:      *
Chris@0:      * @var RouteFilterInterface[]
Chris@0:      */
Chris@0:     protected $filters = array();
Chris@0: 
Chris@0:     /**
Chris@0:      * Array of RouteFilterInterface objects, sorted.
Chris@0:      *
Chris@0:      * @var RouteFilterInterface[]
Chris@0:      */
Chris@0:     protected $sortedFilters = array();
Chris@0: 
Chris@0:     /**
Chris@0:      * Constructs a new NestedMatcher.
Chris@0:      *
Chris@0:      * @param RouteProviderInterface $provider The route provider this matcher
Chris@0:      *                                         should use
Chris@0:      * @param FinalMatcherInterface  $final    The Final Matcher to match the
Chris@0:      *                                         routes
Chris@0:      */
Chris@0:     public function __construct(
Chris@0:         RouteProviderInterface $provider = null,
Chris@0:         FinalMatcherInterface $final = null
Chris@0:     ) {
Chris@0:         if (null !== $provider) {
Chris@0:             $this->setRouteProvider($provider);
Chris@0:         }
Chris@0:         if (null !== $final) {
Chris@0:             $this->setFinalMatcher($final);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the route provider for the matching plan.
Chris@0:      *
Chris@0:      * @param RouteProviderInterface $provider A source of routes.
Chris@0:      *
Chris@0:      * @return NestedMatcher this object to have a fluent interface
Chris@0:      */
Chris@0:     public function setRouteProvider(RouteProviderInterface $provider)
Chris@0:     {
Chris@0:         $this->routeProvider = $provider;
Chris@0: 
Chris@0:         return $this;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Adds a partial matcher to the matching plan.
Chris@0:      *
Chris@0:      * Partial matchers will be run in the order in which they are added.
Chris@0:      *
Chris@0:      * @param RouteFilterInterface $filter
Chris@0:      * @param int                  $priority (optional) The priority of the
Chris@0:      *                                       filter. Higher number filters will
Chris@0:      *                                       be used first. Defaults to 0.
Chris@0:      *
Chris@0:      * @return NestedMatcher this object to have a fluent interface
Chris@0:      */
Chris@0:     public function addRouteFilter(RouteFilterInterface $filter, $priority = 0)
Chris@0:     {
Chris@0:         if (empty($this->filters[$priority])) {
Chris@0:             $this->filters[$priority] = array();
Chris@0:         }
Chris@0: 
Chris@0:         $this->filters[$priority][] = $filter;
Chris@0:         $this->sortedFilters = array();
Chris@0: 
Chris@0:         return $this;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the final matcher for the matching plan.
Chris@0:      *
Chris@0:      * @param FinalMatcherInterface $final The final matcher that will have to
Chris@0:      *                                     pick the route that will be used.
Chris@0:      *
Chris@0:      * @return NestedMatcher this object to have a fluent interface
Chris@0:      */
Chris@0:     public function setFinalMatcher(FinalMatcherInterface $final)
Chris@0:     {
Chris@0:         $this->finalMatcher = $final;
Chris@0: 
Chris@0:         return $this;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function matchRequest(Request $request)
Chris@0:     {
Chris@0:         $collection = $this->routeProvider->getRouteCollectionForRequest($request);
Chris@0:         if (!count($collection)) {
Chris@0:             throw new ResourceNotFoundException();
Chris@0:         }
Chris@0: 
Chris@0:         // Route filters are expected to throw an exception themselves if they
Chris@0:         // end up filtering the list down to 0.
Chris@0:         foreach ($this->getRouteFilters() as $filter) {
Chris@0:             $collection = $filter->filter($collection, $request);
Chris@0:         }
Chris@0: 
Chris@0:         $attributes = $this->finalMatcher->finalMatch($collection, $request);
Chris@0: 
Chris@0:         return $attributes;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sorts the filters and flattens them.
Chris@0:      *
Chris@0:      * @return RouteFilterInterface[] the filters ordered by priority
Chris@0:      */
Chris@0:     public function getRouteFilters()
Chris@0:     {
Chris@0:         if (empty($this->sortedFilters)) {
Chris@0:             $this->sortedFilters = $this->sortFilters();
Chris@0:         }
Chris@0: 
Chris@0:         return $this->sortedFilters;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sort filters by priority.
Chris@0:      *
Chris@0:      * The highest priority number is the highest priority (reverse sorting).
Chris@0:      *
Chris@0:      * @return RouteFilterInterface[] the sorted filters
Chris@0:      */
Chris@0:     protected function sortFilters()
Chris@0:     {
Chris@0:         $sortedFilters = array();
Chris@0:         krsort($this->filters);
Chris@0: 
Chris@0:         foreach ($this->filters as $filters) {
Chris@0:             $sortedFilters = array_merge($sortedFilters, $filters);
Chris@0:         }
Chris@0: 
Chris@0:         return $sortedFilters;
Chris@0:     }
Chris@0: }