Skip to content

Commit d1ea043

Browse files
OskarStarkOskarStark
committed
Merge branch '5.4' into 6.2
* 5.4: Use "$container" consistently
2 parents d39b2f5 + f92acdb commit d1ea043

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+369
-369
lines changed

‎.doctor-rst.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ rules:
22
american_english: ~
33
argument_variable_must_match_type:
44
arguments:
5-
- { type: 'ContainerBuilder', name: 'containerBuilder' }
6-
- { type: 'ContainerConfigurator', name: 'containerConfigurator' }
5+
- { type: 'ContainerBuilder', name: 'container' }
6+
- { type: 'ContainerConfigurator', name: 'container' }
77
avoid_repetetive_words: ~
88
blank_line_after_anchor: ~
99
blank_line_after_directive: ~

‎bundles/best_practices.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -436,8 +436,8 @@ The end user can provide values in any configuration file:
436436
// config/services.php
437437
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
438438
439-
return static function (ContainerConfigurator $containerConfigurator) {
440-
$containerConfigurator->parameters()
439+
return static function (ContainerConfigurator $container) {
440+
$container->parameters()
441441
->set('acme_blog.author.email', '[email protected]')
442442
;
443443
};

‎bundles/configuration.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ force validation (e.g. if an additional option was passed, an exception will be
217217
thrown)::
218218

219219
// src/Acme/SocialBundle/DependencyInjection/AcmeSocialExtension.php
220-
public function load(array $configs, ContainerBuilder $containerBuilder)
220+
public function load(array $configs, ContainerBuilder $container)
221221
{
222222
$configuration = new Configuration();
223223

@@ -259,15 +259,15 @@ In your extension, you can load this and dynamically set its arguments::
259259
use Symfony\Component\Config\FileLocator;
260260
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
261261

262-
public function load(array $configs, ContainerBuilder $containerBuilder)
262+
public function load(array $configs, ContainerBuilder $container)
263263
{
264-
$loader = new XmlFileLoader($containerBuilder, new FileLocator(dirname(__DIR__).'/Resources/config'));
264+
$loader = new XmlFileLoader($container, new FileLocator(dirname(__DIR__).'/Resources/config'));
265265
$loader->load('services.xml');
266266

267267
$configuration = new Configuration();
268268
$config = $this->processConfiguration($configuration, $configs);
269269

270-
$definition = $containerBuilder->getDefinition('acme.social.twitter_client');
270+
$definition = $container->getDefinition('acme.social.twitter_client');
271271
$definition->replaceArgument(0, $config['twitter']['client_id']);
272272
$definition->replaceArgument(1, $config['twitter']['client_secret']);
273273
}
@@ -288,7 +288,7 @@ In your extension, you can load this and dynamically set its arguments::
288288
class AcmeHelloExtension extends ConfigurableExtension
289289
{
290290
// note that this method is called loadInternal and not load
291-
protected function loadInternal(array $mergedConfig, ContainerBuilder $containerBuilder)
291+
protected function loadInternal(array $mergedConfig, ContainerBuilder $container)
292292
{
293293
// ...
294294
}
@@ -304,7 +304,7 @@ In your extension, you can load this and dynamically set its arguments::
304304
(e.g. by overriding configurations and using :phpfunction:`isset` to check
305305
for the existence of a value). Be aware that it'll be very hard to support XML::
306306

307-
public function load(array $configs, ContainerBuilder $containerBuilder)
307+
public function load(array $configs, ContainerBuilder $container)
308308
{
309309
$config = [];
310310
// let resources override the previous set value

‎bundles/extension.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This is how the extension of an AcmeHelloBundle should look like::
3434

3535
class AcmeHelloExtension extends Extension
3636
{
37-
public function load(array $configs, ContainerBuilder $containerBuilder)
37+
public function load(array $configs, ContainerBuilder $container)
3838
{
3939
// ... you'll load the files here later
4040
}
@@ -90,10 +90,10 @@ For instance, assume you have a file called ``services.xml`` in the
9090
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
9191

9292
// ...
93-
public function load(array $configs, ContainerBuilder $containerBuilder)
93+
public function load(array $configs, ContainerBuilder $container)
9494
{
9595
$loader = new XmlFileLoader(
96-
$containerBuilder,
96+
$container,
9797
new FileLocator(__DIR__.'/../../config')
9898
);
9999
$loader->load('services.xml');
@@ -167,7 +167,7 @@ they are compiled when generating the application cache to improve the overall
167167
performance. Define the list of annotated classes to compile in the
168168
``addAnnotatedClassesToCompile()`` method::
169169

170-
public function load(array $configs, ContainerBuilder $containerBuilder)
170+
public function load(array $configs, ContainerBuilder $container)
171171
{
172172
// ...
173173

‎bundles/prepend_extension.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To give an Extension the power to do this, it needs to implement
3131
{
3232
// ...
3333

34-
public function prepend(ContainerBuilder $containerBuilder)
34+
public function prepend(ContainerBuilder $container)
3535
{
3636
// ...
3737
}
@@ -52,37 +52,37 @@ a configuration setting in multiple bundles as well as disable a flag in multipl
5252
in case a specific other bundle is not registered::
5353

5454
// src/Acme/HelloBundle/DependencyInjection/AcmeHelloExtension.php
55-
public function prepend(ContainerBuilder $containerBuilder)
55+
public function prepend(ContainerBuilder $container)
5656
{
5757
// get all bundles
58-
$bundles = $containerBuilder->getParameter('kernel.bundles');
58+
$bundles = $container->getParameter('kernel.bundles');
5959
// determine if AcmeGoodbyeBundle is registered
6060
if (!isset($bundles['AcmeGoodbyeBundle'])) {
6161
// disable AcmeGoodbyeBundle in bundles
6262
$config = ['use_acme_goodbye' => false];
63-
foreach ($containerBuilder->getExtensions() as $name => $extension) {
63+
foreach ($container->getExtensions() as $name => $extension) {
6464
match ($name) {
6565
// set use_acme_goodbye to false in the config of
6666
// acme_something and acme_other
6767
//
6868
// note that if the user manually configured
6969
// use_acme_goodbye to true in config/services.yaml
7070
// then the setting would in the end be true and not false
71-
'acme_something', 'acme_other' => $containerBuilder->prependExtensionConfig($name, $config),
71+
'acme_something', 'acme_other' => $container->prependExtensionConfig($name, $config),
7272
default => null
7373
};
7474
}
7575
}
7676

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

8080
// iterate in reverse to preserve the original order after prepending the config
8181
foreach (array_reverse($configs) as $config) {
8282
// check if entity_manager_name is set in the "acme_hello" configuration
8383
if (isset($config['entity_manager_name'])) {
8484
// prepend the acme_something settings with the entity_manager_name
85-
$containerBuilder->prependExtensionConfig('acme_something', [
85+
$container->prependExtensionConfig('acme_something', [
8686
'entity_manager_name' => $config['entity_manager_name'],
8787
]);
8888
}
@@ -139,13 +139,13 @@ registered and the ``entity_manager_name`` setting for ``acme_hello`` is set to
139139
// config/packages/acme_something.php
140140
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
141141
142-
return static function (ContainerConfigurator $containerConfigurator) {
143-
$containerConfigurator->extension('acme_something', [
142+
return static function (ContainerConfigurator $container) {
143+
$container->extension('acme_something', [
144144
// ...
145145
'use_acme_goodbye' => false,
146146
'entity_manager_name' => 'non_default',
147147
]);
148-
$containerConfigurator->extension('acme_other', [
148+
$container->extension('acme_other', [
149149
// ...
150150
'use_acme_goodbye' => false,
151151
]);

‎cache.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -363,8 +363,8 @@ with either :class:`Symfony\\Contracts\\Cache\\CacheInterface` or
363363
// config/services.php
364364
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
365365
366-
return function(ContainerConfigurator $containerConfigurator) {
367-
$containerConfigurator->services()
366+
return function(ContainerConfigurator $container) {
367+
$container->services()
368368
// ...
369369
370370
->set('app.cache.adapter.redis')
@@ -444,14 +444,14 @@ and use that when configuring the pool.
444444
use Symfony\Component\DependencyInjection\ContainerBuilder;
445445
use Symfony\Config\FrameworkConfig;
446446
447-
return static function (ContainerBuilder $containerBuilder, FrameworkConfig $framework) {
447+
return static function (ContainerBuilder $container, FrameworkConfig $framework) {
448448
$framework->cache()
449449
->pool('cache.my_redis')
450450
->adapters(['cache.adapter.redis'])
451451
->provider('app.my_custom_redis_provider');
452452
453453
454-
$containerBuilder->register('app.my_custom_redis_provider', \Redis::class)
454+
$container->register('app.my_custom_redis_provider', \Redis::class)
455455
->setFactory([RedisAdapter::class, 'createConnection'])
456456
->addArgument('redis://localhost')
457457
->addArgument([

‎components/dependency_injection.rst

+26-26
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ You can register this in the container as a service::
4545

4646
use Symfony\Component\DependencyInjection\ContainerBuilder;
4747

48-
$containerBuilder = new ContainerBuilder();
49-
$containerBuilder->register('mailer', 'Mailer');
48+
$container = new ContainerBuilder();
49+
$container->register('mailer', 'Mailer');
5050

5151
An improvement to the class to make it more flexible would be to allow
5252
the container to set the ``transport`` used. If you change the class
@@ -66,8 +66,8 @@ Then you can set the choice of transport in the container::
6666

6767
use Symfony\Component\DependencyInjection\ContainerBuilder;
6868

69-
$containerBuilder = new ContainerBuilder();
70-
$containerBuilder
69+
$container = new ContainerBuilder();
70+
$container
7171
->register('mailer', 'Mailer')
7272
->addArgument('sendmail');
7373

@@ -81,9 +81,9 @@ the ``Mailer`` service's constructor argument::
8181

8282
use Symfony\Component\DependencyInjection\ContainerBuilder;
8383

84-
$containerBuilder = new ContainerBuilder();
85-
$containerBuilder->setParameter('mailer.transport', 'sendmail');
86-
$containerBuilder
84+
$container = new ContainerBuilder();
85+
$container->setParameter('mailer.transport', 'sendmail');
86+
$container
8787
->register('mailer', 'Mailer')
8888
->addArgument('%mailer.transport%');
8989

@@ -108,14 +108,14 @@ not exist yet. Use the ``Reference`` class to tell the container to inject the
108108
use Symfony\Component\DependencyInjection\ContainerBuilder;
109109
use Symfony\Component\DependencyInjection\Reference;
110110

111-
$containerBuilder = new ContainerBuilder();
111+
$container = new ContainerBuilder();
112112

113-
$containerBuilder->setParameter('mailer.transport', 'sendmail');
114-
$containerBuilder
113+
$container->setParameter('mailer.transport', 'sendmail');
114+
$container
115115
->register('mailer', 'Mailer')
116116
->addArgument('%mailer.transport%');
117117

118-
$containerBuilder
118+
$container
119119
->register('newsletter_manager', 'NewsletterManager')
120120
->addArgument(new Reference('mailer'));
121121

@@ -140,14 +140,14 @@ If you do want to though then the container can call the setter method::
140140
use Symfony\Component\DependencyInjection\ContainerBuilder;
141141
use Symfony\Component\DependencyInjection\Reference;
142142

143-
$containerBuilder = new ContainerBuilder();
143+
$container = new ContainerBuilder();
144144

145-
$containerBuilder->setParameter('mailer.transport', 'sendmail');
146-
$containerBuilder
145+
$container->setParameter('mailer.transport', 'sendmail');
146+
$container
147147
->register('mailer', 'Mailer')
148148
->addArgument('%mailer.transport%');
149149

150-
$containerBuilder
150+
$container
151151
->register('newsletter_manager', 'NewsletterManager')
152152
->addMethodCall('setMailer', [new Reference('mailer')]);
153153

@@ -156,11 +156,11 @@ like this::
156156

157157
use Symfony\Component\DependencyInjection\ContainerBuilder;
158158

159-
$containerBuilder = new ContainerBuilder();
159+
$container = new ContainerBuilder();
160160

161161
// ...
162162

163-
$newsletterManager = $containerBuilder->get('newsletter_manager');
163+
$newsletterManager = $container->get('newsletter_manager');
164164

165165
Getting Services That Don't Exist
166166
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -224,8 +224,8 @@ Loading an XML config file::
224224
use Symfony\Component\DependencyInjection\ContainerBuilder;
225225
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
226226

227-
$containerBuilder = new ContainerBuilder();
228-
$loader = new XmlFileLoader($containerBuilder, new FileLocator(__DIR__));
227+
$container = new ContainerBuilder();
228+
$loader = new XmlFileLoader($container, new FileLocator(__DIR__));
229229
$loader->load('services.xml');
230230

231231
Loading a YAML config file::
@@ -234,8 +234,8 @@ Loading a YAML config file::
234234
use Symfony\Component\DependencyInjection\ContainerBuilder;
235235
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
236236

237-
$containerBuilder = new ContainerBuilder();
238-
$loader = new YamlFileLoader($containerBuilder, new FileLocator(__DIR__));
237+
$container = new ContainerBuilder();
238+
$loader = new YamlFileLoader($container, new FileLocator(__DIR__));
239239
$loader->load('services.yaml');
240240

241241
.. note::
@@ -259,8 +259,8 @@ into a separate config file and load it in a similar way::
259259
use Symfony\Component\DependencyInjection\ContainerBuilder;
260260
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
261261

262-
$containerBuilder = new ContainerBuilder();
263-
$loader = new PhpFileLoader($containerBuilder, new FileLocator(__DIR__));
262+
$container = new ContainerBuilder();
263+
$loader = new PhpFileLoader($container, new FileLocator(__DIR__));
264264
$loader->load('services.php');
265265

266266
You can now set up the ``newsletter_manager`` and ``mailer`` services using
@@ -313,13 +313,13 @@ config files:
313313
314314
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
315315
316-
return static function (ContainerConfigurator $containerConfigurator) {
317-
$containerConfigurator->parameters()
316+
return static function (ContainerConfigurator $container) {
317+
$container->parameters()
318318
// ...
319319
->set('mailer.transport', 'sendmail')
320320
;
321321
322-
$services = $containerConfigurator->services();
322+
$services = $container->services();
323323
$services->set('mailer', 'Mailer')
324324
->args(['%mailer.transport%'])
325325
;

‎components/dependency_injection/_imports-parameters-note.rst.inc

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@
3131
// config/services.php
3232
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
3333

34-
return static function (ContainerConfigurator $containerConfigurator) {
35-
$containerConfigurator->import('%kernel.project_dir%/somefile.yaml');
34+
return static function (ContainerConfigurator $container) {
35+
$container->import('%kernel.project_dir%/somefile.yaml');
3636
};

0 commit comments

Comments
 (0)