diogo
/
symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bug #31219 [HttpClient] Allow arrays as query parameters (sleepyboy) 

This PR was submitted for the master branch but it was merged into the 4.3 branch instead (closes #31219).

Discussion
----------

[HttpClient] Allow arrays as query parameters

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | N/A

This PR allows passing arrays as query parameters.

For instance, if I pass $options['query']['category'] = ['news', 'sport', 'culture'] to my GET request, I expect this to be transformed to URL?category[]=news&category[]=sport&category[]=culture.

I added two tests to cover this functionality. I also fixed one of the tests where "+" wasn't encoded as %20 in the final URL.

Commits
-------

1cbefd7fca [HttpClient] Allow arrays as query parameters
This commit is contained in:
Nicolas Grekas 2019-05-21 18:51:52 +02:00
parent aedd52eab7 1cbefd7fca
commit 7f43878d9c
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/Symfony/Component/HttpClient/HttpClientTrait.php
View File

@ -481,17 +481,20 @@ trait HttpClientTrait
}
}
foreach ($queryArray as $k => $v) {
if (is_scalar($v)) {
$queryArray[$k] = rawurlencode($k).'='.rawurlencode($v);
} elseif (null === $v) {
unset($queryArray[$k]);
if ($replace) {
if ($replace) {
foreach ($queryArray as $k => $v) {
if (null === $v) {
unset($query[$k]);
}
} else {
throw new InvalidArgumentException(sprintf('Unsupported value for query parameter "%s": scalar or null expected, %s given.', $k, \gettype($v)));
}
}
$queryString = http_build_query($queryArray, '', '&', PHP_QUERY_RFC3986);
$queryArray = [];
if ($queryString) {
foreach (explode('&', $queryString) as $v) {
$queryArray[rawurldecode(explode('=', $v, 2)[0])] = $v;
}
}

4
src/Symfony/Component/HttpClient/Tests/HttpClientTraitTest.php
View File

@ -141,6 +141,10 @@ class HttpClientTraitTest extends TestCase
yield [[null, null, 'bar', '?a=1&c=c', null], 'bar?a=a&b=b', ['b' => null, 'c' => 'c', 'a' => 1]];
yield [[null, null, 'bar', '?a=b+c&b=b', null], 'bar?a=b+c', ['b' => 'b']];
yield [[null, null, 'bar', '?a=b%2B%20c', null], 'bar?a=b+c', ['a' => 'b+ c']];
yield [[null, null, 'bar', '?a%5Bb%5D=c', null], 'bar', ['a' => ['b' => 'c']]];
yield [[null, null, 'bar', '?a%5Bb%5Bc%5D=d', null], 'bar?a[b[c]=d', []];
yield [[null, null, 'bar', '?a%5Bb%5D%5Bc%5D=dd', null], 'bar?a[b][c]=d&e[f]=g', ['a' => ['b' => ['c' => 'dd']], 'e[f]' => null]];
yield [[null, null, 'bar', '?a=b&a%5Bb%20c%5D=d&e%3Df=%E2%9C%93', null], 'bar?a=b', ['a' => ['b c' => 'd'], 'e=f' => '✓']];
}
/**