feature symfony#28536 Favor LogicException for missing classes & functions (ro0NL)

nicolas-grekas · nicolas-grekas · commit eb607ae4dcd8 · 2018-09-24T10:16:33.000+02:00
This PR was merged into the 4.2-dev branch. Discussion ---------- Favor LogicException for missing classes & functions | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes-ish | BC breaks? | no-ish  | Deprecations? | no | Tests pass? | yes  | Fixed tickets | symfony#28513 (comment) | License | MIT | Doc PR | symfony/symfony-docs#...   Commits ------- c762735 Favor LogicException for missing classes & functions
diff --git a/src/Symfony/Component/BrowserKit/Client.php b/src/Symfony/Component/BrowserKit/Client.php
@@ -118,7 +118,7 @@ public function getMaxRedirects()
     public function insulate($insulated = true)
     {
         if ($insulated && !class_exists('Symfony\\Component\\Process\\Process')) {
-            throw new \RuntimeException('Unable to isolate requests as the Symfony Process Component is not installed.');
+            throw new \LogicException('Unable to isolate requests as the Symfony Process Component is not installed.');
         }
 
         $this->insulated = (bool) $insulated;
diff --git a/src/Symfony/Component/Config/Util/XmlUtils.php b/src/Symfony/Component/Config/Util/XmlUtils.php
@@ -47,7 +47,7 @@ private function __construct()
     public static function parse($content, $schemaOrCallable = null)
     {
         if (!\extension_loaded('dom')) {
-            throw new \RuntimeException('Extension DOM is required.');
+            throw new \LogicException('Extension DOM is required.');
         }
 
         $internalErrors = libxml_use_internal_errors(true);
diff --git a/src/Symfony/Component/Console/Command/LockableTrait.php b/src/Symfony/Component/Console/Command/LockableTrait.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Command;
 
 use Symfony\Component\Console\Exception\LogicException;
-use Symfony\Component\Console\Exception\RuntimeException;
 use Symfony\Component\Lock\Factory;
 use Symfony\Component\Lock\Lock;
 use Symfony\Component\Lock\Store\FlockStore;
@@ -36,7 +35,7 @@ trait LockableTrait
     private function lock($name = null, $blocking = false)
     {
         if (!class_exists(SemaphoreStore::class)) {
-            throw new RuntimeException('To enable the locking feature you must install the symfony/lock component.');
+            throw new LogicException('To enable the locking feature you must install the symfony/lock component.');
         }
 
         if (null !== $this->lock) {
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php
@@ -14,6 +14,7 @@
 use Symfony\Component\DependencyInjection\Argument\ArgumentInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\ExpressionLanguage;
 use Symfony\Component\DependencyInjection\Reference;
@@ -197,7 +198,7 @@ private function getExpressionLanguage()
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists(ExpressionLanguage::class)) {
-                throw new RuntimeException('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.');
             }
 
             $providers = $this->container->getExpressionLanguageProviders();
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -1587,7 +1587,7 @@ private function getExpressionLanguage()
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
-                throw new RuntimeException('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.');
             }
             $this->expressionLanguage = new ExpressionLanguage(null, $this->expressionLanguageProviders);
         }
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -1692,7 +1692,7 @@ private function getExpressionLanguage()
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
-                throw new RuntimeException('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.');
             }
             $providers = $this->container->getExpressionLanguageProviders();
             $this->expressionLanguage = new ExpressionLanguage(null, $providers, function ($arg) {
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php
@@ -19,6 +19,7 @@
 use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Parameter;
 use Symfony\Component\DependencyInjection\Reference;
@@ -45,7 +46,7 @@ class YamlDumper extends Dumper
     public function dump(array $options = array())
     {
         if (!class_exists('Symfony\Component\Yaml\Dumper')) {
-            throw new RuntimeException('Unable to dump the container as the Symfony Yaml Component is not installed.');
+            throw new LogicException('Unable to dump the container as the Symfony Yaml Component is not installed.');
         }
 
         if (null === $this->dumper) {
diff --git a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Config\Util\XmlUtils;
 use Symfony\Component\DependencyInjection\Exception\EnvNotFoundException;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 
 /**
@@ -180,7 +181,7 @@ public function getEnv($prefix, $name, \Closure $getEnv)
     private static function phpize($value)
     {
         if (!class_exists(XmlUtils::class)) {
-            throw new RuntimeException('The Symfony Config component is required to cast env vars to "bool", "int" or "float".');
+            throw new LogicException('The Symfony Config component is required to cast env vars to "bool", "int" or "float".');
         }
 
         return XmlUtils::phpize($value);
diff --git a/src/Symfony/Component/DomCrawler/Crawler.php b/src/Symfony/Component/DomCrawler/Crawler.php
@@ -1166,7 +1166,7 @@ private function createSubCrawler($nodes)
     private function createCssSelectorConverter(): CssSelectorConverter
     {
         if (!\class_exists(CssSelectorConverter::class)) {
-            throw new \RuntimeException('To filter with a CSS selector, install the CssSelector component ("composer require symfony/css-selector"). Or use filterXpath instead.');
+            throw new \LogicException('To filter with a CSS selector, install the CssSelector component ("composer require symfony/css-selector"). Or use filterXpath instead.');
         }
 
         return new CssSelectorConverter($this->isHtml);
diff --git a/src/Symfony/Component/Messenger/Exception/LogicException.php b/src/Symfony/Component/Messenger/Exception/LogicException.php
@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Messenger\Exception;
+
+/**
+ * @author Roland Franssen <franssen.roland@gmail.com>
+ */
+class LogicException extends \LogicException implements ExceptionInterface
+{
+}
diff --git a/src/Symfony/Component/Messenger/Transport/Serialization/Serializer.php b/src/Symfony/Component/Messenger/Transport/Serialization/Serializer.php
@@ -13,7 +13,7 @@
 
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Exception\InvalidArgumentException;
-use Symfony\Component\Messenger\Exception\RuntimeException;
+use Symfony\Component\Messenger\Exception\LogicException;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\Encoder\XmlEncoder;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
@@ -39,7 +39,7 @@ public function __construct(SymfonySerializerInterface $serializer, string $form
     public static function create(): self
     {
         if (!class_exists(SymfonySerializer::class)) {
-            throw new RuntimeException(sprintf('The default Messenger Serializer requires Symfony\'s Serializer component. Try running "composer require symfony/serializer".'));
+            throw new LogicException(sprintf('The default Messenger Serializer requires Symfony\'s Serializer component. Try running "composer require symfony/serializer".'));
         }
 
         $encoders = array(new XmlEncoder(), new JsonEncoder());
diff --git a/src/Symfony/Component/Process/Process.php b/src/Symfony/Component/Process/Process.php
@@ -140,7 +140,7 @@ class Process implements \IteratorAggregate
     public function __construct($command, string $cwd = null, array $env = null, $input = null, ?float $timeout = 60)
     {
         if (!\function_exists('proc_open')) {
-            throw new RuntimeException('The Process class relies on proc_open, which is not available on your PHP installation.');
+            throw new LogicException('The Process class relies on proc_open, which is not available on your PHP installation.');
         }
 
         if (!\is_array($command)) {
diff --git a/src/Symfony/Component/PropertyAccess/PropertyAccessor.php b/src/Symfony/Component/PropertyAccess/PropertyAccessor.php
@@ -788,7 +788,7 @@ private function getPropertyPath($propertyPath): PropertyPath
     public static function createCache($namespace, $defaultLifetime, $version, LoggerInterface $logger = null)
     {
         if (!class_exists('Symfony\Component\Cache\Adapter\ApcuAdapter')) {
-            throw new \RuntimeException(sprintf('The Symfony Cache component must be installed to use %s().', __METHOD__));
+            throw new \LogicException(sprintf('The Symfony Cache component must be installed to use %s().', __METHOD__));
         }
 
         if (!ApcuAdapter::isSupported()) {
diff --git a/src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php b/src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php
@@ -54,7 +54,7 @@ class PhpDocExtractor implements PropertyDescriptionExtractorInterface, Property
     public function __construct(DocBlockFactoryInterface $docBlockFactory = null, array $mutatorPrefixes = null, array $accessorPrefixes = null, array $arrayMutatorPrefixes = null)
     {
         if (!class_exists(DocBlockFactory::class)) {
-            throw new \RuntimeException(sprintf('Unable to use the "%s" class as the "phpdocumentor/reflection-docblock" package is not installed.', __CLASS__));
+            throw new \LogicException(sprintf('Unable to use the "%s" class as the "phpdocumentor/reflection-docblock" package is not installed.', __CLASS__));
         }
 
         $this->docBlockFactory = $docBlockFactory ?: DocBlockFactory::createInstance();
diff --git a/src/Symfony/Component/Routing/Loader/AnnotationFileLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationFileLoader.php
@@ -32,7 +32,7 @@ class AnnotationFileLoader extends FileLoader
     public function __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader)
     {
         if (!\function_exists('token_get_all')) {
-            throw new \RuntimeException('The Tokenizer extension is required for the routing annotation loaders.');
+            throw new \LogicException('The Tokenizer extension is required for the routing annotation loaders.');
         }
 
         parent::__construct($locator);
diff --git a/src/Symfony/Component/Routing/Matcher/Dumper/PhpMatcherDumper.php b/src/Symfony/Component/Routing/Matcher/Dumper/PhpMatcherDumper.php
@@ -724,7 +724,7 @@ private function getExpressionLanguage()
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
-                throw new \RuntimeException('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.');
             }
             $this->expressionLanguage = new ExpressionLanguage(null, $this->expressionLanguageProviders);
         }
diff --git a/src/Symfony/Component/Routing/Matcher/UrlMatcher.php b/src/Symfony/Component/Routing/Matcher/UrlMatcher.php
@@ -246,7 +246,7 @@ protected function getExpressionLanguage()
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
-                throw new \RuntimeException('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.');
             }
             $this->expressionLanguage = new ExpressionLanguage(null, $this->expressionLanguageProviders);
         }
diff --git a/src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ObjectNormalizer.php
@@ -15,7 +15,7 @@
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
-use Symfony\Component\Serializer\Exception\RuntimeException;
+use Symfony\Component\Serializer\Exception\LogicException;
 use Symfony\Component\Serializer\Mapping\AttributeMetadata;
 use Symfony\Component\Serializer\Mapping\ClassDiscriminatorResolverInterface;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
@@ -33,7 +33,7 @@ class ObjectNormalizer extends AbstractObjectNormalizer
     public function __construct(ClassMetadataFactoryInterface $classMetadataFactory = null, NameConverterInterface $nameConverter = null, PropertyAccessorInterface $propertyAccessor = null, PropertyTypeExtractorInterface $propertyTypeExtractor = null, ClassDiscriminatorResolverInterface $classDiscriminatorResolver = null)
     {
         if (!\class_exists(PropertyAccess::class)) {
-            throw new RuntimeException('The ObjectNormalizer class requires the "PropertyAccess" component. Install "symfony/property-access" to use it.');
+            throw new LogicException('The ObjectNormalizer class requires the "PropertyAccess" component. Install "symfony/property-access" to use it.');
         }
 
         parent::__construct($classMetadataFactory, $nameConverter, $propertyTypeExtractor, $classDiscriminatorResolver);
diff --git a/src/Symfony/Component/Validator/Constraints/EmailValidator.php b/src/Symfony/Component/Validator/Constraints/EmailValidator.php
@@ -15,7 +15,7 @@
 use Egulias\EmailValidator\Validation\NoRFCWarningsValidation;
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\ConstraintValidator;
-use Symfony\Component\Validator\Exception\RuntimeException;
+use Symfony\Component\Validator\Exception\LogicException;
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
@@ -100,7 +100,7 @@ public function validate($value, Constraint $constraint)
 
         if (Email::VALIDATION_MODE_STRICT === $constraint->mode) {
             if (!class_exists('\Egulias\EmailValidator\EmailValidator')) {
-                throw new RuntimeException('Strict email validation requires egulias/email-validator ~1.2|~2.0');
+                throw new LogicException('Strict email validation requires egulias/email-validator ~1.2|~2.0');
             }
 
             $strictValidator = new \Egulias\EmailValidator\EmailValidator();
diff --git a/src/Symfony/Component/Validator/Constraints/ExpressionValidator.php b/src/Symfony/Component/Validator/Constraints/ExpressionValidator.php
@@ -14,7 +14,7 @@
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\ConstraintValidator;
-use Symfony\Component\Validator\Exception\RuntimeException;
+use Symfony\Component\Validator\Exception\LogicException;
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
@@ -55,7 +55,7 @@ private function getExpressionLanguage()
     {
         if (null === $this->expressionLanguage) {
             if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {
-                throw new RuntimeException('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.');
             }
             $this->expressionLanguage = new ExpressionLanguage();
         }
diff --git a/src/Symfony/Component/Validator/Constraints/ImageValidator.php b/src/Symfony/Component/Validator/Constraints/ImageValidator.php
@@ -13,7 +13,7 @@
 
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
-use Symfony\Component\Validator\Exception\RuntimeException;
+use Symfony\Component\Validator\Exception\LogicException;
 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
 
 /**
@@ -218,7 +218,7 @@ public function validate($value, Constraint $constraint)
 
         if ($constraint->detectCorrupted) {
             if (!\function_exists('imagecreatefromstring')) {
-                throw new RuntimeException('Corrupted images detection requires installed and enabled GD extension');
+                throw new LogicException('Corrupted images detection requires installed and enabled GD extension');
             }
 
             $resource = @imagecreatefromstring(file_get_contents($value));

Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ public function getMaxRedirects()`
`118`	`118`	`public function insulate($insulated = true)`
`119`	`119`	`{`
`120`	`120`	`if ($insulated && !class_exists('Symfony\\Component\\Process\\Process')) {`
`121`		`- throw new \RuntimeException('Unable to isolate requests as the Symfony Process Component is not installed.');`
	`121`	`+ throw new \LogicException('Unable to isolate requests as the Symfony Process Component is not installed.');`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`$this->insulated = (bool) $insulated;`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ private function __construct()`
`47`	`47`	`public static function parse($content, $schemaOrCallable = null)`
`48`	`48`	`{`
`49`	`49`	`if (!\extension_loaded('dom')) {`
`50`		`- throw new \RuntimeException('Extension DOM is required.');`
	`50`	`+ throw new \LogicException('Extension DOM is required.');`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`$internalErrors = libxml_use_internal_errors(true);`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@`
`12`	`12`	`namespace Symfony\Component\Console\Command;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Console\Exception\LogicException;`
`15`		`-use Symfony\Component\Console\Exception\RuntimeException;`
`16`	`15`	`use Symfony\Component\Lock\Factory;`
`17`	`16`	`use Symfony\Component\Lock\Lock;`
`18`	`17`	`use Symfony\Component\Lock\Store\FlockStore;`
`@@ -36,7 +35,7 @@ trait LockableTrait`
`36`	`35`	`private function lock($name = null, $blocking = false)`
`37`	`36`	`{`
`38`	`37`	`if (!class_exists(SemaphoreStore::class)) {`
`39`		`- throw new RuntimeException('To enable the locking feature you must install the symfony/lock component.');`
	`38`	`+ throw new LogicException('To enable the locking feature you must install the symfony/lock component.');`
`40`	`39`	`}`
`41`	`40`
`42`	`41`	`if (null !== $this->lock) {`
Original file line number	Diff line number	Diff line change
`@@ -1587,7 +1587,7 @@ private function getExpressionLanguage()`
`1587`	`1587`	`{`
`1588`	`1588`	`if (null === $this->expressionLanguage) {`
`1589`	`1589`	`if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {`
`1590`		`- throw new RuntimeException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');`
	`1590`	`+ throw new LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');`
`1591`	`1591`	`}`
`1592`	`1592`	`$this->expressionLanguage = new ExpressionLanguage(null, $this->expressionLanguageProviders);`
`1593`	`1593`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1692,7 +1692,7 @@ private function getExpressionLanguage()`
`1692`	`1692`	`{`
`1693`	`1693`	`if (null === $this->expressionLanguage) {`
`1694`	`1694`	`if (!class_exists('Symfony\Component\ExpressionLanguage\ExpressionLanguage')) {`
`1695`		`- throw new RuntimeException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');`
	`1695`	`+ throw new LogicException('Unable to use expressions as the Symfony ExpressionLanguage component is not installed.');`
`1696`	`1696`	`}`
`1697`	`1697`	`$providers = $this->container->getExpressionLanguageProviders();`
`1698`	`1698`	`$this->expressionLanguage = new ExpressionLanguage(null, $providers, function ($arg) {`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\Config\Util\XmlUtils;`
`15`	`15`	`use Symfony\Component\DependencyInjection\Exception\EnvNotFoundException;`
	`16`	`+use Symfony\Component\DependencyInjection\Exception\LogicException;`
`16`	`17`	`use Symfony\Component\DependencyInjection\Exception\RuntimeException;`
`17`	`18`
`18`	`19`	`/**`
`@@ -180,7 +181,7 @@ public function getEnv($prefix, $name, \Closure $getEnv)`
`180`	`181`	`private static function phpize($value)`
`181`	`182`	`{`
`182`	`183`	`if (!class_exists(XmlUtils::class)) {`
`183`		`- throw new RuntimeException('The Symfony Config component is required to cast env vars to "bool", "int" or "float".');`
	`184`	`+ throw new LogicException('The Symfony Config component is required to cast env vars to "bool", "int" or "float".');`
`184`	`185`	`}`
`185`	`186`
`186`	`187`	`return XmlUtils::phpize($value);`
Original file line number	Diff line number	Diff line change
`@@ -1166,7 +1166,7 @@ private function createSubCrawler($nodes)`
`1166`	`1166`	`private function createCssSelectorConverter(): CssSelectorConverter`
`1167`	`1167`	`{`
`1168`	`1168`	`if (!\class_exists(CssSelectorConverter::class)) {`
`1169`		`- throw new \RuntimeException('To filter with a CSS selector, install the CssSelector component ("composer require symfony/css-selector"). Or use filterXpath instead.');`
	`1169`	`+ throw new \LogicException('To filter with a CSS selector, install the CssSelector component ("composer require symfony/css-selector"). Or use filterXpath instead.');`
`1170`	`1170`	`}`
`1171`	`1171`
`1172`	`1172`	`return new CssSelectorConverter($this->isHtml);`