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

sylfabre · 2018-09-16T09:15:19Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#28166
License	MIT
Doc PR	symfony/symfony-docs#10349

A BIC comes usually with an IBAN so it's better to check that they are associated. This PR provides an iban option to Symfony\Component\Validator\Constraints\Bic to check the BIC against an IBAN.

It also provides an ibanPropertyPath to retrieves the IBAN using the property accessor like with comparison constraints.

nicolas-grekas

Thanks for working on this! Here are some random comments :)

nicolas-grekas · 2018-09-17T17:39:45Z

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

+    public $ibanMessage = 'This Business Identifier Code (BIC) is not associated with IBAN {{ iban }}.';
+
+    public $iban;
+


I'd suggest to remove the blank lines between the added properties

nicolas-grekas · 2018-09-17T17:40:27Z

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

+
+    public $ibanPropertyPath;
+
+    public function __construct($options = null)


missing "array" type hint?

nicolas-grekas · 2018-09-17T17:42:36Z

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

+        } else {
+            $iban = $constraint->iban;
+        }
+        if ($iban) {


if (!$iban) => return early?

@nicolas-grekas no because the logic of validators is to return null on the first violation.

If tomorrow we add some more checks after this new code then we don't want to return early in this check.

We shouldn't base current code on hypothetical future-based arguments. Here it would make the code clearer now.

nicolas-grekas · 2018-09-17T17:43:03Z

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

+        if ($iban) {
+            $ibanCountryCode = substr($iban, 0, 2);
+            if (ctype_alpha($ibanCountryCode)) {
+                if (substr($canonicalize, 4, 2) !== $ibanCountryCode) {


the two "if"s should be combined in one using &&

nicolas-grekas · 2018-09-17T17:43:12Z

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

+                        ->setCode(Bic::INVALID_IBAN_COUNTRY_CODE_ERROR)
+                        ->addViolation();
+
+                    return;


@nicolas-grekas I can remove it but I've done like the other violations raised above

Please remove it yes, the code elsewhere is unrelated.

src/Symfony/Component/Validator/Tests/Constraints/BicValidatorTest.php

nicolas-grekas · 2018-09-17T17:46:05Z

Could you improve the PR and commit title please also? (I'd suggest to squash commits while doing so)

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

nicolas-grekas · 2018-09-18T12:08:47Z

Thanks, LGTM, except the test failure of course.

nicolas-grekas

thanks

nicolas-grekas · 2018-09-20T12:08:06Z

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

+        } else {
+            $iban = $constraint->iban;
+        }
+        if (!isset($iban) || !$iban) {


I'd suggest to rewrite the previous this way

$iban = $constraint->iban; $path = $constraint->ibanPropertyPath; if ($path && null !== $object = $this->context->getObject()) { try { $iban = $this->getPropertyAccessor()->getValue($object, $path); } catch (NoSuchPropertyException $e) { throw new ConstraintDefinitionException(sprintf('Invalid property path "%s" provided to "%s" constraint: %s', $path, \get_class($constraint), $e->getMessage()), 0, $e); } } if (!$iban) {

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

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

ro0NL · 2018-09-21T08:21:19Z

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

+        }
+    }
+
+    private function getPropertyAccessor()


getPropertyAccessor(): PropertyAccessor

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

ro0NL · 2018-09-21T08:23:48Z

src/Symfony/Component/Validator/Tests/Constraints/BicValidatorTest.php

 use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;

+class BicComparisonTest_Class


i believe for consistency we should put this at the bottom of the file. Not sure about using _ in the class name, camelcase is preferred.

nicolas-grekas · 2018-09-23T09:07:25Z

Thanks @ro0NL for the comments, good catch!
@sylfabre OK to you with the comments? They all make sense to me (please rebase also.)

Status: needs work

ro0NL · 2018-10-22T17:58:32Z

src/Symfony/Component/Validator/CHANGELOG.md

@@ -13,6 +13,7 @@ CHANGELOG
 * deprecated using the `Bic`, `Country`, `Currency`, `Language` and `Locale` constraints without `symfony/intl`
 * deprecated using the `Email` constraint without `egulias/email-validator`
 * deprecated using the `Expression` constraint without `symfony/expression-language`
+ * added options iban and propertyPath to Bic constraint


ibanPropertyPath

also any symbol is put between backticks (``), here the symbols are: "iban", "ibanPropertyPath" and "Bic"

ro0NL · 2018-10-22T17:59:10Z

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

+            throw new ConstraintDefinitionException(sprintf('The "iban" and "ibanPropertyPath" of the Iban constraint cannot be used at the same time.', \get_class($this)));
+        }
+
+        if (isset($options['propertyPath']) && !class_exists(PropertyAccess::class)) {


'ibanPropertyPath'

OskarStark

Anything todo here?

ro0NL

tests are red :)

ro0NL · 2018-11-02T20:09:39Z

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

    {
        if (!class_exists(Intl::class)) {
            // throw new LogicException(sprintf('The "symfony/intl" component is required to use the "%s" constraint.', __CLASS__));
            @trigger_error(sprintf('Using the "%s" constraint without the "symfony/intl" component installed is deprecated since Symfony 4.2.', __CLASS__), E_USER_DEPRECATED);
        }

+        if (isset($options['iban']) && isset($options['ibanPropertyPath'])) {
+            throw new ConstraintDefinitionException(sprintf('The "iban" and "ibanPropertyPath" of the Iban constraint cannot be used at the same time.', \get_class($this)));


... options of the Bic constraint ...

ro0NL · 2018-11-02T20:41:56Z

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


-    public function __construct($options = null)
+    public function __construct(array $options = null)


not sure about this :)

looks good for me as we expect an array.

Why aren't you sure about this?

In this case, the change looks valid to me. Generally you can define a default option by overriding the getDefaultOption() method. But since that is not the case for the Bic constraint, it will already throw an exception when no array is passed.

exactly, but now we'll never reach the exception at

symfony/src/Symfony/Component/Validator/Constraint.php

Line 136 in 491bbe7

throw new ConstraintDefinitionException(sprintf('No default option is configured for constraint %s', \get_class($this)));

so basically all constraints will throw this exception, except here it will cause a type error: https://3v4l.org/WjMuY

sylfabre · 2018-11-05T11:05:46Z

@ro0NL tests are now green :)

xabbuh · 2018-11-05T11:15:29Z

src/Symfony/Component/Validator/CHANGELOG.md

@@ -15,6 +15,7 @@ CHANGELOG
 * deprecated using the `Bic`, `Country`, `Currency`, `Language` and `Locale` constraints without `symfony/intl`
 * deprecated using the `Email` constraint without `egulias/email-validator`
 * deprecated using the `Expression` constraint without `symfony/expression-language`
+ * added options `iban` and `ibanPropertyPath` to Bic constraint


needs to be added to a new 4.3.0 section now as 4.2 is in feature freeze

xabbuh · 2018-11-05T11:16:36Z

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

    {
        if (!class_exists(Intl::class)) {
            // throw new LogicException(sprintf('The "symfony/intl" component is required to use the "%s" constraint.', __CLASS__));
            @trigger_error(sprintf('Using the "%s" constraint without the "symfony/intl" component installed is deprecated since Symfony 4.2.', __CLASS__), E_USER_DEPRECATED);
        }

+        if (isset($options['iban']) && isset($options['ibanPropertyPath'])) {
+            throw new ConstraintDefinitionException(sprintf('The "iban" and "ibanPropertyPath" options of the Iban constraint cannot be used at the same time.', \get_class($this)));


self::class instead of get_class($this)(same below)?

xabbuh · 2018-11-05T11:17:49Z

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

+    private function getPropertyAccessor(): PropertyAccessor
+    {
+        if (null === $this->propertyAccessor) {
+            if (!class_exists('Symfony\Component\PropertyAccess\PropertyAccess')) {


we should use the class constant here

@xabbuh like PropertyAccess::class ?
I haven't tried but I think it will throw an exception if the class does not exist, right?

yes like that, and using the class constant works even when the class is not present: https://3v4l.org/knSo3

@xabbuh thanks!

Fix symfony#28166

nicolas-grekas · 2018-12-01T09:10:55Z

Thank you @sylfabre.

This PR was merged into the 4.3-dev branch. Discussion ---------- [Validator] Checking a BIC along with an IBAN | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #28166 | License | MIT | Doc PR | symfony/symfony-docs#10349 A BIC comes usually with an IBAN so it's better to check that they are associated. This PR provides an `iban` option to `Symfony\Component\Validator\Constraints\Bic` to check the BIC against an IBAN. It also provides an `ibanPropertyPath` to retrieves the IBAN using the property accessor like with comparison constraints. Commits ------- bb6be15 [Validator] Checking a BIC along with an IBAN Fix #28166

This PR was merged into the master branch. Discussion ---------- Validate a BIC along with an IBAN Doc for this PR: symfony/symfony#28479 Commits ------- 51f833b Validate a BIC along with an IBAN

This PR was submitted for the master branch but it was merged into the 3.4 branch instead (closes #29799). Discussion ---------- [Validator] Add Japanese translation for #28479 | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | n/a | License | MIT | Doc PR | n/a Commits ------- 7a0bdde Add Japanese translation for #28479

* 3.4: Add Japanese translation for #28479

* 4.1: Add Japanese translation for #28479

* 4.2: Add Japanese translation for #28479

carsonbot added Status: Needs Review Feature labels Sep 16, 2018

sylfabre mentioned this pull request Sep 16, 2018

Validate a BIC along with an IBAN symfony/symfony-docs#10349

Merged

sylfabre force-pushed the issue_28166 branch 2 times, most recently from 7dc5554 to 67a7ea3 Compare September 16, 2018 09:22

xabbuh added this to the next milestone Sep 17, 2018

xabbuh added the Validator label Sep 17, 2018

nicolas-grekas reviewed Sep 17, 2018

View reviewed changes

sylfabre changed the title ~~Fix #28166~~ Checking a BIC along with an IBAN Sep 18, 2018

sylfabre force-pushed the issue_28166 branch 4 times, most recently from 2d5d72d to 9fb42ba Compare September 18, 2018 08:02

ro0NL reviewed Sep 18, 2018

View reviewed changes

src/Symfony/Component/Validator/Constraints/BicValidator.php Show resolved Hide resolved

sylfabre force-pushed the issue_28166 branch from 9fb42ba to 41b422b Compare September 18, 2018 12:09

nicolas-grekas changed the title ~~Checking a BIC along with an IBAN~~ [Validator] Checking a BIC along with an IBAN Sep 18, 2018

carsonbot removed the Status: Needs Review label Sep 18, 2018

nicolas-grekas approved these changes Sep 18, 2018

View reviewed changes

carsonbot added the Status: Reviewed label Sep 18, 2018

nicolas-grekas reviewed Sep 20, 2018

View reviewed changes

sylfabre force-pushed the issue_28166 branch 3 times, most recently from 98bb643 to 645b016 Compare September 20, 2018 12:31

javiereguiluz approved these changes Sep 20, 2018

View reviewed changes

ro0NL reviewed Sep 21, 2018

View reviewed changes

src/Symfony/Component/Validator/Constraints/BicValidator.php Show resolved Hide resolved

ro0NL reviewed Sep 21, 2018

View reviewed changes

sylfabre force-pushed the issue_28166 branch from dc8a9c1 to 25ce7de Compare October 22, 2018 16:11

ro0NL reviewed Oct 22, 2018

View reviewed changes

sylfabre force-pushed the issue_28166 branch from 25ce7de to bfd52dd Compare October 23, 2018 07:59

OskarStark approved these changes Nov 2, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Nov 2, 2018

ro0NL reviewed Nov 2, 2018

View reviewed changes

sylfabre force-pushed the issue_28166 branch from bfd52dd to 435489b Compare November 5, 2018 07:17

xabbuh reviewed Nov 5, 2018

View reviewed changes

sylfabre force-pushed the issue_28166 branch from 435489b to 491bbe7 Compare November 5, 2018 11:37

[Validator] Checking a BIC along with an IBAN

bb6be15

Fix symfony#28166

sylfabre force-pushed the issue_28166 branch from 491bbe7 to bb6be15 Compare November 5, 2018 12:47

nicolas-grekas merged commit bb6be15 into symfony:master Dec 1, 2018

issei-m added a commit to issei-m/symfony that referenced this pull request Jan 6, 2019

Add Japanese translation for symfony#28479

6cad01a

fabpot pushed a commit to issei-m/symfony that referenced this pull request Jan 6, 2019

Add Japanese translation for symfony#28479

7a0bdde

fabpot added a commit that referenced this pull request Jan 6, 2019

Merge branch '3.4' into 4.1

64999e6

* 3.4: Add Japanese translation for #28479

fabpot added a commit that referenced this pull request Jan 6, 2019

Merge branch '4.1' into 4.2

9fe204e

* 4.1: Add Japanese translation for #28479

fabpot added a commit that referenced this pull request Jan 6, 2019

Merge branch '4.2'

fdb7a8f

* 4.2: Add Japanese translation for #28479

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

fabpot mentioned this pull request May 9, 2019

Release v4.3.0-BETA1 #31435

Merged

sylfabre deleted the issue_28166 branch September 25, 2020 13:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

sylfabre commented Sep 16, 2018 •

edited

Loading

nicolas-grekas left a comment

nicolas-grekas Sep 17, 2018

nicolas-grekas Sep 17, 2018

nicolas-grekas Sep 17, 2018

sylfabre Sep 18, 2018

nicolas-grekas Sep 18, 2018

nicolas-grekas Sep 17, 2018

nicolas-grekas Sep 17, 2018

sylfabre Sep 18, 2018

nicolas-grekas Sep 18, 2018

nicolas-grekas commented Sep 17, 2018

nicolas-grekas commented Sep 18, 2018

nicolas-grekas left a comment

nicolas-grekas Sep 20, 2018

ro0NL Sep 21, 2018

ro0NL Sep 21, 2018

nicolas-grekas commented Sep 23, 2018

ro0NL Oct 22, 2018

ro0NL Oct 22, 2018

OskarStark left a comment

ro0NL left a comment

ro0NL Nov 2, 2018

ro0NL Nov 2, 2018

sylfabre Nov 5, 2018

xabbuh Nov 5, 2018

ro0NL Nov 5, 2018

sylfabre commented Nov 5, 2018

xabbuh Nov 5, 2018

xabbuh Nov 5, 2018

xabbuh Nov 5, 2018

sylfabre Nov 5, 2018

xabbuh Nov 5, 2018

sylfabre Nov 5, 2018

nicolas-grekas commented Dec 1, 2018

		public $ibanMessage = 'This Business Identifier Code (BIC) is not associated with IBAN {{ iban }}.';

		public $iban;


		public $ibanPropertyPath;

		public function __construct($options = null)

		use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;

		class BicComparisonTest_Class


		public function __construct($options = null)
		public function __construct(array $options = null)

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

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

Conversation

sylfabre commented Sep 16, 2018 • edited Loading

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

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

Choose a reason for hiding this comment

nicolas-grekas commented Sep 17, 2018

nicolas-grekas commented Sep 18, 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

Choose a reason for hiding this comment

nicolas-grekas commented Sep 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OskarStark left a comment

Choose a reason for hiding this comment

ro0NL left a 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

Choose a reason for hiding this comment

sylfabre commented Nov 5, 2018

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

nicolas-grekas commented Dec 1, 2018

sylfabre commented Sep 16, 2018 •

edited

Loading