Symfony 4, get .env parameter from a controller, is it possible and how?

Question

From symfony 4, I want create a global parameter and get the value of this parameter from a controller.

This parameter is the path of an another app in the server. So, I thinked add the paramerter in the .env file. But how can I get the value of this parameter from a controller?

score 55 · Answer 1 · answered Aug 25 '20 at 18:26

55

For Symfony 5

in your .env file

APP_PARAM=paramvaluehere

in your config/services.yaml

parameters:
    app.paramname: '%env(APP_PARAM)%'

in your controller

$this->getParameter('app.paramname');

answered Aug 25 '20 at 18:26

Mayank Tiwari

919
1
6
13

1

Works in 4.3 too. – learner May 07 '21 at 12:58
2

You can simply do `$_SERVER['APP_PARAM']` with value only in .env file https://symfony.com/doc/current/cloud/cookbooks/env.html#accessing-environment-variables – TikTaZ Sep 27 '21 at 14:04
To be able to call `$this->getParameter('app.paramname')` make sure your controller `extends AbstractController`. – iloo Dec 01 '21 at 14:27
The `config/services.yaml` part is only required if your controller DOES NOT `extends AbstractController`. https://symfony.com/doc/current/configuration.html#accessing-configuration-parameters – Jibato Jul 13 '22 at 09:47

Theva · Answer 2 · 2021-05-21T19:06:55.010

38

If someone is stil looking for a quick fix but not much symfonish,

define your parameter in .env

MY_PARAM='my param value'

and then in controller call it

echo $_ENV['MY_PARAM'];

if you call the varaible in the controller you better define it in the config/services.yaml under parameters section and access it through parameterBag is much symfonish way.

edited May 21 '21 at 19:06

answered Nov 04 '19 at 16:16

Theva

873
8
15

1

I believe this is the default way to go from symfony 4.3+ ! Working in 5.2 – Artandor Aug 06 '21 at 11:29
1

With time you forget the basics. $_ENV should do the job for simple things like a functional test for example :) for more elaborated and Symfony way approach, use parameters. – davidmpaz Oct 13 '22 at 15:30

AnTrakS · Accepted Answer · 2018-09-03T14:45:12.140

15

Did you try with:

$this->getParameter('your parameter');

Edit:

This may help you -> https://symfony.com/doc/current/components/dotenv.html

edited Sep 03 '18 at 14:45

answered Sep 03 '18 at 14:37

AnTrakS

733
4
18

1

Thank you for your answer :) I added the parameter foo in the .env file (foo=faa), I cleaared caches but I get an "InvalidArgumentException : The parameter 'foo' must be defined" in my controller :/ – spacecodeur Sep 03 '18 at 14:43
1

Edited my answer – AnTrakS Sep 03 '18 at 14:45
1

Yes, I just saw that ! It's curious, I thinked that was a native method in Symfony ! – spacecodeur Sep 03 '18 at 14:46
I'm not very familiar with Symfony, there may be a native method in Symfony 4. – AnTrakS Sep 03 '18 at 14:48

score 11 · Answer 4 · answered Oct 30 '19 at 15:08

11

Before to user getParameter() you have to add this in services.yaml

parameters:
    your_parameter: '%env(your_parameter)%' # from .env file

answered Oct 30 '19 at 15:08

Aymeric

347
5
17

score 8 · Answer 5 · answered Jan 24 '22 at 13:14

Yes it is. You have 03 steps configuration :
Filstly - declare yours variables in env.
Secondly - configure service file
and finally - call your parameter in your controller :

_ In controllers extending from the AbstractController, use the getParameter() helper :

YAML file config

# config/services.yaml
parameters:
    kernel.project_dir: "%env(variable_name)%"
    app.admin_email: "%env(variable_name)%"

In your controller,

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class UserController extends AbstractController
{
    // ...

    public function index(): Response
    {
        $projectDir = $this->getParameter('kernel.project_dir');
        $adminEmail = $this->getParameter('app.admin_email');

        // ...
    }
}

_ If controllers not extending from AbstractController, inject the parameters as arguments of their constructors.

YAML file config

# config/services.yaml
parameters:
    app.contents_dir: "%env(variable_name)%"

services:
    App\Controllers\UserController :
        arguments:
            $contentsDir: '%app.contents_dir%'

In your controller,

class UserController 
{
    private $params;

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

    public function someMethod()
    {
        $parameterValue = $this->params;
        // ...
    }
}

_ Finally, if some controllers needs access to lots of parameters, instead of injecting each of them individually, you can inject all the application parameters at once by type-hinting any of its constructor arguments with the ContainerBagInterface:

YAML file config

# config/services.yaml
parameters:
    app.parameter_name: "%env(variable_name)%"

In your service,

use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;

class UserController 
{
    private $params;

    public function __construct(ContainerBagInterface $params)
    {
        $this->params = $params;
    }

    public function someMethod()
    {
        $parameterValue = $this->params->get('app.parameter_name');
        // ...
    }
}

source Accessing Configuration Parameters

apply corrections as suggested by @samuel-liew – belem Jan 24 '22 at 13:15 — belem, Jan 24 '22 at 13:15

score 6 · Answer 6 · answered Nov 29 '19 at 19:41

6

Add the variable in the config parameters :

    parameters:
        your_variable: '%env(YOUR_ENV_VARIABLE)%'

Fetch it from the controller

    $var = $this->getParameter('your_variable');

answered Nov 29 '19 at 19:41

aneth101

509
5
9

score 2 · Answer 7 · answered Feb 16 '22 at 13:30

In Symfony 4.4 this works fine:

<?php
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;

class SomeController extends AbstractController 
{

    public function someMethod(Request $request)
    {
        $parameterValue = $request->server->get('env_varname');
        // ...
    }
}

also in TWIG:

{{ app.request.server.get('env_varname') }}

Symfony 4, get .env parameter from a controller, is it possible and how?

7 Answers7

Linked