vendor/symfony-cmf/routing/src/Enhancer/RouteEnhancerTrait.php line 47

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\Enhancer;
  14. use Symfony\Component\HttpFoundation\Request;
  16. /**
  17.  * Functionality to collect and apply route enhancers to a request.
  18.  *
  19.  * @author Tim Plunkett
  20.  * @author Larry Garfield
  21.  * @author David Buchmann
  22.  */
  23. trait RouteEnhancerTrait
  24. {
  25.     /**
  26.      * @var RouteEnhancerInterface[][]
  27.      */
  28.     private $enhancers = [];
  30.     /**
  31.      * Cached sorted list of enhancers.
  32.      *
  33.      * @var RouteEnhancerInterface[]
  34.      */
  35.     private $sortedEnhancers = [];
  37.     /**
  38.      * Apply the route enhancers to the defaults, according to priorities.
  39.      *
  40.      * @param array $defaults
  41.      *
  42.      * @return array
  43.      */
  44.     protected function applyRouteEnhancers($defaults, Request $request)
  45.     {
  46.         foreach ($this->getRouteEnhancers() as $enhancer) {
  47.             $defaults = $enhancer->enhance($defaults, $request);
  48.         }
  50.         return $defaults;
  51.     }
  53.     /**
  54.      * Add route enhancers to the router to let them generate information on
  55.      * matched routes.
  56.      *
  57.      * The order of the enhancers is determined by the priority, the higher the
  58.      * value, the earlier the enhancer is run.
  59.      *
  60.      * @param int $priority
  61.      *
  62.      * @return self
  63.      */
  64.     public function addRouteEnhancer(RouteEnhancerInterface $enhancer, $priority = 0)
  65.     {
  66.         if (empty($this->enhancers[$priority])) {
  67.             $this->enhancers[$priority] = [];
  68.         }
  70.         $this->enhancers[$priority][] = $enhancer;
  71.         $this->sortedEnhancers = [];
  73.         return $this;
  74.     }
  76.     /**
  77.      * Sorts the enhancers and flattens them.
  78.      *
  79.      * @return RouteEnhancerInterface[] the enhancers ordered by priority
  80.      */
  81.     public function getRouteEnhancers()
  82.     {
  83.         if (0 === count($this->sortedEnhancers)) {
  84.             $this->sortedEnhancers = $this->sortRouteEnhancers();
  85.         }
  87.         return $this->sortedEnhancers;
  88.     }
  90.     /**
  91.      * Sort enhancers by priority.
  92.      *
  93.      * The highest priority number is the highest priority (reverse sorting).
  94.      *
  95.      * @return RouteEnhancerInterface[] the sorted enhancers
  96.      */
  97.     private function sortRouteEnhancers()
  98.     {
  99.         if (0 === count($this->enhancers)) {
  100.             return [];
  101.         }
  103.         krsort($this->enhancers);
  105.         return call_user_func_array('array_merge', $this->enhancers);
  106.     }
  107. }