Skip to content

[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

Open
wants to merge 6 commits into
base: 7.3
Choose a base branch
from

Conversation

alexander-schranz
Copy link
Contributor

Q A
Branch? 7.3
Bug fix? no
New feature? yes
Deprecations? no
Issues Fix #...
License MIT

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:

$requestContext = new RequestContext();
$requestContext->setParameters(['foo' => 'bar']);
$service->myMethod($requestContext);

I can do:

$service->myMethod(new RequestContext(parameters: ['foo' => 'bar']));

@@ -43,6 +43,7 @@ public function __construct(string $baseUrl = '', string $method = 'GET', string
$this->setHttpsPort($httpsPort);
$this->setPathInfo($path);
$this->setQueryString($queryString);
$this->setParameters([...$this->parameters, ...$parameters]);
Copy link
Contributor Author

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.

Copy link
Member

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 ?

Copy link
Contributor Author

@alexander-schranz alexander-schranz Apr 2, 2025

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.

Copy link
Contributor Author

@alexander-schranz alexander-schranz Apr 2, 2025

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?

Copy link
Contributor Author

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);

@carsonbot carsonbot changed the title Add possibility to create a request context with parameters directly [Routing] Add possibility to create a request context with parameters directly Apr 2, 2025
$this->assertEquals(['foo' => 'bar'], $requestContext->getParameters());
}

public function testConstructParametersBcLayer()
Copy link
Member

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

Copy link
Contributor Author

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.

alexander-schranz and others added 2 commits April 30, 2025 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants