[Routing] Allow query-specific parameters in UrlGenerator using _query
#60508
Conversation
_query_query
_queryUrlGenerator using _query
|
If someone is using |
I agree, unless it is considered that names starting with an underscore are reserved for Symfony, and not covered by the BC promise; I don't know about this, but there's a precedent here with |
|
The difference is that A better example might be to look at how we handled |
|
@stof Good point. The BC break concern was raised by @Koc back then, but was dismissed by @Tobion:
I'll leave it up to you to decide whether introducing another one in a minor release is still acceptable in 2025; maybe this is something that could be documented in Our Backward Compatibility Promise? |
| @@ -142,6 +142,17 @@ public function generate(string $name, array $parameters = [], int $referenceTyp | |||
| */ | |||
| protected function doGenerate(array $variables, array $defaults, array $requirements, array $tokens, array $parameters, string $name, int $referenceType, array $hostTokens, array $requiredSchemes = []): string | |||
| { | |||
| if (isset($parameters['_query'])) { | |||
| if (!is_array($parameters['_query'])) { | |||
There was a problem hiding this comment.
About the potential BC break: Right now one could use a parameter named _query perfectly fine. But... if I don't miss anything it must be a scalar value, right? If I am not mistaken, what about only treating _query with its special meaning for URL parameters when it is an array (at least for a transition period where we could trigger a deprecation)?
There was a problem hiding this comment.
The idea is nice, but I'm afraid arrays are accepted just fine right now. We could still lower the scope of the potential BC break by letting '_query' => scalar go through, although I'm not sure if this would make the whole thing even more confusing.
There was a problem hiding this comment.
What's happening right now without your changes when an array is passed?
There was a problem hiding this comment.
It's a an array in the query parameter then, no?
There was a problem hiding this comment.
Yes, it behaves just like http_build_query() does with arrays: ?foo[x]=y (spared you the percent encoding).
This PR adds support for a special
_querykey in$parametersofUrlGenerator::generate(), that is used exclusively to generate query parameters. This is useful when query parameters may conflict with route parameters of the same name.Concrete use case:
My application has a route that looks like:
And I want to generate this URL:
With this PR, I can now call: