[Validator] add exception when intl component not found #28513

ronfroy · 2018-09-19T13:54:12Z

Q	A
Branch?	master
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
License	MIT

nicolas-grekas

Good idea. Here are some comments.

nicolas-grekas · 2018-09-19T13:57:13Z

src/Symfony/Component/Validator/Constraints/CountryValidator.php

@@ -28,6 +29,10 @@ class CountryValidator extends ConstraintValidator
     */
    public function validate($value, Constraint $constraint)
    {
+        if (!class_exists('Intl')) {


should be Intl::class instead.

nicolas-grekas · 2018-09-19T13:59:19Z

src/Symfony/Component/Validator/Constraints/CountryValidator.php

@@ -28,6 +29,10 @@ class CountryValidator extends ConstraintValidator
     */
    public function validate($value, Constraint $constraint)
    {
+        if (!class_exists('Intl')) {
+            throw new RuntimeException('symfony/intl is required to use the Country constraint');


missing dot at end of message, also I'd suggest to be a little bit more explicit (same in other messages below):
The "symfony/intl" component is required to use the Country constraint.

ronfroy · 2018-09-19T14:23:04Z

@nicolas-grekas fixed

chalasr · 2018-09-19T15:13:37Z

src/Symfony/Component/Validator/Constraints/CountryValidator.php

@@ -40,6 +41,10 @@ public function validate($value, Constraint $constraint)
            throw new UnexpectedTypeException($value, 'string');
        }

+        if (!class_exists(Intl::class)) {
+            throw new RuntimeException('The "symfony/intl" component is required to use the Country constraint.');


hmm, shouldn't it be a LogicException instead?

i think not, this is not a logic issue.

looking at the code, we use LogicException quite often in similar situations, so could be worth for consistency at least (there are a few similar cases using RuntimeException, but they're not the majority and could be worth fixing)

I would have used RuntimeException too ... but if we use LogicException in similar situations, it's better to keep consistency. @ronfroy can you please update this? Thanks!

how can we use LogicException elsewhere if this PR introduces it as a new class?

For this case we use the RuntimeException already 👍

symfony/src/Symfony/Component/Validator/Constraints/ExpressionValidator.php

Lines 56 to 63 in 645b016

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.');

}

$this->expressionLanguage = new ExpressionLanguage();

}

return $this->expressionLanguage;

javiereguiluz · 2018-09-20T15:45:39Z

src/Symfony/Component/Validator/Constraints/CountryValidator.php

@@ -40,6 +41,10 @@ public function validate($value, Constraint $constraint)
            throw new UnexpectedTypeException($value, 'string');
        }

+        if (!class_exists(Intl::class)) {
+            throw new RuntimeException('The "symfony/intl" component is required to use the Country constraint.');


I would have used RuntimeException too ... but if we use LogicException in similar situations, it's better to keep consistency. @ronfroy can you please update this? Thanks!

ronfroy · 2018-09-20T16:43:53Z

done

nicolas-grekas · 2018-09-21T11:05:05Z

can you update src/Symfony/Component/Validator/Constraints/BicValidator.php and src/Symfony/Component/Validator/Mapping/Factory/BlackHoleMetadataFactory.php to use the new exception also please?

ronfroy · 2018-09-21T11:27:39Z

@nicolas-grekas done

nicolas-grekas · 2018-09-21T11:27:41Z

and src/Symfony/Component/Validator/ValidatorBuilder.php

ro0NL · 2018-09-21T11:28:45Z

for consitency we should change Runtime to Logic in EmailValidator, ExpressionValidator & ImageValidator too :)

nicolas-grekas · 2018-09-21T11:33:10Z

src/Symfony/Component/Validator/Tests/Mapping/Factory/BlackHoleMetadataFactoryTest.php

@@ -17,7 +17,7 @@
 class BlackHoleMetadataFactoryTest extends TestCase
 {
    /**
-     * @expectedException \LogicException
+     * @expectedException \Symfony\Component\Validator\Exception\LogicException;


not sure about the trailing;

nicolas-grekas · 2018-09-21T11:34:28Z

src/Symfony/Component/Validator/ValidatorBuilder.php

@@ -191,8 +192,8 @@ public function enableAnnotationMapping(Reader $annotationReader = null)
        }

        if (null === $annotationReader) {
-            if (!class_exists('Doctrine\Common\Annotations\AnnotationReader') || !class_exists('Doctrine\Common\Cache\ArrayCache')) {
-                throw new \RuntimeException('Enabling annotation based constraint mapping requires the packages doctrine/annotations and doctrine/cache to be installed.');
+            if (!class_exists(Doctrine\Common\Annotations\AnnotationReader::class) || !class_exists(Doctrine\Common\Cache\ArrayCache::class)) {


should be moved as "use" statements.

nicolas-grekas · 2018-09-21T11:37:42Z

for consitency we should change Runtime to Logic in EmailValidator, ExpressionValidator & ImageValidator too :)

in another PR :)

nicolas-grekas · 2018-09-21T11:38:02Z

Thank you @ronfroy.

…(ronfroy) This PR was squashed before being merged into the 4.2-dev branch (closes #28513). Discussion ---------- [Validator] add exception when intl component not found | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT  Commits ------- b6f29f4 [Validator] add exception when intl component not found

…ro0NL) 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 | #28513 (comment) | License | MIT | Doc PR | symfony/symfony-docs#...   Commits ------- c762735 Favor LogicException for missing classes & functions

This PR was merged into the 4.2-dev branch. Discussion ---------- [Form] Check for Intl availibility | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no  | Deprecations? | no | Tests pass? | yes  | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  Same as #28513 for the form component Commits ------- 73c688c [Form] Check for Intl availibility

carsonbot added the Status: Needs Review label Sep 19, 2018

ronfroy changed the title ~~add exception when intl component not found~~ [Validator] add exception when intl component not found Sep 19, 2018

nicolas-grekas reviewed Sep 19, 2018

View reviewed changes

nicolas-grekas added this to the next milestone Sep 19, 2018

nicolas-grekas approved these changes Sep 19, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 19, 2018

xabbuh added the Validator label Sep 19, 2018

chalasr approved these changes Sep 19, 2018

View reviewed changes

chalasr reviewed Sep 19, 2018

View reviewed changes

chalasr mentioned this pull request Sep 19, 2018

[Validator] Check the BIC country with symfony/intl #28473

Merged

javiereguiluz approved these changes Sep 20, 2018

View reviewed changes

nicolas-grekas reviewed Sep 21, 2018

View reviewed changes

[Validator] add exception when intl component not found

b6f29f4

nicolas-grekas merged commit b6f29f4 into symfony:master Sep 21, 2018

ronfroy deleted the add-exception-on-the-validator-component branch September 21, 2018 11:38

nicolas-grekas mentioned this pull request Sep 21, 2018

[Validator] Checking a BIC along with an IBAN #28479

Merged

ro0NL mentioned this pull request Sep 21, 2018

Favor LogicException for missing classes & functions #28536

Merged

chalasr mentioned this pull request Sep 26, 2018

[security-bundle] - Symfony\Component\Templating\Helper\Helper is not loaded #28594

Closed

This was referenced Sep 26, 2018

[Form] Check for Intl availibility #28610

Merged

[Validator] Add BC layer covering BicValidator without Intl #28606

Merged

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Validator] add exception when intl component not found #28513

[Validator] add exception when intl component not found #28513

ronfroy commented Sep 19, 2018

nicolas-grekas left a comment

nicolas-grekas Sep 19, 2018

nicolas-grekas Sep 19, 2018

ronfroy commented Sep 19, 2018 •

edited

Loading

chalasr Sep 19, 2018

ronfroy Sep 19, 2018

nicolas-grekas Sep 19, 2018

javiereguiluz Sep 20, 2018

ro0NL Sep 21, 2018

javiereguiluz Sep 20, 2018

ronfroy commented Sep 20, 2018

nicolas-grekas commented Sep 21, 2018

ronfroy commented Sep 21, 2018

nicolas-grekas commented Sep 21, 2018

ro0NL commented Sep 21, 2018

nicolas-grekas Sep 21, 2018

nicolas-grekas Sep 21, 2018

nicolas-grekas commented Sep 21, 2018

nicolas-grekas commented Sep 21, 2018

	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.');
	}
	$this->expressionLanguage = new ExpressionLanguage();
	}

	return $this->expressionLanguage;

[Validator] add exception when intl component not found #28513

[Validator] add exception when intl component not found #28513

Conversation

ronfroy commented Sep 19, 2018

nicolas-grekas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ronfroy commented Sep 19, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ronfroy commented Sep 20, 2018

nicolas-grekas commented Sep 21, 2018

ronfroy commented Sep 21, 2018

nicolas-grekas commented Sep 21, 2018

ro0NL commented Sep 21, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Sep 21, 2018

nicolas-grekas commented Sep 21, 2018

ronfroy commented Sep 19, 2018 •

edited

Loading