New in Symfony 4.3: URL Env Var Processor
Javier Eguiluz
Warning: This post is about an unsupported Symfony version. Some of this information may be out of date. Read the most recent Symfony Docs.
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
- XML
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)%'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 parameter of the query string as follows:
- YAML
- XML
1 2 3 4 5 6
# config/packages/mongodb.yaml
mongo_db_bundle:
clients:
default:
# ...
connectTimeoutMS: '%env(int:key:timeout:query_string:MONGODB_URL)%'Help the Symfony project!
As with any Open-Source project, contributing code or documentation is the most common way to help, but we also have a wide range of sponsoring opportunities.
Comments
Comments are closed.
To ensure that comments stay relevant, they are closed for old posts.
A method to undo the concatenation if great, but it feels like a dirty workaround for a problem that doesn't have to (and even didn't?) exist in the first place. What's wrong with setting username/password as environment variables?
However, it's increasingly common for Internet services to use DSN-like URLs to configure things. That's why Symfony supports it and makes it easy to work with that.