[DI] Allow to choose an index for tagged collection #29598

deguif · 2018-12-13T16:57:35Z

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

Add a way to specify an index based on a tag attribute when injecting a tag collection into services, but also a a way to fallback to a static method on the service class.

!tagged {name: 'tag_name', index_by: 'tag_attribute_name', default_index_method: 'static_method'}

Tasks

Support PHP loader
Support YAML loader
Support XML loader (update XSD)
Add tests

nicolas-grekas

really nice :) This will work for iterators. The next step would be to make it work for locators also, using eg:
!service_locator !tagged {name: foo, index_by: bar}

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

nicolas-grekas · 2018-12-14T08:07:04Z

src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php

+                if (\is_string($argument) && $argument) {
+                    return new TaggedIteratorArgument($argument);
+                } elseif (\is_array($argument) && isset($argument['name']) && $argument['name']) {
+                    return new TaggedIteratorArgument($argument['name'], $argument['index_by'] ?? null, $argument['default_index_method'] ?? null);


to ease spotting typos, we should validate that there are no extra keys

nicolas-grekas · 2018-12-14T08:10:27Z

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

+                continue;
+            }
+
+            if (null === $defaultIndexMethod) {


when no $defaultIndexMethod is provided, we should imho derivate a conventional one from the attribute name.
My suggestion would be to camel-case the attribute name "foo_bar" and build something like "getDefaultFooBarName":
$defaultIndexMethod = 'getDefault'.str_replace(' ', '', ucwords(preg_replace('/[^a-zA-Z0-9\x7f-\xff]++/', ' ', $indexAttribute))).'Name';

I see the interest in the default method fallback.
But how can be handled the fact that sometime I don't want to fallback on a method and always require a tag attribute to be defined, should I pass an empty string eg. '' to handle this case?

For example: !tagged {name: 'tag_name', index_by: 'tag_attribute', default_index_method: ''}

I'm not sure this use case exists. Why would a tagged iterator care? That's not its job to me.

Ok what you mean, is that there should always be a fallback method, and this fallback method is by default auto generated from the above strategy.
What I can do is only override this default by providing one explicitly?

correct - in case the convention doesn't suit you

Behaviour is now updated

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

ro0NL · 2018-12-14T17:03:22Z

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

    {
        $services = array();

+        if (null === $indexAttribute && null !== $defaultIndexMethod) {


is this really required? i might want to "key by method" as a default approach

It is: one must have a way to configure the key they want using configuration. The command example is again enlightening: it must be possible to ignore the default command name and let configuration take over the real command name. Same here.

i figured :)

ro0NL · 2018-12-14T17:07:40Z

alternatively

!tagged
  name: tag_name,
  index_by: null | attribute_or_method_name
  is_method: true | false

if index_by is null we follow the convention mentioned above to find a default method (is_method=true).

nicolas-grekas · 2018-12-14T17:10:00Z

@ro0NL nope, really, see above comment.

ro0NL · 2018-12-14T17:27:26Z

Wait, got ya ... an alias attribute locally overrides Class::getAliasName() 👍

kunicmarko20 · 2019-01-29T17:40:42Z

This is exactly what I am looking for, is it possible to have some kind of fallback and use class name for index_by?

nicolas-grekas · 2019-01-29T17:44:23Z

@kunicmarko20 the fallback exists: create

public static function getDefaultMyThingName()
{
    return static::class;
}

the static method covers all use cases and reduces complexity, no need for anything else IMHO.

kunicmarko20 · 2019-01-29T17:47:19Z

It isn't really a fallback if I have to create a method and return the class name, but at least better than me creating compiler pass all the time, thank you! great addition!

nicolas-grekas · 2019-02-15T13:33:07Z

Continued in #30257, thanks @deguif !

…ged collection (deguif, XuruDragon) This PR was merged into the 4.3-dev branch. Discussion ---------- [DependencyInjection] Allow to choose an index for tagged collection | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #29203 | License | MIT | Doc PR | symfony/symfony-docs#11009 This is the continuity of the PR #29598 Add a way to specify an index based on a tag attribute when injecting a tag collection into services, but also a a way to fallback to a static method on the service class. ```yaml services: foo_service: class: Foo tags: - foo foo_service_tagged: class: Bar arguments: - !tagged tag: 'foo' index_by: 'tag_attribute_name' default_index_method: 'static_method' ``` ```xml <?xml version="1.0" ?> <container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"> <services> <service id="foo" class="Foo"> <tag name="foo_tag" /> </service> <service id="foo_tagged_iterator" class="Bar" public="true"> <argument type="tagged" tag="foo_tag" index-by="tag_attribute_name" default-index-method="static_method" /> </service> </services> </container> ``` Tasks * [x] Support PHP loader/dumper * [x] Support YAML loader/dumper * [x] Support XML loader/dumper (and update XSD too) * [x] Add tests * [x] Documentation Commits ------- 101bfd7 [DI] change name to tag + add XMl support + adding yaml/xml tests 845d3a6 Allow to choose an index for tagged collection

carsonbot added Status: Needs Review Feature labels Dec 13, 2018

nicolas-grekas added this to the next milestone Dec 14, 2018

nicolas-grekas reviewed Dec 14, 2018

View reviewed changes

nicolas-grekas mentioned this pull request Dec 14, 2018

[RFC] Simplify wiring of service locators #29203

Closed

nicolas-grekas changed the title ~~Allow to choose an index for tagged collection~~ [DI] Allow to choose an index for tagged collection Dec 14, 2018

nicolas-grekas added the DependencyInjection label Dec 14, 2018

deguif force-pushed the custom-indexable-tagged-iterator branch from a2041eb to b750077 Compare December 14, 2018 16:24

ro0NL reviewed Dec 14, 2018

View reviewed changes

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php Show resolved Hide resolved

ro0NL reviewed Dec 14, 2018

View reviewed changes

deguif force-pushed the custom-indexable-tagged-iterator branch from b750077 to 1b5b1f8 Compare December 14, 2018 17:35

deguif force-pushed the custom-indexable-tagged-iterator branch 2 times, most recently from 5006043 to f40903e Compare January 18, 2019 11:18

deguif force-pushed the custom-indexable-tagged-iterator branch from f40903e to 2b54bec Compare February 8, 2019 14:22

Allow to choose an index for tagged collection

17d9fae

deguif force-pushed the custom-indexable-tagged-iterator branch from 2b54bec to 17d9fae Compare February 8, 2019 14:24

gpenverne approved these changes Feb 8, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Feb 8, 2019

XuruDragon mentioned this pull request Feb 15, 2019

[DependencyInjection] Allow to choose an index for tagged collection #30257

Merged

5 tasks

nicolas-grekas closed this Feb 15, 2019

nicolas-grekas removed this from the next milestone Apr 30, 2019

nicolas-grekas added this to the 4.3 milestone Apr 30, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DI] Allow to choose an index for tagged collection #29598

[DI] Allow to choose an index for tagged collection #29598

deguif commented Dec 13, 2018

nicolas-grekas left a comment

nicolas-grekas Dec 14, 2018

deguif Feb 8, 2019

nicolas-grekas Dec 14, 2018

deguif Dec 14, 2018 •

edited

Loading

nicolas-grekas Dec 14, 2018

deguif Dec 14, 2018

nicolas-grekas Dec 14, 2018 •

edited

Loading

deguif Dec 14, 2018

ro0NL Dec 14, 2018

nicolas-grekas Dec 14, 2018

ro0NL Dec 14, 2018

ro0NL commented Dec 14, 2018

nicolas-grekas commented Dec 14, 2018

ro0NL commented Dec 14, 2018

kunicmarko20 commented Jan 29, 2019

nicolas-grekas commented Jan 29, 2019

kunicmarko20 commented Jan 29, 2019

nicolas-grekas commented Feb 15, 2019

[DI] Allow to choose an index for tagged collection #29598

[DI] Allow to choose an index for tagged collection #29598

Conversation

deguif commented Dec 13, 2018

nicolas-grekas left a 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

deguif Dec 14, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas Dec 14, 2018 • 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 commented Dec 14, 2018

nicolas-grekas commented Dec 14, 2018

ro0NL commented Dec 14, 2018

kunicmarko20 commented Jan 29, 2019

nicolas-grekas commented Jan 29, 2019

kunicmarko20 commented Jan 29, 2019

nicolas-grekas commented Feb 15, 2019

deguif Dec 14, 2018 •

edited

Loading

nicolas-grekas Dec 14, 2018 •

edited

Loading