Controllers: Boring, Beautiful Services

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

Head back to our trusty controller: src/Controller/QuestionController.php. It may be obvious, but it's worth mentioning that controllers are also services that live in the container. Yep, they're good, old, normal boring services that behave just like anything else. Well except that they have that one extra superpower that no other service has: the ability to autowire arguments into its methods. That normally only works for the constructor.

Using bind in Controller Arguments

Open up config/services.yaml. A few minutes ago, we added this global "bind" called bool $isDebug:

            
            33 lines
            
            config/services.yaml
        
                                                    ... lines 1 - 8
                            
            services:
        
                # default configuration for services in *this* file
        
                _defaults:
        
                                                    ... lines 12 - 13
                            
                    bind:
        
                        bool $isDebug: '%kernel.debug%'
        
                                                    ... lines 16 - 33

Thanks to that, we can add a bool $isDebug argument to the constructor of any service and Symfony will pass us this value. But can we also add this argument to a controller method? Absolutely! In the controller, add another with this name: bool $isDebug. I'll dump that down here:

            
            50 lines
            
            src/Controller/QuestionController.php
        
                                                    ... lines 1 - 10
                            
            class QuestionController extends AbstractController
        
            {
        
                                                    ... lines 13 - 30
                            
                public function show($slug, MarkdownHelper $markdownHelper, bool $isDebug)
        
                {
        
                    dump($isDebug);
        
                                                    ... lines 34 - 47
                            
                }
        
            }

Now, find you browser, go back to our show page, refresh and... that works wonderfully.

The point is: this ability to autowire arguments into a method is unique to controllers, but it works exactly the same as normal, constructor autowiring.

Constructor Injection

And because a controller is a normal, boring service, we can also use normal dependency injection. Remove the $isDebug argument. Let's pretend that we want to log something. This time, create a public function __construct() and give it two arguments LoggerInterface $logger and bool $isDebug. Like last time, I'll put my cursor on one of the arguments, hit Alt+Enter, and go to "Initialize properties" to create both of those properties and set them below:

            
            64 lines
            
            src/Controller/QuestionController.php
        
                                                    ... lines 1 - 5
                            
            use Psr\Log\LoggerInterface;
        
                                                    ... lines 7 - 11
                            
            class QuestionController extends AbstractController
        
            {
        
                private $logger;
        
                private $isDebug;
        
                public function __construct(LoggerInterface $logger, bool $isDebug)
        
                {
        
                    $this->logger = $logger;
        
                    $this->isDebug = $isDebug;
        
                }
        
                                                    ... lines 22 - 62
                            
            }

Down in the show() method, we can say something like if $this->isDebug, then $this->logger->info():

We are in debug mode!

If you refresh now, open the Profiler, and go to logs... there it is!

So... yeah! Controllers are normal services and, if you want to, you can entirely use "normal" dependency injection through the constructor. Heck the biggest reason that autowiring was added to the method was convenience. I usually autowire into my methods, but if you need a service in every method, using the constructor can help clean things up.

Next, let's talk about the final missing piece to configuration: environment variables!

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": "^7.3.0 || ^8.0.0",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "composer/package-versions-deprecated": "^1.11", // 1.11.99
        "knplabs/knp-markdown-bundle": "^1.8", // 1.9.0
        "sensio/framework-extra-bundle": "^6.0", // v6.2.1
        "sentry/sentry-symfony": "^4.0", // 4.0.3
        "symfony/asset": "5.0.*", // v5.0.11
        "symfony/console": "5.0.*", // v5.0.11
        "symfony/debug-bundle": "5.0.*", // v5.0.11
        "symfony/dotenv": "5.0.*", // v5.0.11
        "symfony/flex": "^1.3.1", // v1.17.5
        "symfony/framework-bundle": "5.0.*", // v5.0.11
        "symfony/monolog-bundle": "^3.0", // v3.6.0
        "symfony/profiler-pack": "*", // v1.0.5
        "symfony/routing": "5.1.*", // v5.1.11
        "symfony/twig-pack": "^1.0", // v1.0.1
        "symfony/var-dumper": "5.0.*", // v5.0.11
        "symfony/webpack-encore-bundle": "^1.7", // v1.8.0
        "symfony/yaml": "5.0.*" // v5.0.11
    },
    "require-dev": {
        "symfony/maker-bundle": "^1.15", // v1.23.0
        "symfony/profiler-pack": "^1.0" // v1.0.5
    }
}

Edit on GitHub

TRACK

Symfony 5 >

COURSE

Symfony 5 Fundamentals: Services, Config & Environments

Controllers: Boring, Beautiful Services

Keep on Learning!

Using bind in Controller Arguments

Constructor Injection

Leave a comment!

What PHP libraries does this tutorial use?

	... lines 1 - 8
	services:
	# default configuration for services in this file
	_defaults:
	... lines 12 - 13
	bind:
	bool $isDebug: '%kernel.debug%'
	... lines 16 - 33

	... lines 1 - 10
	class QuestionController extends AbstractController
	{
	... lines 13 - 30
	public function show($slug, MarkdownHelper $markdownHelper, bool $isDebug)
	{
	dump($isDebug);
	... lines 34 - 47
	}
	}

	... lines 1 - 5
	use Psr\Log\LoggerInterface;
	... lines 7 - 11
	class QuestionController extends AbstractController
	{
	private $logger;
	private $isDebug;

	public function __construct(LoggerInterface $logger, bool $isDebug)
	{
	$this->logger = $logger;
	$this->isDebug = $isDebug;
	}
	... lines 22 - 62
	}