vendor/api-platform/core/src/Util/RequestParser.php line 39

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.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. declare(strict_types=1);
  14. namespace ApiPlatform\Util;
  16. use Symfony\Component\HttpFoundation\Request;
  18. /**
  19.  * Utility functions for working with Symfony's HttpFoundation request.
  20.  *
  21.  * @internal
  22.  *
  23.  * @author Teoh Han Hui <teohhanhui@gmail.com>
  24.  * @author Vincent Chalamon <vincentchalamon@gmail.com>
  25.  */
  26. final class RequestParser
  27. {
  28.     private function __construct()
  29.     {
  30.     }
  32.     /**
  33.      * Parses request parameters from the specified source.
  34.      *
  35.      * @author Rok Kralj
  36.      *
  37.      * @see https://stackoverflow.com/a/18209799/1529493
  38.      */
  39.     public static function parseRequestParams(string $source): array
  40.     {
  41.         // '[' is urlencoded ('%5B') in the input, but we must urldecode it in order
  42.         // to find it when replacing names with the regexp below.
  43.         $source = str_replace('%5B', '[', $source);
  45.         $source = preg_replace_callback(
  46.             '/(^|(?<=&))[^=[&]+/',
  47.             static fn ($key): string => bin2hex(urldecode($key[0])),
  48.             $source
  49.         );
  51.         // parse_str urldecodes both keys and values in resulting array.
  52.         parse_str($source, $params);
  54.         return array_combine(array_map('hex2bin', array_keys($params)), $params);
  55.     }
  57.     /**
  58.      * Generates the normalized query string for the Request.
  59.      *
  60.      * It builds a normalized query string, where keys/value pairs are alphabetized
  61.      * and have consistent escaping.
  62.      */
  63.     public static function getQueryString(Request $request): ?string
  64.     {
  65.         $qs = $request->server->get('QUERY_STRING', '');
  66.         if ('' === $qs) {
  67.             return null;
  68.         }
  70.         $parts = [];
  72.         foreach (explode('&', (string) $qs) as $param) {
  73.             if ('' === $param || '=' === $param[0]) {
  74.                 // Ignore useless delimiters, e.g. "x=y&".
  75.                 // Also ignore pairs with empty key, even if there was a value, e.g. "=value", as such nameless values cannot be retrieved anyway.
  76.                 // PHP also does not include them when building _GET.
  77.                 continue;
  78.             }
  80.             $keyValuePair = explode('=', $param, 2);
  82.             // GET parameters, that are submitted from a HTML form, encode spaces as "+" by default (as defined in enctype application/x-www-form-urlencoded).
  83.             // PHP also converts "+" to spaces when filling the global _GET or when using the function parse_str. This is why we use urldecode and then normalize to
  84.             // RFC 3986 with rawurlencode.
  85.             $parts[] = isset($keyValuePair[1]) ?
  86.                 rawurlencode(urldecode($keyValuePair[0])).'='.rawurlencode(urldecode($keyValuePair[1])) :
  87.                 rawurlencode(urldecode($keyValuePair[0]));
  88.         }
  90.         return implode('&', $parts);
  91.     }
  92. }