vendor/friendsofsymfony/rest-bundle/Request/ParamFetcher.php line 36

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the FOSRestBundle package.
  4.  *
  5.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace FOS\RestBundle\Request;
  11. use FOS\RestBundle\Controller\Annotations\ParamInterface;
  12. use FOS\RestBundle\Exception\InvalidParameterException;
  13. use FOS\RestBundle\Util\ResolverTrait;
  14. use FOS\RestBundle\Validator\Constraints\ResolvableConstraintInterface;
  15. use Symfony\Component\DependencyInjection\ContainerInterface;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  19. use Symfony\Component\Validator\Constraint;
  20. use Symfony\Component\Validator\ConstraintViolationList;
  21. use Symfony\Component\Validator\Validator\ValidatorInterface;
  22. use Symfony\Component\Validator\Exception\ValidatorException;
  23. use Symfony\Component\Validator\ConstraintViolation;
  24. /**
  25.  * Helper to validate parameters of the active request.
  26.  *
  27.  * @author Alexander <iam.asm89@gmail.com>
  28.  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
  29.  * @author Jordi Boggiano <j.boggiano@seld.be>
  30.  * @author Boris GuĂ©ry <guery.b@gmail.com>
  31.  */
  32. class ParamFetcher implements ParamFetcherInterface
  33. {
  34.     use ResolverTrait;
  35.     private $container;
  36.     private $parameterBag;
  37.     private $requestStack;
  38.     private $validator;
  39.     /**
  40.      * Initializes fetcher.
  41.      *
  42.      * @param ContainerInterface   $container
  43.      * @param ParamReaderInterface $paramReader
  44.      * @param RequestStack         $requestStack
  45.      * @param ValidatorInterface   $validator
  46.      */
  47.     public function __construct(ContainerInterface $containerParamReaderInterface $paramReaderRequestStack $requestStackValidatorInterface $validator null)
  48.     {
  49.         if (null === $validator) {
  50.             @trigger_error(sprintf('Using no validator is deprecated since FOSRestBundle 2.6. The `$validator` constructor argument of the `%s` will become mandatory in 3.0.'__CLASS__), E_USER_DEPRECATED);
  51.         }
  52.         $this->container $container;
  53.         $this->requestStack $requestStack;
  54.         $this->validator $validator;
  55.         $this->parameterBag = new ParameterBag($paramReader);
  56.     }
  57.     /**
  58.      * {@inheritdoc}
  59.      */
  60.     public function setController($controller)
  61.     {
  62.         $this->parameterBag->setController($this->getRequest(), $controller);
  63.     }
  64.     /**
  65.      * Add additional params to the ParamFetcher during runtime.
  66.      *
  67.      * Note that adding a param that has the same name as an existing param will override that param.
  68.      *
  69.      * @param ParamInterface $param
  70.      */
  71.     public function addParam(ParamInterface $param)
  72.     {
  73.         $this->parameterBag->addParam($this->getRequest(), $param);
  74.     }
  75.     /**
  76.      * @return ParamInterface[]
  77.      */
  78.     public function getParams()
  79.     {
  80.         return $this->parameterBag->getParams($this->getRequest());
  81.     }
  82.     /**
  83.      * {@inheritdoc}
  84.      */
  85.     public function get($name$strict null)
  86.     {
  87.         $params $this->getParams();
  88.         if (!array_key_exists($name$params)) {
  89.             throw new \InvalidArgumentException(sprintf("No @ParamInterface configuration for parameter '%s'."$name));
  90.         }
  91.         /** @var ParamInterface $param */
  92.         $param $params[$name];
  93.         $default $param->getDefault();
  94.         $default $this->resolveValue($this->container$default);
  95.         $strict = (null !== $strict $strict $param->isStrict());
  96.         $paramValue $param->getValue($this->getRequest(), $default);
  97.         return $this->cleanParamWithRequirements($param$paramValue$strict$default);
  98.     }
  99.     /**
  100.      * @param ParamInterface $param
  101.      * @param mixed          $paramValue
  102.      * @param bool           $strict
  103.      * @param mixed          $default
  104.      *
  105.      * @throws BadRequestHttpException
  106.      * @throws \RuntimeException
  107.      *
  108.      * @return mixed
  109.      *
  110.      * @internal
  111.      */
  112.     protected function cleanParamWithRequirements(ParamInterface $param$paramValue$strict$default)
  113.     {
  114.         $this->checkNotIncompatibleParams($param);
  115.         if (null !== $default && $default === $paramValue) {
  116.             return $paramValue;
  117.         }
  118.         if (null === $this->validator) {
  119.             throw new \RuntimeException('The ParamFetcher requirements feature requires the symfony/validator component.');
  120.         }
  121.         $constraints $param->getConstraints();
  122.         $this->resolveConstraints($constraints);
  123.         if (empty($constraints)) {
  124.             return $paramValue;
  125.         }
  126.         try {
  127.             $errors $this->validator->validate($paramValue$constraints);
  128.         } catch (ValidatorException $e) {
  129.             $violation = new ConstraintViolation(
  130.                 $e->getMessage(),
  131.                 $e->getMessage(),
  132.                 array(),
  133.                 $paramValue,
  134.                 '',
  135.                 null,
  136.                 null,
  137.                 $e->getCode()
  138.             );
  139.             $errors = new ConstraintViolationList(array($violation));
  140.         }
  141.         if (count($errors)) {
  142.             if ($strict) {
  143.                 throw InvalidParameterException::withViolations($param$errors);
  144.             }
  145.             return null === $default '' $default;
  146.         }
  147.         return $paramValue;
  148.     }
  149.     /**
  150.      * {@inheritdoc}
  151.      */
  152.     public function all($strict null)
  153.     {
  154.         $configuredParams $this->getParams();
  155.         $params = [];
  156.         foreach ($configuredParams as $name => $param) {
  157.             $params[$name] = $this->get($name$strict);
  158.         }
  159.         return $params;
  160.     }
  161.     /**
  162.      * Check if current param is not in conflict with other parameters
  163.      * according to the "incompatibles" field.
  164.      *
  165.      * @param ParamInterface $param the configuration for the param fetcher
  166.      *
  167.      * @throws InvalidArgumentException
  168.      * @throws BadRequestHttpException
  169.      *
  170.      * @internal
  171.      */
  172.     protected function checkNotIncompatibleParams(ParamInterface $param)
  173.     {
  174.         if (null === $param->getValue($this->getRequest(), null)) {
  175.             return;
  176.         }
  177.         $params $this->getParams();
  178.         foreach ($param->getIncompatibilities() as $incompatibleParamName) {
  179.             if (!array_key_exists($incompatibleParamName$params)) {
  180.                 throw new \InvalidArgumentException(sprintf("No @ParamInterface configuration for parameter '%s'."$incompatibleParamName));
  181.             }
  182.             $incompatibleParam $params[$incompatibleParamName];
  183.             if (null !== $incompatibleParam->getValue($this->getRequest(), null)) {
  184.                 $exceptionMessage sprintf(
  185.                     "'%s' param is incompatible with %s param.",
  186.                     $param->getName(),
  187.                     $incompatibleParam->getName()
  188.                 );
  189.                 throw new BadRequestHttpException($exceptionMessage);
  190.             }
  191.         }
  192.     }
  193.     /**
  194.      * @param Constraint[] $constraints
  195.      */
  196.     private function resolveConstraints(array $constraints)
  197.     {
  198.         foreach ($constraints as $constraint) {
  199.             if ($constraint instanceof ResolvableConstraintInterface) {
  200.                 $constraint->resolve($this->container);
  201.             }
  202.         }
  203.     }
  204.     /**
  205.      * @throws \RuntimeException
  206.      *
  207.      * @return Request
  208.      */
  209.     private function getRequest()
  210.     {
  211.         $request $this->requestStack->getCurrentRequest();
  212.         if (null === $request) {
  213.             throw new \RuntimeException('There is no current request.');
  214.         }
  215.         return $request;
  216.     }
  217. }