Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ae687ab

Browse files
javiereguiluzjaviereguiluz
committed
minor #17683 Standardize the name of the container builder variable 5.4 (alamirault)
This PR was merged into the 5.4 branch. Discussion ---------- Standardize the name of the container builder variable 5.4 Like `ContainerConfigurator $containerConfigurator`, use always `ContainerBuilder $containerBuilder`. I think `$container` can be confusing Commits ------- 745f9db Standardize the name of the container builder variable 5.4
2 parents 5790b77 + 745f9db commit ae687ab

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
}
@@ -93,10 +93,10 @@ For instance, assume you have a file called ``services.xml`` in the
9393
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
9494

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

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

‎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,15 +56,15 @@ 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
switch ($name) {
6969
case 'acme_something':
7070
case 'acme_other':
@@ -74,21 +74,21 @@ in case a specific other bundle is not registered::
7474
// note that if the user manually configured
7575
// use_acme_goodbye to true in config/services.yaml
7676
// then the setting would in the end be true and not false
77-
$container->prependExtensionConfig($name, $config);
77+
$containerBuilder->prependExtensionConfig($name, $config);
7878
break;
7979
}
8080
}
8181
}
8282

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

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

‎cache.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -468,14 +468,14 @@ and use that when configuring the pool.
468468
use Symfony\Component\DependencyInjection\ContainerBuilder;
469469
use Symfony\Config\FrameworkConfig;
470470
471-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
471+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
472472
$framework->cache()
473473
->pool('cache.my_redis')
474474
->adapters(['cache.adapter.redis'])
475475
->provider('app.my_custom_redis_provider');
476476
477477
478-
$container->register('app.my_custom_redis_provider', \Redis::class)
478+
$containerBuilder->register('app.my_custom_redis_provider', \Redis::class)
479479
->setFactory([RedisAdapter::class, 'createConnection'])
480480
->addArgument('redis://localhost')
481481
->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
@@ -107,8 +107,8 @@ Symfony provides the following env var processors:
107107
use Symfony\Component\DependencyInjection\ContainerBuilder;
108108
use Symfony\Config\FrameworkConfig;
109109
110-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
111-
$container->setParameter('env(SECRET)', 'some_secret');
110+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
111+
$containerBuilder->setParameter('env(SECRET)', 'some_secret');
112112
$framework->secret(env('SECRET')->string());
113113
};
114114
@@ -153,8 +153,8 @@ Symfony provides the following env var processors:
153153
use Symfony\Component\DependencyInjection\ContainerBuilder;
154154
use Symfony\Config\FrameworkConfig;
155155
156-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
157-
$container->setParameter('env(HTTP_METHOD_OVERRIDE)', 'true');
156+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
157+
$containerBuilder->setParameter('env(HTTP_METHOD_OVERRIDE)', 'true');
158158
$framework->httpMethodOverride(env('HTTP_METHOD_OVERRIDE')->bool());
159159
};
160160
@@ -245,8 +245,8 @@ Symfony provides the following env var processors:
245245
use Symfony\Component\DependencyInjection\ContainerBuilder;
246246
use Symfony\Config\SecurityConfig;
247247
248-
return static function (ContainerBuilder $container, SecurityConfig $security) {
249-
$container->setParameter('env(HEALTH_CHECK_METHOD)', 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD');
248+
return static function (ContainerBuilder $containerBuilder, SecurityConfig $security) {
249+
$containerBuilder->setParameter('env(HEALTH_CHECK_METHOD)', 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD');
250250
$security->accessControl()
251251
->path('^/health-check$')
252252
->methods([env('HEALTH_CHECK_METHOD')->const()]);
@@ -296,8 +296,8 @@ Symfony provides the following env var processors:
296296
use Symfony\Component\DependencyInjection\ContainerBuilder;
297297
use Symfony\Config\FrameworkConfig;
298298
299-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
300-
$container->setParameter('env(TRUSTED_HOSTS)', '["10.0.0.1", "10.0.0.2"]');
299+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
300+
$containerBuilder->setParameter('env(TRUSTED_HOSTS)', '["10.0.0.1", "10.0.0.2"]');
301301
$framework->trustedHosts(env('TRUSTED_HOSTS')->json());
302302
};
303303
@@ -385,8 +385,8 @@ Symfony provides the following env var processors:
385385
use Symfony\Component\DependencyInjection\ContainerBuilder;
386386
use Symfony\Config\FrameworkConfig;
387387
388-
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
389-
$container->setParameter('env(TRUSTED_HOSTS)', '10.0.0.1,10.0.0.2');
388+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
389+
$containerBuilder->setParameter('env(TRUSTED_HOSTS)', '10.0.0.1,10.0.0.2');
390390
$framework->trustedHosts(env('TRUSTED_HOSTS')->csv());
391391
};
392392

‎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
@@ -343,9 +343,9 @@ compiler pass ``AddEventAliasesPass``::
343343

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

‎security.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1586,7 +1586,7 @@ and set the ``limiter`` option to its service ID:
15861586
use Symfony\Config\FrameworkConfig;
15871587
use Symfony\Config\SecurityConfig;
15881588
1589-
return static function (ContainerBuilder $container, FrameworkConfig $framework, SecurityConfig $security) {
1589+
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework, SecurityConfig $security) {
15901590
$framework->rateLimiter()
15911591
->limiter('username_ip_login')
15921592
->policy('token_bucket')
@@ -1602,7 +1602,7 @@ and set the ``limiter`` option to its service ID:
16021602
->interval('15 minutes')
16031603
;
16041604
1605-
$container->register('app.login_rate_limiter', DefaultLoginRateLimiter::class)
1605+
$containerBuilder->register('app.login_rate_limiter', DefaultLoginRateLimiter::class)
16061606
->setArguments([
16071607
// 1st argument is the limiter for IP
16081608
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)