[DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters as-a-service #25288

nicolas-grekas · 2017-12-03T15:06:07Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#17160
License	MIT
Doc PR	-

There is one thing that prevents us from not injecting the container: access to the parameter bag.
This PR fixes this limitation by providing a PSR-11 ContainerBagInterface + related implementation, and wiring it as a service that ppl can then also autowire using the new interface as a type hint, or ParameterBagInterface.

Needed to complete e.g. #24738

ro0NL · 2017-12-03T15:47:52Z

src/Symfony/Component/DependencyInjection/ParameterBag/ContainerBagInterface.php

+/**
+ * @author Nicolas Grekas <[email protected]>
+ */
+interface ContainerBagInterface extends ContainerInterface


should we move this one namespace up? is typehinting SF\ContainerBagInterface instead of SF\ParamaterBagInterface really worth it? What about a ContainerParameterBag implem to enable typehinting ParamaterBagInterface?

in general #24738 needs ParamaterBagInterface::resolveValue() actually

should we move this one namespace up?

that's a parameter bag, should be in the namespace to me

is typehinting SF\ContainerBagInterface instead of SF\ParamaterBagInterface really worth it?

yes: the new interface is more tailored than, the existing one, better for autosuggestion by IDEs

What about a ContainerParameterBag implem to enable typehinting ParamaterBagInterface?

isn't that already what the new ContainerBag provides?

the new interface is more tailored than, the existing one, better for autosuggestion by IDEs

Yeah but why favor ContainerBagInterface over ParamaterBagInterface from the same package/namespace? Is it to provide 2 different PSR containers? Are we "hacking" autowiring?

class ContainerParameterBag implements ParamBagInterface, PSR\ContainerInterface { }

would do?

let's say you have ContainerBagInterface $bag type-hint.
typing $bag-> the IDE will suggest you with "get", "has" and "all".
if we do what you suggest, the IDE will also suggest all the other methods inherited from ParamaterBagInterface, which, if used, will throw.

Ok. I was thinking you'd prefer ContainerInterface $bag actually, which troubles autowiring when you need $container also. So we add this interface.. for DX. That's OK i guess :-)

~~ContainerBagInterface::resolveValue would be useful?~~ never mind, you'd typehint ParamaterBagInterface then i guess.

ContainerBagInterface::resolveValue would be useful?

~~not for this PR~~
I changed my mind during the night, here it is, trivial to add :)

Wait... do the point of this interface is just for DX? 🤔

Is there anything we do in a framework that is not for DX?
Anyway, "for DX" is not a technical thing. Here is the technical outcome: the interface is to declare a contract you want to adhere to: you explicitly state that you're going to need read-only access to the bag. That's the purpose of the interface.

chalasr · 2017-12-03T16:45:05Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -110,6 +112,12 @@ public function load(array $configs, ContainerBuilder $container)
        $loader->load('services.xml');
        $loader->load('fragment_renderer.xml');

+        if (!interface_exists(ContainerBagInterface::class)) {
+            $container->removeDefinition('parameter_bag');
+            $container->removeAlias(ContainerBagInterface);


missing ::class, same below

chalasr · 2017-12-03T16:45:28Z

src/Symfony/Component/DependencyInjection/CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 -----

 * added support for variadics in named arguments
+ * added PSR-11 `ContainerBagInterface` and its `ContainerBag` implementation to access parameters as-as-service


typo as-a

Tobion · 2017-12-04T00:51:39Z

src/Symfony/Component/DependencyInjection/ParameterBag/ContainerBagInterface.php

+     *
+     * @return array An array of parameters
+     */
+    public function all();


return type declaration?

Not possible: would make the interface incompatible with ParameterBagInterface.

I'm too late but, is this true?
https://3v4l.org/NPigR

Looks like it isn't.

…as-a-service

linaori · 2017-12-04T08:57:36Z

src/Symfony/Component/DependencyInjection/ParameterBag/ContainerBag.php

+/**
+ * @author Nicolas Grekas <[email protected]>
+ */
+class ContainerBag extends FrozenParameterBag implements ContainerBagInterface


Could probably be made final, I see no reason to extend this rather than implementing the interface.

We don't make classes final "by default", that's not the framework's policy.

I think it's good idea. Could that change for new classes?
Like adding scalar type is?

ogizanagi

But this will probably lead to developers using this for use-cases for which we'll rather prone regular scalar values injection and local binding (#23718).

chalasr

👍 not fond of scalar injection :)

chalasr · 2017-12-04T09:23:54Z

Should we make AbstractController use it?

nicolas-grekas · 2017-12-04T09:32:32Z

src/Symfony/Component/DependencyInjection/Tests/ParameterBag/ContainerBagTest.php

+
+    public function setUp()
+    {
+        $this->containerBag = new ContainerBag(new Container($this->parameterBag = new ParameterBag(array(


on two lines would be more readable

Oh. I love that you are saying that, let me change this right now 😛

nicolas-grekas · 2017-12-04T09:32:58Z

src/Symfony/Component/DependencyInjection/Tests/ParameterBag/ContainerBagTest.php

+
+    public function testGetAllParameters()
+    {
+        $this->assertEquals(array(


on one line is OK here to me

nicolas-grekas · 2017-12-04T09:42:32Z

Should we make AbstractController use it?

could be, but not in this PR

nicolas-grekas · 2017-12-08T12:39:12Z

Thank you @sroze.

…ess parameters as-a-service (nicolas-grekas, sroze) This PR was merged into the 4.1-dev branch. Discussion ---------- [DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters as-a-service | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #17160 | License | MIT | Doc PR | - There is one thing that prevents us from not injecting the container: access to the parameter bag. This PR fixes this limitation by providing a PSR-11 `ContainerBagInterface` + related implementation, and wiring it as a service that ppl can then also autowire using the new interface as a type hint, or `ParameterBagInterface`. Needed to complete e.g. #24738 Commits ------- 561cd7e Add tests on the ContainerBag 0e18d3e [DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters as-a-service

nicolas-grekas · 2017-12-08T12:42:07Z

Should we make AbstractController use it?

@chalasr unlocked if you want to make it happen :)

stof · 2017-12-08T12:13:23Z

src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md

@@ -4,7 +4,8 @@ CHANGELOG
 4.1.0
 -----

- * allowed to pass an optional `LoggerInterface $logger` instance to the `Router`
+ * Allowed to pass an optional `LoggerInterface $logger` instance to the `Router`
+ * Added a new `parameter_bag` service with related autowiring aliases to acces parameters as-a-service


will fix directly

stof · 2017-12-08T12:14:32Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -110,6 +112,12 @@ public function load(array $configs, ContainerBuilder $container)
        $loader->load('services.xml');
        $loader->load('fragment_renderer.xml');

+        if (!interface_exists(ContainerBagInterface::class)) {


why not just bumping the min version of the DI component instead ? This is a hard requirement already.

because I don't want to be the one breaking the 3-cross-4 compat :)

This PR was merged into the 4.1-dev branch. Discussion ---------- Add ControllerTrait::getParameter() | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony/symfony#25288 (comment) | License | MIT | Doc PR | n/a Commits ------- 28397e5b2c Add ControllerTrait::getParameter()

This PR was merged into the 4.1-dev branch. Discussion ---------- Add ControllerTrait::getParameter() | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #25288 (comment) | License | MIT | Doc PR | n/a Commits ------- 28397e5 Add ControllerTrait::getParameter()

nicolas-grekas added this to the 4.1 milestone Dec 3, 2017

carsonbot added Status: Needs Review DependencyInjection FrameworkBundle Feature labels Dec 3, 2017

nicolas-grekas mentioned this pull request Dec 3, 2017

[FrameworkBundle][Routing] Use a PSR-11 container in FrameworkBundle Router #24738

Merged

ro0NL reviewed Dec 3, 2017

View reviewed changes

ro0NL approved these changes Dec 3, 2017

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Dec 3, 2017

chalasr reviewed Dec 3, 2017

View reviewed changes

nicolas-grekas force-pushed the di-container-bag branch 2 times, most recently from fb6e28e to c993ebb Compare December 3, 2017 17:05

Tobion reviewed Dec 4, 2017

View reviewed changes

nicolas-grekas force-pushed the di-container-bag branch from c993ebb to dbc9d7e Compare December 4, 2017 08:18

nicolas-grekas mentioned this pull request Dec 4, 2017

[DependencyInjection] Introduce a new ParameterResolver #17192

Closed

[DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters …

0e18d3e

…as-a-service

nicolas-grekas force-pushed the di-container-bag branch from dbc9d7e to 0e18d3e Compare December 4, 2017 08:42

linaori reviewed Dec 4, 2017

View reviewed changes

ogizanagi approved these changes Dec 4, 2017

View reviewed changes

chalasr approved these changes Dec 4, 2017

View reviewed changes

nicolas-grekas commented Dec 4, 2017

View reviewed changes

nicolas-grekas force-pushed the di-container-bag branch from 1408ff1 to 1a96372 Compare December 4, 2017 09:45

Add tests on the ContainerBag

561cd7e

nicolas-grekas force-pushed the di-container-bag branch from 1a96372 to 561cd7e Compare December 4, 2017 09:48

nicolas-grekas added the Ready label Dec 7, 2017

xabbuh approved these changes Dec 8, 2017

View reviewed changes

nicolas-grekas merged commit 561cd7e into symfony:master Dec 8, 2017

nicolas-grekas mentioned this pull request Dec 8, 2017

[RFC] Proposal to simplify the autowiring of container parameters #23718

Closed

nicolas-grekas deleted the di-container-bag branch December 8, 2017 12:41

stof reviewed Dec 8, 2017

View reviewed changes

nicolas-grekas mentioned this pull request Dec 9, 2017

[DI] Autowire arguments that are container parameters #21699

Closed

chalasr mentioned this pull request Dec 11, 2017

Add ControllerTrait::getParameter() #25439

Merged

acrobat mentioned this pull request Dec 17, 2017

[AdminListBundle][5.1] Deprecate direct container access in controllers Kunstmaan/KunstmaanBundlesCMS#1769

Merged

weaverryan mentioned this pull request Jan 7, 2018

New support for getting parameters via injection symfony/symfony-docs#8999

Closed

javiereguiluz mentioned this pull request Jan 8, 2018

[DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters as-a-service symfony/symfony-docs#9010

Closed

xabbuh mentioned this pull request Feb 9, 2018

allow containing 0 or similar values except null. #26095

Closed

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

deZinc mentioned this pull request May 31, 2018

[UserManagementBundle][SeoBundle] Deprecate direct container access i… Kunstmaan/KunstmaanBundlesCMS#1998

Merged

javiereguiluz mentioned this pull request Jun 26, 2018

[DependencyInjection] Create a new trait or class to resolve values with the container #17160

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters as-a-service #25288

[DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters as-a-service #25288

nicolas-grekas commented Dec 3, 2017 •

edited

Loading

ro0NL Dec 3, 2017 •

edited

Loading

nicolas-grekas Dec 3, 2017

ro0NL Dec 3, 2017

nicolas-grekas Dec 3, 2017

ro0NL Dec 3, 2017

ro0NL Dec 3, 2017 •

edited

Loading

nicolas-grekas Dec 3, 2017 •

edited

Loading

sroze Dec 4, 2017

nicolas-grekas Dec 4, 2017

chalasr Dec 3, 2017

ro0NL Dec 3, 2017

nicolas-grekas Dec 3, 2017

chalasr Dec 3, 2017

Tobion Dec 4, 2017

nicolas-grekas Dec 4, 2017

ciaranmcnulty May 31, 2018

sroze May 31, 2018

linaori Dec 4, 2017

nicolas-grekas Dec 4, 2017

TomasVotruba Dec 9, 2017 •

edited

Loading

ogizanagi left a comment

chalasr left a comment

chalasr commented Dec 4, 2017

nicolas-grekas Dec 4, 2017

sroze Dec 4, 2017

nicolas-grekas Dec 4, 2017

nicolas-grekas commented Dec 4, 2017

nicolas-grekas commented Dec 8, 2017

nicolas-grekas commented Dec 8, 2017

stof Dec 8, 2017

nicolas-grekas Dec 8, 2017

stof Dec 8, 2017

nicolas-grekas Dec 8, 2017 •

edited

Loading

[DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters as-a-service #25288

[DI][FrameworkBundle] Add PSR-11 "ContainerBag" to access parameters as-a-service #25288

Conversation

nicolas-grekas commented Dec 3, 2017 • edited Loading

ro0NL Dec 3, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL Dec 3, 2017 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas Dec 3, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomasVotruba Dec 9, 2017 • edited Loading

Choose a reason for hiding this comment

ogizanagi left a comment

Choose a reason for hiding this comment

chalasr left a comment

Choose a reason for hiding this comment

chalasr commented Dec 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Dec 4, 2017

nicolas-grekas commented Dec 8, 2017

nicolas-grekas commented Dec 8, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas Dec 8, 2017 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas commented Dec 3, 2017 •

edited

Loading

ro0NL Dec 3, 2017 •

edited

Loading

ro0NL Dec 3, 2017 •

edited

Loading

nicolas-grekas Dec 3, 2017 •

edited

Loading

TomasVotruba Dec 9, 2017 •

edited

Loading

nicolas-grekas Dec 8, 2017 •

edited

Loading