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

06.

Bundle Configuration Class

|

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

9 Comments

Sort By

Login or Register to join the conversation

Pierre 6 years ago edited

Hi,
There is a deprecation on the root node (<blockquote>@deprecated since Symfony 4.3, pass the root name to the constructor instead</blockquote>), it should be :
<br />$treeBuilder = new TreeBuilder('knpu_lorem_ipsum');<br />$rootNode = $treeBuilder->getRootNode();<br />

Thanks for this great tutorial !

Pierre

1 |

Boolean T. 5 years ago edited

Hi!
I should also change <i>"services.xml"</i> for everything to work. Namely - add 2 <argument /> for unicorns_are_real and min_sunshine respectively. Without it I got OutOfBoundsException: "Cannot replace arguments if none have been configured yet." (Symfony version - 5.2.1):


<services>
        <service id="knpu_lorem_ipsum.knpu_ipsum" class="KnpU\LoremIpsumBundle\KnpUIpsum" public="true">
               <argument /> <!-- unicorns_are_real -->
               <argument /> <!-- min_sunshine -->
        </service>
        <service id="KnpU\LoremIpsumBundle\KnpUIpsum" alias="knpu_lorem_ipsum.knpu_ipsum" public="false" />
 </services>

|

Renaud G. 6 years ago edited

Hi!

Tried to pass a Monolog alias as a parameter just to test if I was understanding everything and I got the error :
$definition->setArgument(0, $config['logger']);
<blockquote>Argument 1 passed to TestBundle::__construct() must implement interface Psr\Log\LoggerInterface or be null, string given</blockquote>

I fiddled around for some time and solved it that way:
$definition->setArgument(0, $config['logger'] ? new Reference($config['logger']) : null);

But is this canonical? It feels weird that in the config file the alias is not prefixed with an "@":
`
knpu_lorem_ipsum:

    logger: 'monolog.logger.slack'

`

Thanks!

Edit: Okay so the next chapter kinda answers all that. Still confused about the fact that we don't need to use an "@" in the alias though.

|

weaverryan SFCASTS Renaud G. 6 years ago edited

Hey Renaud G.!

Yea, this whole "why do I need an @ here but not there" is a valid question. There is a perfectly logical reason... but it's still one of those things that you need to explain :p.

The reason is this: when you are defining a service (i.e. something under the services: key), Symfony needed some way to differentiate between you setting an argument to the string logger and the service logger. Simple enough! We'll use @logger. So far so good, right :).

Now that you're creating your shiny new bundle, you decide to add a logger key (exactly like in your code above) and YOU (the bundle author) knows that this will be a service. So... why force the user to say @logger? If you did, you would be responsible to strip off the starting @ so that you could create the new Reference without it. And if the user did not include an @, you'd have to print an error like "Even though I know that what you are passing me is the id of a service, please put an @ in front anyways".

So... like I said, it's logical why bundle authors would not force an @ to be used... but it ultimately means that your config files look a bit inconsistent. Honestly, I hope that someday (it's possible now, just not the default), we'll use PHP for the services config, which doesn't need the @ special symbol.

Cheers!

|

Renaud G. weaverryan 6 years ago

Hi Ryan!

Thanks for your explanation, on point as usual!

If it really is an inconsistency, the Reference class constructor could take care of stripping the "@" only if present? Right now I'm doing ltrim($service_id, '@') so I can use both.

Also tried to use $container->getAlias($config['name']) but the alias for monolog was unlinkable for some reason. I guess it's not supposed to be used that way ^^

|

weaverryan SFCASTS Renaud G. 6 years ago edited

Hey Renaud G.!

> If it really is an inconsistency, the Reference class constructor could take care of stripping the "@" only if present? Right now I'm doing ltrim($service_id, '@') so I can use both.

You could definitely make this argument :).

> Also tried to use $container->getAlias($config['name']) but the alias for monolog was unlinkable for some reason. I guess it's not supposed to be used that way ^^

When you're in your *BundleExtension class, the ContainerBuilder that you're passed is an *empty* ContainerBuilder. This is done on purpose: Symfony is kind of "sandboxing" you: you can add services, etc, but you don't have access to read or change any services from any other bundles. When your method is done, Symfony merges your ContainerBuilder into the real one :). That's why you can't access other services or aliases. This is also done because if you *could* reference services/aliases from other bundles, ordering would be a mess: what if your bundle is (in some apps) loaded *before* MonologBundle? It keeps you away from that ugliness ;).

Cheers!

|

Robert 7 years ago

Hey Guys,

Great tutorial!

Just a quick one. Let's assume I did all the things correctly(however I am doing that in my own project) - is there any reason why config:dump would show me ~ instead of value for specific config?

I have one key in my config - name, which is a string. I have hooked up all of that as described and all works fine. However when I am trying to double check that on console I get this:

rob_simple_test:
name: ~

Instead of the value from config file. I know for a fact that value is in $config['name'] because I can see it there right before I go and do:
$definition->setArgument(0, $config['name']);

Do you Guys have at least an idea of what might be going on here?

Unicorns and rainbows on me for the one who solves that mistery!

Regards,
Rob

|

weaverryan SFCASTS Robert 7 years ago edited

Hey Robert!

It sounds like you've got all the hard stuff set up. And... yea, I think I know the answer here :). There are 2 separate commands:

config:dump Returns a YAML representation of all of the config keys and their default values by reading your Configuration object. This does not reflect your REAL config values in any way
debug:config Returns a YAML representation of the ACTUAL config values in your project (which is of course a combination of what you've configured plus any defaults from the Configuration class

In other words - this is expected! Just use debug:config instead - it should print what you're expecting.

Let me know if this answers your question! I gotta cash in on the unicorns and rainbows you promised ;).

Cheers!

|

Robert weaverryan 7 years ago edited

Hey weaverryan !

That's it. You helped a lot. Thank you for this, now it's clear.

As for the Rainbows and Unicorns - is there any KnpU Mailbox to which I can send postcard full of those magnificent things?

7 |

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