Check if in "dev" mode inside a Controller with Symfony

When using dev mode with a Symfony2.x application, one usually works in locale. Hence, such function does not works as expected (for instance, try to get the current IP under localhost). This could be a problem, e.g. when one try to use such ip-based web service. Hence, I just want to know how to check inside a controller if the Symfony2 application is running in dev mode or not. In that way one can set the behavior of the controller depending by the mode.

Any idea?

Answers


To get the current environment in a Controller you can use:

$this->container->getParameter('kernel.environment');

So you just put that in an if() statement to check if it equals to dev.


As of Symfony 2.5 it could be done as:

$this->container->get('kernel')->getEnvironment();

Directly asking Kernel of it's environment looks nicer than searching for parameter.


Since you want to know if you are in dev mode (not necessarilly the environment named "dev"), you can retrieve the kernel from the service container and check the isDebug method return:

$kernel = $this->get('kernel');
$devMode = $kernel->isDebug();

As noted in the documentation (emphasis is mine),

Important, but unrelated to the topic of environments is the true or false argument as the second argument to the AppKernel constructor. This specifies if the application should run in "debug mode". Regardless of the environment, a Symfony application can be run with debug mode set to true or false. This affects many things in the application, such as displaying stacktraces on error pages or if cache files are dynamically rebuilt on each request. Though not a requirement, debug mode is generally set to true for the dev and test environments and false for the prod environment.

Internally, the value of the debug mode becomes the kernel.debug parameter used inside the service container.


Here is 2017 and Symfony 3.3+ version using Constructor Injection.

Instead of passing you whole application (= container), you could pass only the parameter you need:

1. Service config
# app/config/services.yml
services:
    _defaults:
        autowire: true

    App\Controller\SomeController:
        arguments: ['%kernel.environment%']

If you don't understand this syntax, check this post explaining Symfony DI news in before/after examples.

2. The Controller
namespace App\Controller;

final class SomeController
{
    /**
     * @var string
     */
    private $environment;

    public function __construct(string $environment)
    {
        $this->environment = $environment;
    }

    public function someAction()
    {
        $this->environment...
        // any operations you need
    }
}

Why to avoid passing Container in Controller?

The most important thing in the code is consistency.

  • If you prefer static and service locators (= service you can pass anywhere to get any other service), use it.

  • If you prefer constructor injection, tree dependency graph (!= circular dependencies), use it.

Mixing this concept might be ok for you, if you know why you used them that way. But here comes to play The Broken Window Theory (nicely described version by Coding Horror). Anyone coming to the code will more likely pick the version that is not intended to use that way.

Ambiguity in the code is the first invitation to legacy code

I've mentored teams of many applications, that started with simple $this->container in the code and after couple of years ended up calling me for help, how to rewrite or refactor whole static hell.


For Symfony 4.x and above

If you are using .env to store your environment variables, you can access them in any controller by simply using $_ENV['name-of-variable']

For a default installation, there is a $_ENV["APP_ENV"] variable available, which will tell you if you are in dev mode or not.


Use print_r($_ENV); to see all the available environment variables.

[ps - This also works for Symfony 3.4]


Need Your Help

Laravel catch TokenMismatchException

php laravel exception-handling csrf laravel-5

Can the TokenMismatchException be catched using try catch block? Instead of displaying the debug page that shows the "TokenMismatchException in VerifyCsrfToken.php line 46...", I want it to display...

MATLAB heat map

matlab heatmap

I am trying to create a heat map using MATLAB, but the default function in MATLAB program doesn't any sense to me.