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

Commit b429a80

Browse files
javiereguiluzjaviereguiluz
committed
Merge branch '5.4' into 6.0
* 5.4: Standardize the name of the container builder variable 5.4
2 parents 9179c63 + ae687ab commit b429a80

File tree

13 files changed

+71
-71
lines changed

13 files changed

+71
-71
lines changed

‎bundles/configuration.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ force validation (e.g. if an additional option was passed, an exception will be
221221
thrown)::
222222

223223
// src/Acme/SocialBundle/DependencyInjection/AcmeSocialExtension.php
224-
public function load(array $configs, ContainerBuilder $container)
224+
public function load(array $configs, ContainerBuilder $containerBuilder)
225225
{
226226
$configuration = new Configuration();
227227

@@ -263,15 +263,15 @@ In your extension, you can load this and dynamically set its arguments::
263263
use Symfony\Component\Config\FileLocator;
264264
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
265265

266-
public function load(array $configs, ContainerBuilder $container)
266+
public function load(array $configs, ContainerBuilder $containerBuilder)
267267
{
268-
$loader = new XmlFileLoader($container, new FileLocator(dirname(__DIR__).'/Resources/config'));
268+
$loader = new XmlFileLoader($containerBuilder, new FileLocator(dirname(__DIR__).'/Resources/config'));
269269
$loader->load('services.xml');
270270

271271
$configuration = new Configuration();
272272
$config = $this->processConfiguration($configuration, $configs);
273273

274-
$definition = $container->getDefinition('acme.social.twitter_client');
274+
$definition = $containerBuilder->getDefinition('acme.social.twitter_client');
275275
$definition->replaceArgument(0, $config['twitter']['client_id']);
276276
$definition->replaceArgument(1, $config['twitter']['client_secret']);
277277
}
@@ -292,7 +292,7 @@ In your extension, you can load this and dynamically set its arguments::
292292
class AcmeHelloExtension extends ConfigurableExtension
293293
{
294294
// note that this method is called loadInternal and not load
295-
protected function loadInternal(array $mergedConfig, ContainerBuilder $container)
295+
protected function loadInternal(array $mergedConfig, ContainerBuilder $containerBuilder)
296296
{
297297
// ...
298298
}
@@ -308,7 +308,7 @@ In your extension, you can load this and dynamically set its arguments::
308308
(e.g. by overriding configurations and using :phpfunction:`isset` to check
309309
for the existence of a value). Be aware that it'll be very hard to support XML::
310310

311-
public function load(array $configs, ContainerBuilder $container)
311+
public function load(array $configs, ContainerBuilder $containerBuilder)
312312
{
313313
$config = [];
314314
// let resources override the previous set value

‎bundles/extension.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This is how the extension of an AcmeHelloBundle should look like::
3838

3939
class AcmeHelloExtension extends Extension
4040
{
41-
public function load(array $configs, ContainerBuilder $container)
41+
public function load(array $configs, ContainerBuilder $containerBuilder)
4242
{
4343
// ... you'll load the files here later
4444
}
@@ -94,10 +94,10 @@ For instance, assume you have a file called ``services.xml`` in the
9494
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
9595

9696
// ...
97-
public function load(array $configs, ContainerBuilder $container)
97+
public function load(array $configs, ContainerBuilder $containerBuilder)
9898
{
9999
$loader = new XmlFileLoader(
100-
$container,
100+
$containerBuilder,
101101
new FileLocator(__DIR__.'/../Resources/config')
102102
);
103103
$loader->load('services.xml');
@@ -120,7 +120,7 @@ they are compiled when generating the application cache to improve the overall
120120
performance. Define the list of annotated classes to compile in the
121121
``addAnnotatedClassesToCompile()`` method::
122122

123-
public function load(array $configs, ContainerBuilder $container)
123+
public function load(array $configs, ContainerBuilder $containerBuilder)
124124
{
125125
// ...
126126

‎bundles/prepend_extension.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To give an Extension the power to do this, it needs to implement
3535
{
3636
// ...
3737

38-
public function prepend(ContainerBuilder $container)
38+
public function prepend(ContainerBuilder $containerBuilder)
3939
{
4040
// ...
4141
}
@@ -56,37 +56,37 @@ a configuration setting in multiple bundles as well as disable a flag in multipl
5656
in case a specific other bundle is not registered::
5757

5858
// src/Acme/HelloBundle/DependencyInjection/AcmeHelloExtension.php
59-
public function prepend(ContainerBuilder $container)
59+
public function prepend(ContainerBuilder $containerBuilder)
6060
{
6161
// get all bundles
62-
$bundles = $container->getParameter('kernel.bundles');
62+
$bundles = $containerBuilder->getParameter('kernel.bundles');
6363
// determine if AcmeGoodbyeBundle is registered
6464
if (!isset($bundles['AcmeGoodbyeBundle'])) {
6565
// disable AcmeGoodbyeBundle in bundles
6666
$config = ['use_acme_goodbye' => false];
67-
foreach ($container->getExtensions() as $name => $extension) {
67+
foreach ($containerBuilder->getExtensions() as $name => $extension) {
6868
match ($name) {
6969
// set use_acme_goodbye to false in the config of
7070
// acme_something and acme_other
7171
//
7272
// note that if the user manually configured
7373
// use_acme_goodbye to true in config/services.yaml
7474
// then the setting would in the end be true and not false
75-
'acme_something', 'acme_other' => $container->prependExtensionConfig($name, $config),
75+
'acme_something', 'acme_other' => $containerBuilder->prependExtensionConfig($name, $config),
7676
default => null
7777
};
7878
}
7979
}
8080

8181
// get the configuration of AcmeHelloExtension (it's a list of configuration)
82-
$configs = $container->getExtensionConfig($this->getAlias());
82+
$configs = $containerBuilder->getExtensionConfig($this->getAlias());
8383

8484
// iterate in reverse to preserve the original order after prepending the config
8585
foreach (array_reverse($configs) as $config) {
8686
// check if entity_manager_name is set in the "acme_hello" configuration
8787
if (isset($config['entity_manager_name'])) {
8888
// prepend the acme_something settings with the entity_manager_name
89-
$container->prependExtensionConfig('acme_something', [
89+
$containerBuilder->prependExtensionConfig('acme_something', [
9090
'entity_manager_name' => $config['entity_manager_name'],
9191
]);
9292
}

‎cache.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -447,14 +447,14 @@ and use that when configuring the pool.
447447
use Symfony\Component\DependencyInjection\ContainerBuilder;
448448
use Symfony\Config\FrameworkConfig;
449449
450-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
450+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
451451
$framework->cache()
452452
->pool('cache.my_redis')
453453
->adapters(['cache.adapter.redis'])
454454
->provider('app.my_custom_redis_provider');
455455
456456
457-
$container->register('app.my_custom_redis_provider', \Redis::class)
457+
$containerBuilder->register('app.my_custom_redis_provider', \Redis::class)
458458
->setFactory([RedisAdapter::class, 'createConnection'])
459459
->addArgument('redis://localhost')
460460
->addArgument([

‎components/dependency_injection/compilation.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ A very simple extension may just load configuration files into the container::
6464

6565
class AcmeDemoExtension implements ExtensionInterface
6666
{
67-
public function load(array $configs, ContainerBuilder $container)
67+
public function load(array $configs, ContainerBuilder $containerBuilder)
6868
{
6969
$loader = new XmlFileLoader(
70-
$container,
70+
$containerBuilder,
7171
new FileLocator(__DIR__.'/../Resources/config')
7272
);
7373
$loader->load('services.xml');
@@ -135,7 +135,7 @@ are loaded::
135135
The values from those sections of the config files are passed into the first
136136
argument of the ``load()`` method of the extension::
137137

138-
public function load(array $configs, ContainerBuilder $container)
138+
public function load(array $configs, ContainerBuilder $containerBuilder)
139139
{
140140
$foo = $configs[0]['foo']; //fooValue
141141
$bar = $configs[0]['bar']; //barValue
@@ -161,7 +161,7 @@ you could access the config value this way::
161161
use Symfony\Component\Config\Definition\Processor;
162162
// ...
163163

164-
public function load(array $configs, ContainerBuilder $container)
164+
public function load(array $configs, ContainerBuilder $containerBuilder)
165165
{
166166
$configuration = new Configuration();
167167
$processor = new Processor();
@@ -222,13 +222,13 @@ The processed config value can now be added as container parameters as if
222222
it were listed in a ``parameters`` section of the config file but with the
223223
additional benefit of merging multiple files and validation of the configuration::
224224

225-
public function load(array $configs, ContainerBuilder $container)
225+
public function load(array $configs, ContainerBuilder $containerBuilder)
226226
{
227227
$configuration = new Configuration();
228228
$processor = new Processor();
229229
$config = $processor->processConfiguration($configuration, $configs);
230230

231-
$container->setParameter('acme_demo.FOO', $config['foo']);
231+
$containerBuilder->setParameter('acme_demo.FOO', $config['foo']);
232232

233233
// ...
234234
}
@@ -237,14 +237,14 @@ More complex configuration requirements can be catered for in the Extension
237237
classes. For example, you may choose to load a main service configuration
238238
file but also load a secondary one only if a certain parameter is set::
239239

240-
public function load(array $configs, ContainerBuilder $container)
240+
public function load(array $configs, ContainerBuilder $containerBuilder)
241241
{
242242
$configuration = new Configuration();
243243
$processor = new Processor();
244244
$config = $processor->processConfiguration($configuration, $configs);
245245

246246
$loader = new XmlFileLoader(
247-
$container,
247+
$containerBuilder,
248248
new FileLocator(__DIR__.'/../Resources/config')
249249
);
250250
$loader->load('services.xml');
@@ -295,11 +295,11 @@ method is called by implementing
295295
{
296296
// ...
297297

298-
public function prepend(ContainerBuilder $container)
298+
public function prepend(ContainerBuilder $containerBuilder)
299299
{
300300
// ...
301301

302-
$container->prependExtensionConfig($name, $config);
302+
$containerBuilder->prependExtensionConfig($name, $config);
303303

304304
// ...
305305
}
@@ -326,7 +326,7 @@ compilation::
326326

327327
class AcmeDemoExtension implements ExtensionInterface, CompilerPassInterface
328328
{
329-
public function process(ContainerBuilder $container)
329+
public function process(ContainerBuilder $containerBuilder)
330330
{
331331
// ... do something during the compilation
332332
}
@@ -380,7 +380,7 @@ class implementing the ``CompilerPassInterface``::
380380

381381
class CustomPass implements CompilerPassInterface
382382
{
383-
public function process(ContainerBuilder $container)
383+
public function process(ContainerBuilder $containerBuilder)
384384
{
385385
// ... do something during the compilation
386386
}

‎configuration/env_var_processors.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ Symfony provides the following env var processors:
101101
use Symfony\Component\DependencyInjection\ContainerBuilder;
102102
use Symfony\Config\FrameworkConfig;
103103
104-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
105-
$container->setParameter('env(SECRET)', 'some_secret');
104+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
105+
$containerBuilder->setParameter('env(SECRET)', 'some_secret');
106106
$framework->secret(env('SECRET')->string());
107107
};
108108
@@ -147,8 +147,8 @@ Symfony provides the following env var processors:
147147
use Symfony\Component\DependencyInjection\ContainerBuilder;
148148
use Symfony\Config\FrameworkConfig;
149149
150-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
151-
$container->setParameter('env(HTTP_METHOD_OVERRIDE)', 'true');
150+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
151+
$containerBuilder->setParameter('env(HTTP_METHOD_OVERRIDE)', 'true');
152152
$framework->httpMethodOverride(env('HTTP_METHOD_OVERRIDE')->bool());
153153
};
154154
@@ -234,8 +234,8 @@ Symfony provides the following env var processors:
234234
use Symfony\Component\DependencyInjection\ContainerBuilder;
235235
use Symfony\Config\SecurityConfig;
236236
237-
return static function (ContainerBuilder $container, SecurityConfig $security) {
238-
$container->setParameter('env(HEALTH_CHECK_METHOD)', 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD');
237+
return static function (ContainerBuilder $containerBuilder, SecurityConfig $security) {
238+
$containerBuilder->setParameter('env(HEALTH_CHECK_METHOD)', 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD');
239239
$security->accessControl()
240240
->path('^/health-check$')
241241
->methods([env('HEALTH_CHECK_METHOD')->const()]);
@@ -285,8 +285,8 @@ Symfony provides the following env var processors:
285285
use Symfony\Component\DependencyInjection\ContainerBuilder;
286286
use Symfony\Config\FrameworkConfig;
287287
288-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
289-
$container->setParameter('env(TRUSTED_HOSTS)', '["10.0.0.1", "10.0.0.2"]');
288+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
289+
$containerBuilder->setParameter('env(TRUSTED_HOSTS)', '["10.0.0.1", "10.0.0.2"]');
290290
$framework->trustedHosts(env('TRUSTED_HOSTS')->json());
291291
};
292292
@@ -374,8 +374,8 @@ Symfony provides the following env var processors:
374374
use Symfony\Component\DependencyInjection\ContainerBuilder;
375375
use Symfony\Config\FrameworkConfig;
376376
377-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
378-
$container->setParameter('env(TRUSTED_HOSTS)', '10.0.0.1,10.0.0.2');
377+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
378+
$containerBuilder->setParameter('env(TRUSTED_HOSTS)', '10.0.0.1,10.0.0.2');
379379
$framework->trustedHosts(env('TRUSTED_HOSTS')->csv());
380380
};
381381

‎configuration/using_parameters_in_dic.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,9 @@ And set it in the constructor of ``Configuration`` via the ``Extension`` class::
138138
{
139139
// ...
140140

141-
public function getConfiguration(array $config, ContainerBuilder $container)
141+
public function getConfiguration(array $config, ContainerBuilder $containerBuilder)
142142
{
143-
return new Configuration($container->getParameter('kernel.debug'));
143+
return new Configuration($containerBuilder->getParameter('kernel.debug'));
144144
}
145145
}
146146

‎event_dispatcher.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -341,9 +341,9 @@ compiler pass ``AddEventAliasesPass``::
341341

342342
class Kernel extends BaseKernel
343343
{
344-
protected function build(ContainerBuilder $container)
344+
protected function build(ContainerBuilder $containerBuilder)
345345
{
346-
$container->addCompilerPass(new AddEventAliasesPass([
346+
$containerBuilder->addCompilerPass(new AddEventAliasesPass([
347347
MyCustomEvent::class => 'my_custom_event',
348348
]));
349349
}

‎security.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1538,7 +1538,7 @@ and set the ``limiter`` option to its service ID:
15381538
use Symfony\Config\FrameworkConfig;
15391539
use Symfony\Config\SecurityConfig;
15401540
1541-
return static function (ContainerBuilder $container, FrameworkConfig $framework, SecurityConfig $security) {
1541+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework, SecurityConfig $security) {
15421542
$framework->rateLimiter()
15431543
->limiter('username_ip_login')
15441544
->policy('token_bucket')
@@ -1554,7 +1554,7 @@ and set the ``limiter`` option to its service ID:
15541554
->interval('15 minutes')
15551555
;
15561556
1557-
$container->register('app.login_rate_limiter', DefaultLoginRateLimiter::class)
1557+
$containerBuilder->register('app.login_rate_limiter', DefaultLoginRateLimiter::class)
15581558
->setArguments([
15591559
// 1st argument is the limiter for IP
15601560
new Reference('limiter.ip_login'),

‎security/access_control.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ Take the following ``access_control`` entries as an example:
9191
use Symfony\Component\DependencyInjection\ContainerBuilder;
9292
use Symfony\Config\SecurityConfig;
9393
94-
return static function (ContainerBuilder $container, SecurityConfig $security) {
95-
$container->setParameter('env(TRUSTED_IPS)', '10.0.0.1, 10.0.0.2');
94+
return static function (ContainerBuilder $containerBuilder, SecurityConfig $security) {
95+
$containerBuilder->setParameter('env(TRUSTED_IPS)', '10.0.0.1, 10.0.0.2');
9696
// ...
9797
9898
$security->accessControl()

‎service_container/compiler_passes.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Compiler passes are registered in the ``build()`` method of the application kern
2626

2727
// ...
2828

29-
protected function build(ContainerBuilder $container): void
29+
protected function build(ContainerBuilder $containerBuilder): void
3030
{
31-
$container->addCompilerPass(new CustomPass());
31+
$containerBuilder->addCompilerPass(new CustomPass());
3232
}
3333
}
3434

@@ -54,14 +54,14 @@ and process the services inside the ``process()`` method::
5454

5555
// ...
5656

57-
public function process(ContainerBuilder $container): void
57+
public function process(ContainerBuilder $containerBuilder): void
5858
{
5959
// in this method you can manipulate the service container:
6060
// for example, changing some container service:
61-
$container->getDefinition('app.some_private_service')->setPublic(true);
61+
$containerBuilder->getDefinition('app.some_private_service')->setPublic(true);
6262

6363
// or processing tagged services:
64-
foreach ($container->findTaggedServiceIds('some_tag') as $id => $tags) {
64+
foreach ($containerBuilder->findTaggedServiceIds('some_tag') as $id => $tags) {
6565
// ...
6666
}
6767
}
@@ -83,11 +83,11 @@ method in the extension)::
8383

8484
class MyBundle extends Bundle
8585
{
86-
public function build(ContainerBuilder $container): void
86+
public function build(ContainerBuilder $containerBuilder): void
8787
{
88-
parent::build($container);
88+
parent::build($containerBuilder);
8989

90-
$container->addCompilerPass(new CustomPass());
90+
$containerBuilder->addCompilerPass(new CustomPass());
9191
}
9292
}
9393

0 commit comments

Comments
 (0)
0