8000 Merge branch '6.0' into 6.1 · symfony/symfony-docs@ec0d80b · GitHub
[go: up one dir, main page]
Skip to content

Commit ec0d80b

Browse files
javiereguiluzjaviereguiluz
committed
Merge branch '6.0' into 6.1
* 6.0: Remove some unneeded versionadded directives Use PHP-DSL `env()` configurator when possible
2 parents bad0234 + 5eb3931 commit ec0d80b

12 files changed

+32
-28
lines changed

‎configuration.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -617,6 +617,8 @@ This example shows how you could configure the database connection using an env
617617
'dbal' => [
618618
// by convention the env var names are always uppercase
619619
'url' => '%env(resolve:DATABASE_URL)%',
620+
// or
621+
'url' => env('DATABASE_URL')->resolve(),
620622
],
621623
]);
622624
};

‎configuration/env_var_processors.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ processor to turn the value of the ``HTTP_PORT`` env var into an integer:
5050
5151
return static function (FrameworkConfig $framework) {
5252
$framework->router()
53+
->httpPort('%env(int:HTTP_PORT)%')
54+
// or
5355
->httpPort(env('HTTP_PORT')->int())
5456
;
5557
};
@@ -236,7 +238,7 @@ Symfony provides the following env var processors:
236238
$container->setParameter('env(HEALTH_CHECK_METHOD)', 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD');
237239
$security->accessControl()
238240
->path('^/health-check$')
239-
->methods(['%env(const:HEALTH_CHECK_METHOD)%']);
241+
->methods([env('HEALTH_CHECK_METHOD')->const()]);
240242
};
241243
242244
``env(base64:FOO)``

‎configuration/secrets.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ If you stored a ``DATABASE_PASSWORD`` secret, you can reference it by:
145145
return static function (DoctrineConfig $doctrine) {
146146
$doctrine->dbal()
147147
->connection('default')
148-
->password('%env(DATABASE_PASSWORD)%')
148+
->password(env('DATABASE_PASSWORD'))
149149
;
150150
};
151151

‎doctrine/multiple_entity_managers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,15 +136,15 @@ The following configuration code shows how you can configure two entity managers
136136
// configure these for your database server
137137
$doctrine->dbal()
138138
->connection('default')
139-
->url('%env(resolve:DATABASE_URL)%')
139+
->url(env('DATABASE_URL')->resolve())
140140
->driver('pdo_mysql')
141141
->serverVersion('5.7')
142142
->charset('utf8mb4');
143143
144144
// configure these for your database server
145145
$doctrine->dbal()
146146
->connection('customer')
147-
->url('%env(resolve:DATABASE_CUSTOMER_URL)%')
147+
->url(env('DATABASE_CUSTOMER_URL')->resolve())
148148
->driver('pdo_mysql')
149149
->serverVersion('5.7')
150150
->charset('utf8mb4');

‎lock.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ this behavior by using the ``lock`` key like:
149149
->resource('default', ['sqlsrv:server=127.0.0.1;Database=app'])
150150
->resource('default', ['oci:host=127.0.0.1;dbname=app'])
151151
->resource('default', ['mongodb://127.0.0.1/app?collection=lock'])
152-
->resource('default', ['%env(LOCK_DSN)%'])
152+
->resource('default', [env('LOCK_DSN')])
153153
154154
// named locks
155155
->resource('invoice', ['semaphore', 'redis://r2.docker'])

‎mailer.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ over SMTP by configuring the DSN in your ``.env`` file (the ``user``,
6060
return static function (ContainerConfigurator $containerConfigurator): void {
6161
$containerConfigurator->extension('framework', [
6262
'mailer' => [
63-
'dsn' => '%env(MAILER_DSN)%',
63+
'dsn' => env('MAILER_DSN'),
6464
],
6565
]);
6666
};
@@ -1110,8 +1110,8 @@ This can be configured by replacing the ``dsn`` configuration entry with a
11101110
11111111
return static function (FrameworkConfig $framework) {
11121112
$framework->mailer()
1113-
->transport('main', '%env(MAILER_DSN)%')
1114-
->transport('alternative', '%env(MAILER_DSN_IMPORTANT)%')
1113+
->transport('main', env('MAILER_DSN'))
1114+
->transport('alternative', env('MAILER_DSN_IMPORTANT'))
11151115
;
11161116
};
11171117
@@ -1183,7 +1183,7 @@ you have a transport called ``async``, you can route the message there:
11831183
11841184
return static function (FrameworkConfig $framework) {
11851185
$framework->messenger()
1186-
->transport('async')->dsn('%env(MESSENGER_TRANSPORT_DSN)%');
1186+
->transport('async')->dsn(env('MESSENGER_TRANSPORT_DSN'));
11871187
11881188
$framework->messenger()
11891189
->routing('Symfony\Component\Mailer\Messenger\SendEmailMessage')

‎messenger.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -198,12 +198,12 @@ that uses this configuration:
198198
return static function (FrameworkConfig $framework) {
199199
$framework->messenger()
200200
->transport('async')
201-
->dsn('%env(MESSENGER_TRANSPORT_DSN)%')
201+
->dsn(env('MESSENGER_TRANSPORT_DSN'))
202202
;
203203
204204
$framework->messenger()
205205
->transport('async')
206-
->dsn('%env(MESSENGER_TRANSPORT_DSN)%')
206+
->dsn(env('MESSENGER_TRANSPORT_DSN'))
207207
->options([])
208208
;
209209
};
@@ -593,11 +593,11 @@ different messages to them. For example:
593593
$messenger = $framework->messenger();
594594
595595
$messenger->transport('async_priority_high')
596-
->dsn('%env(MESSENGER_TRANSPORT_DSN)%')
596+
->dsn(env('MESSENGER_TRANSPORT_DSN'))
597597
->options(['queue_name' => 'high']);
598598
599599
$messenger->transport('async_priority_low')
600-
->dsn('%env(MESSENGER_TRANSPORT_DSN)%')
600+
->dsn(env('MESSENGER_TRANSPORT_DSN'))
601601
->options(['queue_name' => 'low']);
602602
603603
$messenger->routing('App\Message\SmsNotification')->senders(['async_priority_low']);
@@ -807,7 +807,7 @@ this is configurable for each transport:
807807
$messenger = $framework->messenger();
808808
809809
$messenger->transport('async_priority_high')
810-
->dsn('%env(MESSENGER_TRANSPORT_DSN)%')
810+
->dsn(env('MESSENGER_TRANSPORT_DSN'))
811811
// default configuration
812812
->retryStrategy()
813813
->maxRetries(3)
@@ -1007,7 +1007,7 @@ override the failure transport for only specific transports:
10071007
$messenger->failureTransport('failed_default');
10081008
10091009
$messenger->transport('async_priority_high')
1010-
->dsn('%env(MESSENGER_TRANSPORT_DSN)%')
1010+
->dsn(env('MESSENGER_TRANSPORT_DSN'))
10111011
->failureTransport('failed_high_priority');
10121012
10131013
// since no failed transport is configured, the one used will be
@@ -1095,7 +1095,7 @@ options. Options can be passed to the transport via a DSN string or configuratio
10951095
$messenger = $framework->messenger();
10961096
10971097
$messenger->transport('my_transport')
1098-
->dsn('%env(MESSENGER_TRANSPORT_DSN)%')
1098+
->dsn(env('MESSENGER_TRANSPORT_DSN'))
10991099
->options(['auto_setup' => false]);
11001100
};
11011101

‎notifier.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ configure the ``texter_transports``:
141141
142142
return static function (FrameworkConfig $framework) {
143143
$framework->notifier()
144-
->texterTransport('twilio', '%env(TWILIO_DSN)%')
144+
->texterTransport('twilio', env('TWILIO_DSN'))
145145
;
146146
};
147147
@@ -219,7 +219,7 @@ Chatters are configured using the ``chatter_transports`` setting:
219219
220220
return static function (FrameworkConfig $framework) {
221221
$framework->notifier()
222-
->chatterTransport('slack', '%env(SLACK_DSN)%')
222+
->chatterTransport('slack', env('SLACK_DSN'))
223223
;
224224
};
225225
@@ -283,7 +283,7 @@ notification emails:
283283
284284
return static function (FrameworkConfig $framework) {
285285
$framework->mailer()
286-
->dsn('%env(MAILER_DSN)%')
286+
->dsn(env('MAILER_DSN'))
287287
->envelope()
288288
->sender('notifications@example.com')
289289
;
@@ -350,7 +350,7 @@ configure the ``texter_transports``:
350350
351351
return static function (FrameworkConfig $framework) {
352352
$framework->notifier()
353-
->texterTransport('expo', '%env(EXPO_DSN)%')
353+
->texterTransport('expo', env('EXPO_DSN'))
354354
;
355355
};
356356
@@ -414,10 +414,10 @@ transport:
414414
$framework->notifier()
415415
// Send notifications to Slack and use Telegram if
416416
// Slack errored
417-
->chatterTransport('main', '%env(SLACK_DSN)% || %env(TELEGRAM_DSN)%')
417+
->chatterTransport('main', env('SLACK_DSN').' || '.env('TELEGRAM_DSN'))
418418
419419
// Send notifications to the next scheduled transport calculated by round robin
420-
->chatterTransport('roundrobin', '%env(SLACK_DSN)% && %env(TELEGRAM_DSN)%')
420+
->chatterTransport('roundrobin', env('SLACK_DSN').' && '.env('TELEGRAM_DSN'))
421421
;
422422
};
423423

‎reference/configuration/framework.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3067,7 +3067,7 @@ the name as key and DSN as value:
30673067
30683068
return static function (FrameworkConfig $framework) {
30693069
$framework->lock()
3070-
->resource('default', ['%env(LOCK_DSN)%']);
3070+
->resource('default', [env('LOCK_DSN')]);
30713071
};
30723072
30733073
.. seealso::

‎security/access_control.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,12 @@ Take the following ``access_control`` entries as an example:
120120
$security->accessControl()
121121
->path('^/admin')
122122
->roles(['ROLE_USER_IP'])
123-
->ips(['%env(TRUSTED_IPS)%'])
123+
->ips([env('TRUSTED_IPS')])
124124
;
125125
$security->accessControl()
126126
->path('^/admin')
127127
->roles(['ROLE_USER_IP'])
128-
->ips(['127.0.0.1', '::1', '%env(TRUSTED_IPS)%'])
128+
->ips(['127.0.0.1', '::1', env('TRUSTED_IPS')])
129129
;
130130
};
131131

‎session/database.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ first register a new handler service with your database credentials:
229229
230230
$services->set(PdoSessionHandler::class)
231231
->args([
232-
'%env(DATABASE_URL)%',
232+
env('DATABASE_URL'),
233233
// you can also use PDO configuration, but requires passing two arguments:
234234
// 'mysql:dbname=mydatabase; host=myhost; port=myport',
235235
// ['db_username' => 'myuser', 'db_password' => 'mypassword'],
@@ -329,7 +329,7 @@ passed to the ``PdoSessionHandler`` service:
329329
330330
$services->set(PdoSessionHandler::class)
331331
->args([
332-
'%env(DATABASE_URL)%',
332+
env('DATABASE_URL'),
333333
['db_table' => 'customer_session', 'db_id_col' => 'guid'],
334334
])
335335
;

‎translation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@ configure the ``providers`` option:
699699
'translator' => [
700700
'providers' => [
701701
'loco' => [
702-
'dsn' => '%env(LOCO_DSN)%',
702+
'dsn' => env('LOCO_DSN'),
703703
'domains' => ['messages'],
704704
'locales' => ['en', 'fr'],
705705
],

0 commit comments

Comments
 (0)
0