Skip to content

Standardize the name of the container configurator variable #17664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 6, 2023
Merged

Standardize the name of the container configurator variable #17664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions bundles/best_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,8 +442,8 @@ The end user can provide values in any configuration file:
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->parameters()
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->parameters()
->set('acme_blog.author.email', '[email protected]')
;
};
Expand Down
6 changes: 3 additions & 3 deletions bundles/prepend_extension.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,13 @@ registered and the ``entity_manager_name`` setting for ``acme_hello`` is set to
// config/packages/acme_something.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->extension('acme_something', [
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->extension('acme_something', [
// ...
'use_acme_goodbye' => false,
'entity_manager_name' => 'non_default',
]);
$container->extension('acme_other', [
$containerConfigurator->extension('acme_other', [
// ...
'use_acme_goodbye' => false,
]);
Expand Down
4 changes: 2 additions & 2 deletions cache.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,8 +387,8 @@ with either :class:`Symfony\\Contracts\\Cache\\CacheInterface` or
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return function(ContainerConfigurator $configurator) {
$configurator->services()
return function(ContainerConfigurator $containerConfigurator) {
$containerConfigurator->services()
// ...

->set('app.cache.adapter.redis')
Expand Down
6 changes: 3 additions & 3 deletions components/dependency_injection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,13 +291,13 @@ config files:

namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->parameters()
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->parameters()
// ...
->set('mailer.transport', 'sendmail')
;

$services = $container->services();
$services = $containerConfigurator->services();
$services->set('mailer', 'Mailer')
->args(['%mailer.transport%'])
;
Expand Down
4 changes: 2 additions & 2 deletions components/dependency_injection/_imports-parameters-note.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->import('%kernel.project_dir%/somefile.yaml');
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->import('%kernel.project_dir%/somefile.yaml');
};
4 changes: 2 additions & 2 deletions components/http_foundation/session_configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,8 @@ configuration:
// config/packages/framework.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->extension('framework', [
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->extension('framework', [
'session' => [
'gc_probability' => null,
],
Expand Down
4 changes: 2 additions & 2 deletions components/serializer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -998,8 +998,8 @@ faster alternative to the

use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer;

return static function (ContainerConfigurator $container) {
$container->services()
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->services()
// ...
->set('get_set_method_normalizer', GetSetMethodNormalizer::class)
->tag('serializer.normalizer')
Expand Down
2 changes: 1 addition & 1 deletion components/uid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ configuration in your application before using these commands:
use Symfony\Component\Uid\Command\InspectUlidCommand;
use Symfony\Component\Uid\Command\InspectUuidCommand;

return static function (ContainerConfigurator $configurator): void {
return static function (ContainerConfigurator $containerConfigurator): void {
// ...

$services
Expand Down
4 changes: 2 additions & 2 deletions components/var_dumper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ the :ref:`dump_destination option <configuration-debug-dump_destination>` of the
// config/packages/debug.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->extension('debug', [
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->extension('debug', [
'dump_destination' => 'tcp://%env(VAR_DUMPER_SERVER)%',
]);
};
Expand Down
52 changes: 26 additions & 26 deletions configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,18 +78,18 @@ shown in these three formats.
{
// ...

private function configureContainer(ContainerConfigurator $container): void
private function configureContainer(ContainerConfigurator $containerConfigurator): void
{
$configDir = $this->getConfigDir();

$container->import($configDir.'/{packages}/*.{yaml,php}');
$container->import($configDir.'/{packages}/'.$this->environment.'/*.{yaml,php}');
$containerConfigurator->import($configDir.'/{packages}/*.{yaml,php}');
$containerConfigurator->import($configDir.'/{packages}/'.$this->environment.'/*.{yaml,php}');

if (is_file($configDir.'/services.yaml')) {
$container->import($configDir.'/services.yaml');
$container->import($configDir.'/{services}_'.$this->environment.'.yaml');
$containerConfigurator->import($configDir.'/services.yaml');
$containerConfigurator->import($configDir.'/{services}_'.$this->environment.'.yaml');
} else {
$container->import($configDir.'/{services}.php');
$containerConfigurator->import($configDir.'/{services}.php');
}
}
}
Expand Down Expand Up @@ -163,17 +163,17 @@ configuration files, even if they use a different format:
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->import('legacy_config.php');
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->import('legacy_config.php');

// glob expressions are also supported to load multiple files
$container->import('/etc/myapp/*.yaml');
$containerConfigurator->import('/etc/myapp/*.yaml');

// the third optional argument of import() is 'ignore_errors'
// 'ignore_errors' set to 'not_found' silently discards errors if the loaded file doesn't exist
$container->import('my_config_file.yaml', null, 'not_found');
$containerConfigurator->import('my_config_file.yaml', null, 'not_found');
// 'ignore_errors' set to true silently discards all errors (including invalid code and not found)
$container->import('my_config_file.yaml', null, true);
$containerConfigurator->import('my_config_file.yaml', null, true);
};

// ...
Expand Down Expand Up @@ -262,8 +262,8 @@ reusable configuration value. By convention, parameters are defined under the

use App\Entity\BlogPost;

return static function (ContainerConfigurator $container) {
$container->parameters()
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->parameters()
// the parameter name is an arbitrary string (the 'app.' prefix is recommended
// to better differentiate your parameters from Symfony parameters).
->set('app.admin_email', '[email protected]')
Expand Down Expand Up @@ -334,8 +334,8 @@ configuration file using a special syntax: wrap the parameter name in two ``%``
// config/packages/some_package.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->extension('some_package', [
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->extension('some_package', [
// any string surrounded by two % is replaced by that parameter value
'email_address' => '%app.admin_email%',

Expand Down Expand Up @@ -371,8 +371,8 @@ configuration file using a special syntax: wrap the parameter name in two ``%``
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->parameters()
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->parameters()
->set('url_pattern', 'http://symfony.com/?foo=%%s&amp;bar=%%d');
};

Expand Down Expand Up @@ -508,20 +508,20 @@ files directly in the ``config/packages/`` directory.
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Config\WebpackEncoreConfig;

return static function (WebpackEncoreConfig $webpackEncore, ContainerConfigurator $container) {
return static function (WebpackEncoreConfig $webpackEncore, ContainerConfigurator $containerConfigurator) {
$webpackEncore
->outputPath('%kernel.project_dir%/public/build')
->strictMode(true)
->cache(false)
;

// cache is enabled only in the "prod" environment
if ('prod' === $container->env()) {
if ('prod' === $containerConfigurator->env()) {
$webpackEncore->cache(true);
}

// disable strict mode only in the "test" environment
if ('test' === $container->env()) {
if ('test' === $containerConfigurator->env()) {
$webpackEncore->strictMode(false);
}
};
Expand Down Expand Up @@ -642,8 +642,8 @@ This example shows how you could configure the database connection using an env
// config/packages/doctrine.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

return static function (ContainerConfigurator $container) {
$container->extension('doctrine', [
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->extension('doctrine', [
'dbal' => [
// by convention the env var names are always uppercase
'url' => env('DATABASE_URL')->resolve(),
Expand Down Expand Up @@ -991,8 +991,8 @@ doesn't work for parameters:

use App\Service\MessageGenerator;

return static function (ContainerConfigurator $container) {
$container->parameters()
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->parameters()
->set('app.contents_dir', '...');

$container->services()
Expand Down Expand Up @@ -1048,8 +1048,8 @@ whenever a service/controller defines a ``$projectDir`` argument, use this:

use App\Controller\LuckyController;

return static function (ContainerConfigurator $container) {
$container->services()
return static function (ContainerConfigurator $containerConfigurator) {
$containerConfigurator->services()
->defaults()
// pass this value to any $projectDir argument for any service
// that's created in this file (including controller arguments)
Expand Down
14 changes: 7 additions & 7 deletions configuration/micro_kernel_trait.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ Next, create an ``index.php`` file that defines the kernel class and runs it::
];
}

protected function configureContainer(ContainerConfigurator $c): void
protected function configureContainer(ContainerConfigurator $containerConfigurator): void
{
// PHP equivalent of config/packages/framework.yaml
$c->extension('framework', [
$containerConfigurator->extension('framework', [
'secret' => 'S0ME_SECRET'
]);
}
Expand Down Expand Up @@ -88,7 +88,7 @@ that define your bundles, your services and your routes:
**registerBundles()**
This is the same ``registerBundles()`` that you see in a normal kernel.

**configureContainer(ContainerConfigurator $c)**
**configureContainer(ContainerConfigurator $containerConfigurator)**
This method builds and configures the container. In practice, you will use
``extension()`` to configure different bundles (this is the equivalent
of what you see in a normal ``config/packages/*`` file). You can also register
Expand Down Expand Up @@ -191,20 +191,20 @@ hold the kernel. Now it looks like this::
return $bundles;
}

protected function configureContainer(ContainerConfigurator $c): void
protected function configureContainer(ContainerConfigurator $containerConfigurator): void
{
$c->import(__DIR__.'/../config/framework.yaml');
$containerConfigurator->import(__DIR__.'/../config/framework.yaml');

// register all classes in /src/ as service
$c->services()
$containerConfigurator->services()
->load('App\\', __DIR__.'/*')
->autowire()
->autoconfigure()
;

// configure WebProfilerBundle only if the bundle is enabled
if (isset($this->bundles['WebProfilerBundle'])) {
$c->extension('web_profiler', [
$containerConfigurator->extension('web_profiler', [
'toolbar' => true,
'intercept_redirects' => false,
]);
Expand Down
12 changes: 6 additions & 6 deletions configuration/multiple_kernels.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,16 @@ files so they don't collide with the files from ``src/Kernel.php``::
return $this->getProjectDir().'/var/log/api';
}

protected function configureContainer(ContainerConfigurator $container): void
protected function configureContainer(ContainerConfigurator $containerConfigurator): void
{
$container->import('../config/api/{packages}/*.yaml');
$container->import('../config/api/{packages}/'.$this->environment.'/*.yaml');
$containerConfigurator->import('../config/api/{packages}/*.yaml');
$containerConfigurator->import('../config/api/{packages}/'.$this->environment.'/*.yaml');

if (is_file(\dirname(__DIR__).'/config/api/services.yaml')) {
$container->import('../config/api/services.yaml');
$container->import('../config/api/{services}_'.$this->environment.'.yaml');
$containerConfigurator->import('../config/api/services.yaml');
$containerConfigurator->import('../config/api/{services}_'.$this->environment.'.yaml');
} else {
$container->import('../config/api/{services}.php');
$containerConfigurator->import('../config/api/{services}.php');
}
}

Expand Down
4 changes: 2 additions & 2 deletions controller/argument_value_resolver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ and adding a priority.

use App\ArgumentResolver\UserValueResolver;

return static function (ContainerConfigurator $container) {
$services = $configurator->services();
Comment on lines -236 to -237
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found some places where variables does not match, $container injected but $configurator used.

return static function (ContainerConfigurator $containerConfigurator) {
$services = $containerConfigurator->services();

$services->set(UserValueResolver::class)
->tag('controller.argument_value_resolver', ['priority' => 50])
Expand Down
4 changes: 2 additions & 2 deletions controller/upload_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,8 @@ Then, define a service for this class:

use App\Service\FileUploader;

return static function (ContainerConfigurator $container) {
$services = $configurator->services();
return static function (ContainerConfigurator $containerConfigurator) {
$services = $containerConfigurator->services();

$services->set(FileUploader::class)
->arg('$targetDirectory', '%brochures_directory%')
Expand Down
12 changes: 6 additions & 6 deletions doctrine/events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,8 @@ with the ``doctrine.event_listener`` tag:

use App\EventListener\SearchIndexer;

return static function (ContainerConfigurator $configurator) {
$services = $configurator->services();
return static function (ContainerConfigurator $containerConfigurator) {
$services = $containerConfigurator->services();

// listeners are applied by default to all Doctrine connections
$services->set(SearchIndexer::class)
Expand Down Expand Up @@ -360,8 +360,8 @@ with the ``doctrine.orm.entity_listener`` tag:
use App\Entity\User;
use App\EventListener\UserChangedNotifier;

return static function (ContainerConfigurator $container) {
$services = $configurator->services();
return static function (ContainerConfigurator $containerConfigurator) {
$services = $containerConfigurator->services();

$services->set(UserChangedNotifier::class)
->tag('doctrine.orm.entity_listener', [
Expand Down Expand Up @@ -501,8 +501,8 @@ Doctrine connection to use) you must do that in the manual service configuration

use App\EventListener\DatabaseActivitySubscriber;

return static function (ContainerConfigurator $container) {
$services = $configurator->services();
return static function (ContainerConfigurator $containerConfigurator) {
$services = $containerConfigurator->services();

$services->set(DatabaseActivitySubscriber::class)
->tag('doctrine.event_subscriber'[
Expand Down
4 changes: 2 additions & 2 deletions event_dispatcher.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ using a special "tag":

use App\EventListener\ExceptionListener;

return function(ContainerConfigurator $configurator) {
$services = $configurator->services();
return function(ContainerConfigurator $containerConfigurator) {
$services = $containerConfigurator->services();

$services->set(ExceptionListener::class)
->tag('kernel.event_listener', ['event' => 'kernel.exception'])
Expand Down
4 changes: 2 additions & 2 deletions frontend/custom_version_strategy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,8 @@ After creating the strategy PHP class, register it as a Symfony service.
use App\Asset\VersionStrategy\GulpBusterVersionStrategy;
use Symfony\Component\DependencyInjection\Definition;

return function(ContainerConfigurator $configurator) {
$services = $configurator->services();
return function(ContainerConfigurator $containerConfigurator) {
$services = $containerConfigurator->services();

$services->set(GulpBusterVersionStrategy::class)
->args(
Expand Down
Loading