$request->query->get() can return array, but PHPDoc doesn't include array #42478

ThomasTr · 2021-08-11T11:39:20Z

Symfony version(s) affected: 5.3.6

Description
According to the documentation here:
https://symfony.com/doc/current/components/http_foundation.html#accessing-request-data

// the query string is '?foo[bar]=baz'

$request->query->get('foo');
// returns ['bar' => 'baz']

$request->query->get() can return arrays, but PHPDoc in InputBag for method get() says

@return string|int|float|bool|null

Possible Solution
In my assumption it should be save to add array to the return annotation?
If so, I'm happy to prepare a pull request.

The text was updated successfully, but these errors were encountered:

wouterj · 2021-08-11T11:48:08Z

Hi! It seems like the docs are wrong here. In Symfony 5.1, the InputBag was introduced to avoid having the array return type: #34363 (as that makes it quite easy to break applications by adding [] to the URL).

Are you willing to submit a fix for the docs? :)

ThomasTr · 2021-08-11T12:07:44Z

Ah ok, thanks for the hint. Will head over to the docs :)

ThomasTr added the Bug label Aug 11, 2021

carsonbot added the Status: Needs Review label Aug 11, 2021

wouterj closed this as completed Aug 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

$request->query->get() can return array, but PHPDoc doesn't include array #42478

$request->query->get() can return array, but PHPDoc doesn't include array #42478

$request->query->get() can return array, but PHPDoc doesn't include array #42478

$request->query->get() can return array, but PHPDoc doesn't include array #42478

Comments