[HttpFoundation] Allow query params to be formated with a preservered order #26202
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ecdd581 to
42abf6b
Compare
dunglas
approved these changes
Feb 17, 2018
| * | ||
| * @return string A normalized query string for the Request | ||
| */ | ||
| public static function normalizeQueryString($qs) | ||
| public static function normalizeQueryString($qs, $preserveOrder = false) |
There was a problem hiding this comment.
Can be bool $preserveOrder = false
|
For the rationale behind this PR, see api-platform/core#1710. |
42abf6b to
56d9613
Compare
nicolas-grekas
requested changes
Feb 17, 2018
| * | ||
| * @return string A normalized query string for the Request | ||
| */ | ||
| public static function normalizeQueryString($qs) | ||
| public static function normalizeQueryString($qs, bool $preserveOrder = false) |
There was a problem hiding this comment.
Adding a new argument is a BC break, isn't it?
This needs a BC layer.
There was a problem hiding this comment.
Totally right, I'll work on this sorry.
|
Actually, shouldn't this be the default? it looks like a bug to me, the order matters for keyed arrays |
|
@nicolas-grekas Well let me know, it also feels buggy to me but it actually exactly do what it says in the description (order alphabetically). I can update the PR and even target a lower branch if it is considered as a bug fix. If not, what would be the best way of adding a BC layer:
|
|
See #26214 for my proposal on 2.7 :) |
|
Ok then |
fabpot
added a commit
that referenced
this pull request
Mar 23, 2018
…malization (nicolas-grekas) This PR was merged into the 4.1-dev branch. Discussion ---------- [HttpFoundation] Use parse_str() for query strings normalization | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Follow up of #26214 and #26202 The current normalization logic is both too loose and too broad: it changes the order of recursive data structures, while not normalizing keys. Since the normalization logic varies by query string parser, I'd like to propose a logic that exactly matches the native PHP one, which is exposed to userland via `parse_str()`. Using this, we accurately remove all useless information, while preserving all the meaningful one. (The change in `overrideGlobals()` is a bug fix to me btw, the current logic breaks the interpretation of legitimate query strings.) Commits ------- 5133536 [HttpFoundation] Use parse_str() for query strings normalization
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aimed to allow using the queryString normalization without reordering the parameters name.
It can be specifically usefull in the context of building API and parsing urls like
/foo?order[baz]=asc&order[bar]=asc. In this case, in order to apply an order condition on a query where preserving the order of the parameter matters likeORDER BY baz ASC, bar ASCfor example , it would be nice to have this possibility.