vendor/symfony/http-foundation/InputBag.php line 38

Open in your IDE?
  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 Symfony\Component\HttpFoundation;
  14. use Symfony\Component\HttpFoundation\Exception\BadRequestException;
  15. use Symfony\Component\HttpFoundation\Exception\UnexpectedValueException;
  17. /**
  18.  * InputBag is a container for user input values such as $_GET, $_POST, $_REQUEST, and $_COOKIE.
  19.  *
  20.  * @author Saif Eddin Gmati <azjezz@protonmail.com>
  21.  */
  22. final class InputBag extends ParameterBag
  23. {
  24.     /**
  25.      * Returns a scalar input value by name.
  26.      *
  27.      * @param string|int|float|bool|null $default The default value if the input key does not exist
  28.      */
  29.     public function get(string $key, mixed $default = null): string|int|float|bool|null
  30.     {
  31.         if (null !== $default && !\is_scalar($default) && !$default instanceof \Stringable) {
  32.             throw new \InvalidArgumentException(\sprintf('Expected a scalar value as a 2nd argument to "%s()", "%s" given.', __METHOD__, get_debug_type($default)));
  33.         }
  35.         $value = parent::get($key, $this);
  37.         if (null !== $value && $this !== $value && !\is_scalar($value) && !$value instanceof \Stringable) {
  38.             throw new BadRequestException(\sprintf('Input value "%s" contains a non-scalar value.', $key));
  39.         }
  41.         return $this === $value ? $default : $value;
  42.     }
  44.     /**
  45.      * Replaces the current input values by a new set.
  46.      */
  47.     public function replace(array $inputs = []): void
  48.     {
  49.         $this->parameters = [];
  50.         $this->add($inputs);
  51.     }
  53.     /**
  54.      * Adds input values.
  55.      */
  56.     public function add(array $inputs = []): void
  57.     {
  58.         foreach ($inputs as $input => $value) {
  59.             $this->set($input, $value);
  60.         }
  61.     }
  63.     /**
  64.      * Sets an input by name.
  65.      *
  66.      * @param string|int|float|bool|array|null $value
  67.      */
  68.     public function set(string $key, mixed $value): void
  69.     {
  70.         if (null !== $value && !\is_scalar($value) && !\is_array($value) && !$value instanceof \Stringable) {
  71.             throw new \InvalidArgumentException(\sprintf('Expected a scalar, or an array as a 2nd argument to "%s()", "%s" given.', __METHOD__, get_debug_type($value)));
  72.         }
  74.         $this->parameters[$key] = $value;
  75.     }
  77.     /**
  78.      * Returns the parameter value converted to an enum.
  79.      *
  80.      * @template T of \BackedEnum
  81.      *
  82.      * @param class-string<T> $class
  83.      * @param ?T              $default
  84.      *
  85.      * @return ?T
  86.      */
  87.     public function getEnum(string $key, string $class, ?\BackedEnum $default = null): ?\BackedEnum
  88.     {
  89.         try {
  90.             return parent::getEnum($key, $class, $default);
  91.         } catch (UnexpectedValueException $e) {
  92.             throw new BadRequestException($e->getMessage(), $e->getCode(), $e);
  93.         }
  94.     }
  96.     /**
  97.      * Returns the parameter value converted to string.
  98.      */
  99.     public function getString(string $key, string $default = ''): string
  100.     {
  101.         // Shortcuts the parent method because the validation on scalar is already done in get().
  102.         return (string) $this->get($key, $default);
  103.     }
  105.     public function filter(string $key, mixed $default = null, int $filter = \FILTER_DEFAULT, mixed $options = []): mixed
  106.     {
  107.         $value = $this->has($key) ? $this->all()[$key] : $default;
  109.         // Always turn $options into an array - this allows filter_var option shortcuts.
  110.         if (!\is_array($options) && $options) {
  111.             $options = ['flags' => $options];
  112.         }
  114.         if (\is_array($value) && !(($options['flags'] ?? 0) & (\FILTER_REQUIRE_ARRAY | \FILTER_FORCE_ARRAY))) {
  115.             throw new BadRequestException(\sprintf('Input value "%s" contains an array, but "FILTER_REQUIRE_ARRAY" or "FILTER_FORCE_ARRAY" flags were not set.', $key));
  116.         }
  118.         if ((\FILTER_CALLBACK & $filter) && !(($options['options'] ?? null) instanceof \Closure)) {
  119.             throw new \InvalidArgumentException(\sprintf('A Closure must be passed to "%s()" when FILTER_CALLBACK is used, "%s" given.', __METHOD__, get_debug_type($options['options'] ?? null)));
  120.         }
  122.         $options['flags'] ??= 0;
  123.         $nullOnFailure = $options['flags'] & \FILTER_NULL_ON_FAILURE;
  124.         $options['flags'] |= \FILTER_NULL_ON_FAILURE;
  126.         $value = filter_var($value, $filter, $options);
  128.         if (null !== $value || $nullOnFailure) {
  129.             return $value;
  130.         }
  132.         $method = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS | \DEBUG_BACKTRACE_PROVIDE_OBJECT, 2)[1];
  133.         $method = ($method['object'] ?? null) === $this ? $method['function'] : 'filter';
  134.         $hint = 'filter' === $method ? 'pass' : 'use method "filter()" with';
  136.         trigger_deprecation('symfony/http-foundation', '6.3', 'Ignoring invalid values when using "%s::%s(\'%s\')" is deprecated and will throw a "%s" in 7.0; '.$hint.' flag "FILTER_NULL_ON_FAILURE" to keep ignoring them.', $this::class, $method, $key, BadRequestException::class);
  138.         return false;
  139.     }
  140. }