Symfony News

New in Symfony 4.3: URL Env Var Processor

Jérémy Derussé

Contributed by
Jérémy Derussé
in #28975.

When using env vars to configure Symfony it's common to use URLs to define the value of DSN-like config options like the following:

1
2
# .env
MONGODB_URL="mongodb://db_user:db_password@127.0.0.1:27017/db_name"

However, sometimes you need to access to some parts of the URL (such as the database name or the port number) to define the value of other options. In Symfony 4.3, we've added two new env var processors (url and query_string) to do that.

The url processor parses the given URL and returns an associative array with its components, so you can combine it with the key processor:

  • YAML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
    # config/packages/mongodb.yaml
mongo_db_bundle:
    clients:
        default:
            # ...
            username: '%env(key:user:url:MONGODB_URL)%'
            password: '%env(key:pass:url:MONGODB_URL)%'
    connections:
        default:
            database_name: '%env(key:path:url:MONGODB_URL)%'
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    <!-- config/packages/mongodb.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="https://symfony.com/schema/dic/services"
    xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">
    <mongodb:config>
        <mongodb:client name="default"
         username="%env(key:user:url:MONGODB_URL)%"
         password="%env(key:pass:url:MONGODB_URL)%">
            <!-- ... -->
        </mongodb:client>
        <mongodb:connections name="default"
         database_name="%env(key:path:url:MONGODB_URL)%"/>
    </mongodb:config>
</container>

The query_string processor parses the query string part of the given URL and returns an associative array with its components, so you can also combine it with the key processor. If the env var is defined like this:

1
2
# .env
MONGODB_URL="mongodb://db_user:db_password@127.0.0.1:27017/db_name?timeout=3000"

You can get the value of the timeout value of the query string as follows:

  • YAML
    1
2
3
4
5
6
    # config/packages/mongodb.yaml
mongo_db_bundle:
    clients:
        default:
            # ...
            connectTimeoutMS: '%env(int:key:timeout:query_string:MONGODB_URL)%'
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
    <!-- config/packages/mongodb.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="https://symfony.com/schema/dic/services"
    xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">
    <mongodb:config>
        <mongodb:client name="default"
         connectTimeoutMS="%env(int:key:timeout:query_string:MONGODB_URL)%" />
    </mongodb:config>
</container>
Be trained by Symfony experts - 2019-04-1 Clichy - 2019-04-4 Clichy - 2019-04-8 Clichy


Source: https://symfony.com/blog

About us

What a Symfony developer should know about the framework: News, Jobs, Tweets, Events, Videos,...

Resources

Find us on Twitter

Find us on Facebook