vendor/sensio/framework-extra-bundle/src/Request/ParamConverter/ParamConverterManager.php line 84

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  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 Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter;
  14. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
  15. use Symfony\Component\HttpFoundation\Request;
  17. /**
  18.  * Managers converters.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  * @author Henrik Bjornskov <henrik@bjrnskov.dk>
  22.  */
  23. class ParamConverterManager
  24. {
  25.     /**
  26.      * @var array
  27.      */
  28.     private $converters = [];
  30.     /**
  31.      * @var array
  32.      */
  33.     private $namedConverters = [];
  35.     /**
  36.      * Applies all converters to the passed configurations and stops when a
  37.      * converter is applied it will move on to the next configuration and so on.
  38.      *
  39.      * @param array|object $configurations
  40.      */
  41.     public function apply(Request $request, $configurations)
  42.     {
  43.         if (\is_object($configurations)) {
  44.             $configurations = [$configurations];
  45.         }
  47.         foreach ($configurations as $configuration) {
  48.             $this->applyConverter($request, $configuration);
  49.         }
  50.     }
  52.     /**
  53.      * Applies converter on request based on the given configuration.
  54.      */
  55.     private function applyConverter(Request $request, ParamConverter $configuration)
  56.     {
  57.         $value = $request->attributes->get($configuration->getName());
  58.         $className = $configuration->getClass();
  60.         // If the value is already an instance of the class we are trying to convert it into
  61.         // we should continue as no conversion is required
  62.         if (\is_object($value) && $value instanceof $className) {
  63.             return;
  64.         }
  66.         if ($converterName = $configuration->getConverter()) {
  67.             if (!isset($this->namedConverters[$converterName])) {
  68.                 throw new \RuntimeException(sprintf("No converter named '%s' found for conversion of parameter '%s'.", $converterName, $configuration->getName()));
  69.             }
  71.             $converter = $this->namedConverters[$converterName];
  73.             if (!$converter->supports($configuration)) {
  74.                 throw new \RuntimeException(sprintf("Converter '%s' does not support conversion of parameter '%s'.", $converterName, $configuration->getName()));
  75.             }
  77.             $converter->apply($request, $configuration);
  79.             return;
  80.         }
  82.         foreach ($this->all() as $converter) {
  83.             if ($converter->supports($configuration)) {
  84.                 if ($converter->apply($request, $configuration)) {
  85.                     return;
  86.                 }
  87.             }
  88.         }
  89.     }
  91.     /**
  92.      * Adds a parameter converter.
  93.      *
  94.      * Converters match either explicitly via $name or by iteration over all
  95.      * converters with a $priority. If you pass a $priority = null then the
  96.      * added converter will not be part of the iteration chain and can only
  97.      * be invoked explicitly.
  98.      *
  99.      * @param int    $priority the priority (between -10 and 10)
  100.      * @param string $name     name of the converter
  101.      */
  102.     public function add(ParamConverterInterface $converter, $priority = 0, $name = null)
  103.     {
  104.         if (null !== $priority) {
  105.             if (!isset($this->converters[$priority])) {
  106.                 $this->converters[$priority] = [];
  107.             }
  109.             $this->converters[$priority][] = $converter;
  110.         }
  112.         if (null !== $name) {
  113.             $this->namedConverters[$name] = $converter;
  114.         }
  115.     }
  117.     /**
  118.      * Returns all registered param converters.
  119.      *
  120.      * @return array An array of param converters
  121.      */
  122.     public function all()
  123.     {
  124.         krsort($this->converters);
  126.         $converters = [];
  127.         foreach ($this->converters as $all) {
  128.             $converters = array_merge($converters, $all);
  129.         }
  131.         return $converters;
  132.     }
  133. }