Skip to content

[DependencyInjection] Add custom container configurators #25650

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.

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions src/Symfony/Component/DependencyInjection/ContainerBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
use Symfony\Component\Config\Resource\ClassExistenceResource;
Expand Down Expand Up @@ -123,6 +124,11 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
private $removedIds = array();
private $alreadyLoading = array();

/**
* @var callable[] configurator class name => callable
*/
private $customConfiguratorFactories;

public function __construct(ParameterBagInterface $parameterBag = null)
{
parent::__construct($parameterBag);
Expand Down Expand Up @@ -222,6 +228,38 @@ public function hasExtension($name)
return isset($this->extensions[$name]) || isset($this->extensionsByNs[$name]);
}

/**
* @param string $configuratorClassName
* @param callable $factory function (ContainerConfigurator $c) { .... }
*/
public function registerCustomConfiguratorFactory(string $configuratorClassName, callable $factory)
{
if (!class_exists($configuratorClassName)) {
throw new \LogicException(sprintf('Container configurator class %s does not exist.', $configuratorClassName));
}

if (isset($this->customConfiguratorFactories[$configuratorClassName])) {
throw new \LogicException(sprintf('Container configurator factory for %s was already registered.', $configuratorClassName));
}

$this->customConfiguratorFactories[$configuratorClassName] = $factory;
}

/**
* @param string $configuratorClassName
* @param ContainerConfigurator $configurator
*
* @return mixed
*/
public function getCustomConfigurator(string $configuratorClassName, ContainerConfigurator $configurator)
{
if (!isset($this->customConfiguratorFactories[$configuratorClassName])) {
throw new \LogicException(sprintf('Container configurator factory for %s does not exist.', $configuratorClassName));
}

return call_user_func($this->customConfiguratorFactories[$configuratorClassName], $configurator);
}

/**
* Returns an array of resources loaded to build this configuration.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,20 @@ public function load($resource, $type = null)
$callback = $load($path);

if ($callback instanceof \Closure) {
$callback(new ContainerConfigurator($this->container, $this, $this->instanceof, $path, $resource), $this->container, $this);
$method = new \ReflectionFunction($callback);

if (0 === $method->getNumberOfParameters()) {
throw new \LogicException('Closure in %s:%d must have at least 1 argument.', $path, $method->getStartLine());
}

$configurator = new ContainerConfigurator($this->container, $this, $this->instanceof, $path, $resource);
$configuratorClass = $method->getParameters()[0]->getClass()->name;

if (ContainerConfigurator::class !== $configuratorClass) {
$configurator = $this->container->getCustomConfigurator($configuratorClass, $configurator);
}

$callback($configurator, $this->container, $this);
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

namespace Symfony\Component\DependencyInjection\Tests\Fixtures;

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

final class FooContainerConfigurator
{
private $configurator;

public function __construct(ContainerConfigurator $configurator)
{
$this->configurator = $configurator;
}

public function foo()
{
$this->configurator->parameters()->set('foo', 'bar');
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

use Symfony\Component\DependencyInjection\Tests\Fixtures\FooContainerConfigurator;

return function (FooContainerConfigurator $c) {
$c->foo();
};
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
use Symfony\Component\DependencyInjection\Dumper\YamlDumper;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\Tests\Fixtures\FooContainerConfigurator;

class PhpFileLoaderTest extends TestCase
{
Expand Down Expand Up @@ -74,6 +76,23 @@ public function provideConfig()
yield array('php7');
}

public function testCustomContainerConfigurator()
{
$container = new ContainerBuilder();
$container->registerCustomConfiguratorFactory(
FooContainerConfigurator::class,
function (ContainerConfigurator $c) {
return new FooContainerConfigurator($c);
}
);

$fixtures = realpath(__DIR__.'/../Fixtures');
$loader = new PhpFileLoader($container, new FileLocator());
$loader->load($fixtures.'/config/custom_configurator.php');

$this->assertEquals('bar', $container->getParameter('foo'));
}

/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
* @expectedExceptionMessage The service "child_service" cannot have a "parent" and also have "autoconfigure". Try disabling autoconfiguration for the service.
Expand Down