Chapters

20 Chapters | 2:21:06 |

01

Bootstrapping the Bundle & Autoloading

7:21
02

Auto-Adding Services

6:50
03

Autowiring & Public/Private Services

4:28
04

All about the Bundle Extension Config System

5:17
05

Custom Extension Alias

4:04
06

Bundle Configuration Class

8:09
07

Allowing Entire Services to be Overridden

6:50
08

Extensibility with Interfaces & Aliases

5:33
09

Proper Bundle composer.json File

5:44
10

Testing the Bundle

7:41
11

Service Integration Test

7:22
12

Complex Config Test

9:21
13

Adding Routes & Controllers

8:52
14

Controller Functional Test

9:14
15

Dispatching Custom Events

5:51
16

Event Constants & @Event Docs

5:25
17

Plugin System with Tags

5:37
18

Tags, Compiler Passes & Other Nerdery

9:07
19

Publishing to Packagist

8:14
20

CI with Travis CI

10:05

This tutorial has a new version, check it out!

> Symfony 5 > Creating a Reusable (& Amazing) Symfony Bundle

Buy Access to Course

17.

Plugin System with Tags

|

Autoplay

Keep on Learning!

If you liked what you've learned so far, dive in! Subscribe to get
access to this tutorial plus video, code and script downloads.

Start your All-Access Pass

Buy just this tutorial for $8.00

Previous Chapter

Next Chapter

With a Subscription, click any sentence in the script to jump to that part of the video!

Login Subscribe

Login or register to check out the script

8 Comments

Sort By

Login or Register to join the conversation

Boolean T. 5 years ago edited

Hi! I'm using Symfony 5.2.
I have a notice about "The Easy Way" (<argument type="tagged" tag="knpu_ipsum_word_provider" />). I had the following configuration in KnpULoremIpsumExtension::load():


...
if (null !== $config['word_provider']) {
    $container->setAlias('knpu_lorem_ipsum.word_provider', $config['word_provider']);
}

And the following configuration in "services.xml":


        ...
        <service id="knpu_lorem_ipsum.knpu_ipsum" class="KnpU\LoremIpsumBundle\KnpUIpsum" public="true">
            <argument type="tagged_iterator" tag="knpu_ipsum_word_provider" /> <!-- filled in via a compiler pass -->
            <argument /> <!-- unicorns_are_real -->
            <argument /> <!-- min_sunshine -->
        </service>
        <service id="KnpU\LoremIpsumBundle\KnpUIpsum" alias="knpu_lorem_ipsum.knpu_ipsum" public="false" />
        
        <service id="knpu_lorem_ipsum.knpu_word_provider" class="KnpU\LoremIpsumBundle\KnpUWordProvider">
            <tag name="knpu_ipsum_word_provider" />
        </service>
        <service id="knpu_lorem_ipsum.word_provider" alias="knpu_lorem_ipsum.knpu_word_provider" public="false" />

Words from CustomWordProvider weren't present on page. So, I still should or add tag definition for provider in "services.yaml" in my main app:


App\Service\CustomWordProvider:
        tags: ['knpu_ipsum_word_provider']

... either set tag in KnpULoremIpsumExtension::load():


$container
        ->registerForAutoconfiguration(WordProviderInterface::class)
        ->addTag('knpu_ipsum_word_provider')
;

Maybe, I've done something wrong, but only explicit tag definition for App\Service\CustomWordProvider worked for me (<i>in case of "easy way"</i>).

|

weaverryan SFCASTS Boolean T. 5 years ago edited

Hey @Boolean_Type!

Hmm, let's see. So first, as you know, one way or another we must to add the knpu_ipsum_word_provider tag to the CustomWordProvider service. But, there are two ways to do this... and you listed both of them :). Either you can add the tag directly, or you can register the interface it implements for autoconfiguration. How you add the tag doesn't matter - it will work the same both ways. We actually do the registerForAutoconfiguration() thing - we do it in the next chapter: https://symfonycasts.com/screencast/symfony-bundle/tags-compiler-pass#codeblock-1ed6575410

Cheers!

1 |

erop 6 years ago

Hi!
Am I correct saying that autoconfiguring tags does not work for bundle services since there's a comment in code snippet at the given link like

# this config only applies to the services created by this file

? In my application I have an interface with auto-configured tag in services.yaml. And my bundle service implementing that interface does not have a tag on it until I explicitly add the tag to bundle's services.xml.

|

weaverryan SFCASTS erop 6 years ago edited

Hey erop!

That's 100% correct! The reason is that the instanceof stuff (just like the defaults) stuff applies to only the current file that this code appears in. This was done on purpose: it's a powerful way to make your life easier, but if it affected your entire application, crazy things would happen :). You could add an instanceof in a bundle that you're creating. But typically, as a best practice, bundle should explicitly require everything: the "shortcuts" are meant to help application developers more than developers of re-usable code.

Cheers!

1 |

erop weaverryan 6 years ago

Thank you, Ryan!

|

Laurens M. 6 years ago

Is it possible that now this argument is not an array but an object of type RewindableGenerator?
<argument type="tagged" tag="knpu_ipsum_word_provider"/>

That's what I get when I dump $wordProviders in the constructor of class KnpUIpsum. :-/

It does work when you remove the typehint "array $wordProviders"

|

weaverryan SFCASTS Laurens M. 6 years ago edited

Hey Laurens M.!

Hmm. I can't find a change in Symfony that would specifically cause this. However, from checking the code, it looks like this has always been the case - even the original blog post about this feature shows using the iterable type-hint, not array: https://symfony.com/blog/new-in-symfony-3-4-simpler-injection-of-tagged-services

So, we'll add a note about that! When I created this, I was thinking that you could simply use the tagged argument type and make no other changes to your code. But, it looks like the array type-hint does need to change to iterable.

Thanks for bringing this up!

|

Laurens M. weaverryan 6 years ago

Thanks Ryan, iterable as typehint indeed works like a charm. I appreciate the quick and clear response, all the bests!

|

This tutorial is built using Symfony 4, but most of the concepts apply fine to Symfony 5!

Symfony 4

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": "^7.1.3",
        "ext-iconv": "*",
        "doctrine/annotations": "^1.8", // v1.8.0
        "knplabs/knp-markdown-bundle": "^1.7", // 1.7.0
        "knpuniversity/lorem-ipsum-bundle": "*@dev", // dev-master
        "nexylan/slack-bundle": "^2.0,<2.2", // v2.0.1
        "php-http/guzzle6-adapter": "^1.1", // v1.1.1
        "sensio/framework-extra-bundle": "^5.1", // v5.1.6
        "symfony/asset": "^4.0", // v4.0.6
        "symfony/console": "^4.0", // v4.0.6
        "symfony/flex": "^1.0", // v1.21.6
        "symfony/framework-bundle": "^4.0", // v4.0.6
        "symfony/lts": "^4@dev", // dev-master
        "symfony/twig-bundle": "^4.0", // v4.0.6
        "symfony/web-server-bundle": "^4.0", // v4.0.6
        "symfony/yaml": "^4.0", // v4.0.6
        "weaverryan_test/lorem-ipsum-bundle": "^1.0" // v1.0.0
    },
    "require-dev": {
        "easycorp/easy-log-handler": "^1.0.2", // v1.0.4
        "sensiolabs/security-checker": "^4.1", // v4.1.8
        "symfony/debug-bundle": "^3.3|^4.0", // v4.0.6
        "symfony/dotenv": "^4.0", // v4.0.6
        "symfony/maker-bundle": "^1.0", // v1.1.1
        "symfony/monolog-bundle": "^3.0", // v3.2.0
        "symfony/phpunit-bridge": "^3.3|^4.0", // v4.3.3
        "symfony/stopwatch": "^3.3|^4.0", // v4.0.6
        "symfony/var-dumper": "^3.3|^4.0", // v4.0.6
        "symfony/web-profiler-bundle": "^3.3|^4.0" // v4.0.6
    }
}

Previous Chapter

Next Chapter