fix: Add array to return of InputBag::get

[shyim]

Q	A
Branch?	5.3
Bug fix?	yes
New feature?	no
Deprecations?	no
Tickets
License	MIT
Doc PR

The method can return array. The set method has already array typehint

[nicolas-grekas]

This is on purpose. If you want to get an array, you should use all('foo').
See the deprecation in the body of the method.

[TjorvenB]

This is quite the BC break. Is there a place where we can find the reasoning behind this? There is no explanation in the upgrade notes or the commits.
It would be a nice read while I look for all controllers where I handle array query parameters and add a custom implementation for default values, as such are no longer supported.

[MaximePinot]

This is quite the BC break. Is there a place where we can find the reasoning behind this? There is no explanation in the upgrade notes or the commits.
It would be a nice read while I look for all controllers where I handle array query parameters and add a custom implementation for default values, as such are no longer supported.

It was introduced in #34363. You will find some explanations here! ;)

[dvdknaap]

Only adding the array type will not fix it. the if statement check in the get should be the same as the set function so you should add !\is_array($value)

[stof]

@nicolas-grekas even if it is deprecated, it can still return an array in 5.3

[nicolas-grekas]

Sure, but we don't phpdocument deprecated types.

[stof]

@nicolas-grekas we will need to change that policy anyway. With native return types, we cannot remove the deprecated types from the signature, otherwise we get a TypeError

[dvdknaap]

Only adding the array type in the docblock doesn't fix anything.

This is still a bug and throws a error because it doesn't accept array while it accepts it in the set function.
vendor/symfony/http-foundation/InputBag.php:36

        if (null !== $value && $this !== $value && !is_scalar($value)) {
            throw new BadRequestException(sprintf('Input value "%s" contains a non-scalar value.', $key));
        }

It should also accept array again because a lot of websites and app are broke now like mine.

It should accept the same as in the set function

vendor/symfony/http-foundation/InputBag.php:77

        if (null !== $value && !is_scalar($value) && !\is_array($value) && !$value instanceof \Stringable) {
            throw new \InvalidArgumentException(sprintf('Excepted a scalar, or an array as a 2nd argument to "%s()", "%s" given.', __METHOD__, get_debug_type($value)));
        }

[shyim]

@dvdknaap you need to call now all instead of get when you want a array

[szepczynski]

But how to test is given key is array or scalar value.
Let's go with this example:

GET https://localhost/?q=a
GET https://localhost/?q[]=a&q[]=b

First case you can get only through $request->query->get('q');
Second case only through $request->query->all('q');

I can't see a way how to test is q parameter is scalar or array (except catching exception of course)

[alexander-schranz]

I also think this leads into some strange cases now specially when working with the FOSRestBundle which is setting the JSON Content to $request->request via the BodyListener. I would had understand if it go strict to string now as from the http specification but instead now float, int are allowed but no array feels strange.

[ddr5292]

This breaks my code guys. Bad form.

[ro0NL]

a deprecation breaks your code?

[ro0NL]

But how to test is given key is array or scalar value.

you mostly know what your application expects

getting the raw value is done using all()['key']. Please open a doc PR if it's unclear.

[christiaangoossens]

@ddr5292 And another one, also broke my code on a minor dependency update. For anyone searching for this on the internet, if you get Symfony\Component\HttpFoundation\Exception\BadRequestException: Input value $key contains a non-scalar value. in /vendor/symfony/http-foundation/InputBag.php:37 you have a controller doing $request->json()-get($key) somewhere in your code on an array. Replace it with $request->input($key) (for Laravel).

[Nerogee]

But how to test is given key is array or scalar value. Let's go with this example:

GET https://localhost/?q=a
GET https://localhost/?q[]=a&q[]=b

First case you can get only through $request->query->get('q'); Second case only through $request->query->all('q');

I can't see a way how to test is q parameter is scalar or array (except catching exception of course)

I cannot agree more with you. I use get() for all type of data. but now it all mess up. The worst thing is that I cannot see the reason why it worth even introducing a breaking change. User submitted value could be very unpredictable. Sometimes it's on purpose and allowed to input either a scalar value or an array. What we need is the flexibility in the back-end to handle it.

[wouterj]

This ship sailed long ago. As you can see, this has been discussed numerous times 2 years ago, so it's unlikely that the outcome changes now. Furthermore, both deprecation and new behavior has been part of Symfony for nearly 4 years. Changing or reverting now is impossible and will impact more applications than changing this in existing applications that are upgrading to 5.x or 6.x now.

Please also do not comment more or less the same things across multiple issues/PRs within the same topic. This divides the same discussion across multiple places, making it harder to track.

[derrabus]

I'm locking all of those issues now. If there's something NEW to discuss, please open a new issue.