-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
[Routing] Add possibility to create a request context with parameters directly #60120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Routing] Add possibility to create a request context with parameters directly #60120
Conversation
| $this->setHttpsPort($httpsPort); | ||
| $this->setPathInfo($path); | ||
| $this->setQueryString($queryString); | ||
| $this->setParameters([...$this->parameters, ...$parameters]); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The class is not final, so we merge it with eventually parent set parameters.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
which parent set parameters are you talking about ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A class not final like RequestContext can be extends and call inside it constructor before the parent construct the setter methods:
class MyCustomContext extends RequestContext {
public function __construct()
{
$this->setParameters(['key' => 'value']);
parent::__construct();
}
}See also new added test. Doing just setParameters($parameters); would override existing parameters of that class.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we could also create a deprecation if (count($this->parameters) > 0) { and simplify this in Symfony 8?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One other question is maybe what is expected behaviour for:
$this->setParameters(['key' => 'value']);
parent::__construct(parameters: ['other' => 'test']);If not merged we could go for bc layer with:
if (count($parameters) > 0) {
$this->setParameters($parameters);
} elseif (count($this->parameters) > 0) {
trigger_deprecation('symfony/routing', '7.3', 'Set parameters directly via the own constructor argument');
}which in 8.0 gets:
$this->setParameters($parameters);| $this->assertEquals(['foo' => 'bar'], $requestContext->getParameters()); | ||
| } | ||
|
|
||
| public function testConstructParametersBcLayer() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure what this test case is about
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
its about why the if is needed for BC reasons.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This lines. As the require for the bc case in this tests, other tests wouldn't catch that.
+ if ($parameters) {
$this->parameters = $parameters;
+ }First I wanted to trigger deprecation so we could just remove it with 8.0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nicolas-grekas or should we think of that nobody did call setParameters before calling __construct then we can remove the if and this test completely.
25f7f5f to
32a29d8
Compare
nicolas-grekas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with minor CS changes
|
Oh, as usual: don't forget the changelog file |
9117f2f to
a3d3cb5
Compare
|
Thank you @alexander-schranz. |
While I worked on the route integration into Sulu. I had to write a few tests for depending on the RequestContext. To improve the DX I think the parameters should be possible also inside the construct directly so instead of:
I can do: