[DependencyInjection] Add ContainerBuilder::willBeAvailable() to help with conditional configuration

nicolas-grekas · nicolas-grekas · commit c5b7b217438c · 2021-02-09T17:21:13.000+01:00
diff --git a/src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterUidTypePass.php b/src/Symfony/Bridge/Doctrine/DependencyInjection/CompilerPass/RegisterUidTypePass.php
@@ -24,7 +24,7 @@ final class RegisterUidTypePass implements CompilerPassInterface
      */
     public function process(ContainerBuilder $container)
     {
-        if (!class_exists(AbstractUid::class)) {
+        if (!$container->willBeAvailable('symfony/uid', AbstractUid::class)) {
             return;
         }
 
diff --git a/src/Symfony/Bridge/Doctrine/composer.json b/src/Symfony/Bridge/Doctrine/composer.json
@@ -30,7 +30,7 @@
         "symfony/stopwatch": "^4.4|^5.0",
         "symfony/cache": "^5.1",
         "symfony/config": "^4.4|^5.0",
-        "symfony/dependency-injection": "^4.4|^5.0",
+        "symfony/dependency-injection": "^5.3",
         "symfony/form": "^5.1.3",
         "symfony/http-kernel": "^5.0",
         "symfony/messenger": "^4.4|^5.0",
@@ -54,7 +54,7 @@
     "conflict": {
         "doctrine/dbal": "<2.10",
         "phpunit/phpunit": "<5.4.3",
-        "symfony/dependency-injection": "<4.4",
+        "symfony/dependency-injection": "<5.3",
         "symfony/form": "<5.1",
         "symfony/http-kernel": "<5",
         "symfony/messenger": "<4.4",
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php
@@ -125,7 +125,7 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('security_legacy.php');
         }
 
-        if (class_exists(AbstractExtension::class)) {
+        if ($container->willBeAvailable('twig/twig', AbstractExtension::class)) {
             $loader->load('templating_twig.php');
         }
 
@@ -136,7 +136,7 @@ public function load(array $configs, ContainerBuilder $container)
             $loader->load('security_debug.php');
         }
 
-        if (!class_exists(\Symfony\Component\ExpressionLanguage\ExpressionLanguage::class)) {
+        if (!$container->willBeAvailable('symfony/expression-language', \Symfony\Component\ExpressionLanguage\ExpressionLanguage::class)) {
             $container->removeDefinition('security.expression_language');
             $container->removeDefinition('security.access.expression_voter');
         }
@@ -170,7 +170,7 @@ public function load(array $configs, ContainerBuilder $container)
             $this->createEncoders($config['encoders'], $container);
         }
 
-        if (class_exists(Application::class)) {
+        if ($container->willBeAvailable('symfony/console', Application::class)) {
             $loader->load('console.php');
             $container->getDefinition('security.command.user_password_encoder')->replaceArgument(1, array_keys($config['encoders']));
         }
@@ -844,8 +844,8 @@ private function createExpression(ContainerBuilder $container, string $expressio
             return $this->expressions[$id];
         }
 
-        if (!class_exists(\Symfony\Component\ExpressionLanguage\ExpressionLanguage::class)) {
-            throw new \RuntimeException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');
+        if (!$container->willBeAvailable('symfony/expression-language', \Symfony\Component\ExpressionLanguage\ExpressionLanguage::class)) {
+            throw new \RuntimeException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');
         }
 
         $container
diff --git a/src/Symfony/Bundle/SecurityBundle/composer.json b/src/Symfony/Bundle/SecurityBundle/composer.json
@@ -19,7 +19,7 @@
         "php": ">=7.2.5",
         "ext-xml": "*",
         "symfony/config": "^4.4|^5.0",
-        "symfony/dependency-injection": "^5.2",
+        "symfony/dependency-injection": "^5.3",
         "symfony/deprecation-contracts": "^2.1",
         "symfony/event-dispatcher": "^5.1",
         "symfony/http-kernel": "^5.0",
diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/ExtensionPass.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/Compiler/ExtensionPass.php
@@ -23,19 +23,19 @@ class ExtensionPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)
     {
-        if (!class_exists(\Symfony\Component\Asset\Packages::class)) {
+        if (!$container->willBeAvailable('symfony/asset', \Symfony\Component\Asset\Packages::class)) {
             $container->removeDefinition('twig.extension.assets');
         }
 
-        if (!class_exists(\Symfony\Component\ExpressionLanguage\Expression::class)) {
+        if (!$container->willBeAvailable('symfony/expression-language', \Symfony\Component\ExpressionLanguage\Expression::class)) {
             $container->removeDefinition('twig.extension.expression');
         }
 
-        if (!interface_exists(\Symfony\Component\Routing\Generator\UrlGeneratorInterface::class)) {
+        if (!$container->willBeAvailable('symfony/routing', \Symfony\Component\Routing\Generator\UrlGeneratorInterface::class)) {
             $container->removeDefinition('twig.extension.routing');
         }
 
-        if (!class_exists(\Symfony\Component\Yaml\Yaml::class)) {
+        if (!$container->willBeAvailable('symfony/yaml', \Symfony\Component\Yaml\Yaml::class)) {
             $container->removeDefinition('twig.extension.yaml');
         }
 
@@ -111,7 +111,7 @@ public function process(ContainerBuilder $container)
             $container->getDefinition('twig.extension.expression')->addTag('twig.extension');
         }
 
-        if (!class_exists(Workflow::class) || !$container->has('workflow.registry')) {
+        if (!$container->willBeAvailable('symfony/workflow', Workflow::class) || !$container->has('workflow.registry')) {
             $container->removeDefinition('workflow.twig_extension');
         } else {
             $container->getDefinition('workflow.twig_extension')->addTag('twig.extension');
diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php
@@ -37,19 +37,19 @@ public function load(array $configs, ContainerBuilder $container)
         $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('twig.php');
 
-        if (class_exists(\Symfony\Component\Form\Form::class)) {
+        if ($container->willBeAvailable('symfony/form', \Symfony\Component\Form\Form::class)) {
             $loader->load('form.php');
         }
 
-        if (class_exists(Application::class)) {
+        if ($container->willBeAvailable('symfony/console', Application::class)) {
             $loader->load('console.php');
         }
 
-        if (class_exists(Mailer::class)) {
+        if ($container->willBeAvailable('symfony/mailer', Mailer::class)) {
             $loader->load('mailer.php');
         }
 
-        if (!class_exists(Translator::class)) {
+        if (!$container->willBeAvailable('symfony/translation', Translator::class)) {
             $container->removeDefinition('twig.translation.extractor');
         }
 
diff --git a/src/Symfony/Bundle/TwigBundle/composer.json b/src/Symfony/Bundle/TwigBundle/composer.json
@@ -27,7 +27,7 @@
     "require-dev": {
         "symfony/asset": "^4.4|^5.0",
         "symfony/stopwatch": "^4.4|^5.0",
-        "symfony/dependency-injection": "^5.2",
+        "symfony/dependency-injection": "^5.3",
         "symfony/expression-language": "^4.4|^5.0",
         "symfony/finder": "^4.4|^5.0",
         "symfony/form": "^4.4|^5.0",
@@ -40,7 +40,7 @@
         "doctrine/cache": "~1.0"
     },
     "conflict": {
-        "symfony/dependency-injection": "<5.2",
+        "symfony/dependency-injection": "<5.3",
         "symfony/framework-bundle": "<5.0",
         "symfony/translation": "<5.0"
     },
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `ServicesConfigurator::remove()` in the PHP-DSL
+ * Add `ContainerBuilder::willBeAvailable()` to help with conditional configuration
 
 5.2.0
 -----
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php
@@ -198,7 +198,7 @@ private function getExpressionLanguage(): ExpressionLanguage
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists(ExpressionLanguage::class)) {
-                throw new LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');
+                throw new LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');
             }
 
             $providers = $this->container->getExpressionLanguageProviders();
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\DependencyInjection;
 
+use Composer\InstalledVersions;
 use Psr\Container\ContainerInterface as PsrContainerInterface;
 use Symfony\Component\Config\Resource\ClassExistenceResource;
 use Symfony\Component\Config\Resource\ComposerResource;
@@ -407,6 +408,27 @@ public function fileExists(string $path, $trackContents = true): bool
         return $exists;
     }
 
+    final public function willBeAvailable(string $package, string $class, string $method = null): bool
+    {
+        if (!$class = $this->getReflectionClass($class, false)) {
+            return false;
+        }
+
+        if ($method && !$class->hasMethod($method)) {
+            return false;
+        }
+
+        if ($class->isInternal() || !class_exists(InstalledVersions::class)) {
+            return true;
+        }
+
+        if (InstalledVersions::isInstalled($package)) {
+            return InstalledVersions::isInstalled($package, true);
+        }
+
+        return true;
+    }
+
     /**
      * Loads the configuration for an extension.
      *
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php
@@ -71,6 +71,11 @@ final public function services(): ServicesConfigurator
         return new ServicesConfigurator($this->container, $this->loader, $this->instanceof, $this->path, $this->anonymousCount);
     }
 
+    final public function willBeAvailable(string $package, string $class, string $method = null): bool
+    {
+        return $this->container->willBeAvailable($package, $class, $method);
+    }
+
     /**
      * @return static
      */

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ final class RegisterUidTypePass implements CompilerPassInterface`
`24`	`24`	`*/`
`25`	`25`	`public function process(ContainerBuilder $container)`
`26`	`26`	`{`
`27`		`- if (!class_exists(AbstractUid::class)) {`
	`27`	`+ if (!$container->willBeAvailable('symfony/uid', AbstractUid::class)) {`
`28`	`28`	`return;`
`29`	`29`	`}`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ public function load(array $configs, ContainerBuilder $container)`
`125`	`125`	`$loader->load('security_legacy.php');`
`126`	`126`	`}`
`127`	`127`
`128`		`- if (class_exists(AbstractExtension::class)) {`
	`128`	`+ if ($container->willBeAvailable('twig/twig', AbstractExtension::class)) {`
`129`	`129`	`$loader->load('templating_twig.php');`
`130`	`130`	`}`
`131`	`131`
`@@ -136,7 +136,7 @@ public function load(array $configs, ContainerBuilder $container)`
`136`	`136`	`$loader->load('security_debug.php');`
`137`	`137`	`}`
`138`	`138`
`139`		`- if (!class_exists(\Symfony\Component\ExpressionLanguage\ExpressionLanguage::class)) {`
	`139`	`+ if (!$container->willBeAvailable('symfony/expression-language', \Symfony\Component\ExpressionLanguage\ExpressionLanguage::class)) {`
`140`	`140`	`$container->removeDefinition('security.expression_language');`
`141`	`141`	`$container->removeDefinition('security.access.expression_voter');`
`142`	`142`	`}`
`@@ -170,7 +170,7 @@ public function load(array $configs, ContainerBuilder $container)`
`170`	`170`	`$this->createEncoders($config['encoders'], $container);`
`171`	`171`	`}`
`172`	`172`
`173`		`- if (class_exists(Application::class)) {`
	`173`	`+ if ($container->willBeAvailable('symfony/console', Application::class)) {`
`174`	`174`	`$loader->load('console.php');`
`175`	`175`	`$container->getDefinition('security.command.user_password_encoder')->replaceArgument(1, array_keys($config['encoders']));`
`176`	`176`	`}`
`@@ -844,8 +844,8 @@ private function createExpression(ContainerBuilder $container, string $expressio`
`844`	`844`	`return $this->expressions[$id];`
`845`	`845`	`}`
`846`	`846`
`847`		`- if (!class_exists(\Symfony\Component\ExpressionLanguage\ExpressionLanguage::class)) {`
`848`		`- throw new \RuntimeException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');`
	`847`	`+ if (!$container->willBeAvailable('symfony/expression-language', \Symfony\Component\ExpressionLanguage\ExpressionLanguage::class)) {`
	`848`	`+ throw new \RuntimeException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');`
`849`	`849`	`}`
`850`	`850`
`851`	`851`	`$container`
Original file line number	Diff line number	Diff line change
`@@ -23,19 +23,19 @@ class ExtensionPass implements CompilerPassInterface`
`23`	`23`	`{`
`24`	`24`	`public function process(ContainerBuilder $container)`
`25`	`25`	`{`
`26`		`- if (!class_exists(\Symfony\Component\Asset\Packages::class)) {`
	`26`	`+ if (!$container->willBeAvailable('symfony/asset', \Symfony\Component\Asset\Packages::class)) {`
`27`	`27`	`$container->removeDefinition('twig.extension.assets');`
`28`	`28`	`}`
`29`	`29`
`30`		`- if (!class_exists(\Symfony\Component\ExpressionLanguage\Expression::class)) {`
	`30`	`+ if (!$container->willBeAvailable('symfony/expression-language', \Symfony\Component\ExpressionLanguage\Expression::class)) {`
`31`	`31`	`$container->removeDefinition('twig.extension.expression');`
`32`	`32`	`}`
`33`	`33`
`34`		`- if (!interface_exists(\Symfony\Component\Routing\Generator\UrlGeneratorInterface::class)) {`
	`34`	`+ if (!$container->willBeAvailable('symfony/routing', \Symfony\Component\Routing\Generator\UrlGeneratorInterface::class)) {`
`35`	`35`	`$container->removeDefinition('twig.extension.routing');`
`36`	`36`	`}`
`37`	`37`
`38`		`- if (!class_exists(\Symfony\Component\Yaml\Yaml::class)) {`
	`38`	`+ if (!$container->willBeAvailable('symfony/yaml', \Symfony\Component\Yaml\Yaml::class)) {`
`39`	`39`	`$container->removeDefinition('twig.extension.yaml');`
`40`	`40`	`}`
`41`	`41`
`@@ -111,7 +111,7 @@ public function process(ContainerBuilder $container)`
`111`	`111`	`$container->getDefinition('twig.extension.expression')->addTag('twig.extension');`
`112`	`112`	`}`
`113`	`113`
`114`		`- if (!class_exists(Workflow::class) \|\| !$container->has('workflow.registry')) {`
	`114`	`+ if (!$container->willBeAvailable('symfony/workflow', Workflow::class) \|\| !$container->has('workflow.registry')) {`
`115`	`115`	`$container->removeDefinition('workflow.twig_extension');`
`116`	`116`	`} else {`
`117`	`117`	`$container->getDefinition('workflow.twig_extension')->addTag('twig.extension');`
Original file line number	Diff line number	Diff line change
`@@ -37,19 +37,19 @@ public function load(array $configs, ContainerBuilder $container)`
`37`	`37`	`$loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));`
`38`	`38`	`$loader->load('twig.php');`
`39`	`39`
`40`		`- if (class_exists(\Symfony\Component\Form\Form::class)) {`
	`40`	`+ if ($container->willBeAvailable('symfony/form', \Symfony\Component\Form\Form::class)) {`
`41`	`41`	`$loader->load('form.php');`
`42`	`42`	`}`
`43`	`43`
`44`		`- if (class_exists(Application::class)) {`
	`44`	`+ if ($container->willBeAvailable('symfony/console', Application::class)) {`
`45`	`45`	`$loader->load('console.php');`
`46`	`46`	`}`
`47`	`47`
`48`		`- if (class_exists(Mailer::class)) {`
	`48`	`+ if ($container->willBeAvailable('symfony/mailer', Mailer::class)) {`
`49`	`49`	`$loader->load('mailer.php');`
`50`	`50`	`}`
`51`	`51`
`52`		`- if (!class_exists(Translator::class)) {`
	`52`	`+ if (!$container->willBeAvailable('symfony/translation', Translator::class)) {`
`53`	`53`	`$container->removeDefinition('twig.translation.extractor');`
`54`	`54`	`}`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -198,7 +198,7 @@ private function getExpressionLanguage(): ExpressionLanguage`
`198`	`198`	`{`
`199`	`199`	`if (null === $this->expressionLanguage) {`
`200`	`200`	`if (!class_exists(ExpressionLanguage::class)) {`
`201`		`- throw new LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');`
	`201`	`+ throw new LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed. Try running "composer require symfony/expression-language".');`
`202`	`202`	`}`
`203`	`203`
`204`	`204`	`$providers = $this->container->getExpressionLanguageProviders();`