[DX][Form][Validator] Add ability check if cocrete constraint fails. #19496

Koc · 2016-08-01T08:42:11Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	wait for travis
Fixed tickets	#15154
License	MIT
Doc PR	should open

Sometimes for big forms with multiple constraints we should handle some errors separately.

// when using validator
$constraintViolations = $validator->validate(...);
if (count($constraintViolations->findByCodes(UniqueEntity::NOT_UNIQUE_ERROR))) {
  // display some message or send email or etc
}

// when using forms
if (count($form->getErrors()->findByCodes(UniqueEntity::NOT_UNIQUE_ERROR))) {
  // display some message or send email or etc
}

This PR add some useful methods to handle this. Before we should iterate all failed constraints using foreach.

Feel free to suggest better names for new methods.

HeahDude · 2016-08-01T09:08:41Z

src/Symfony/Component/Form/FormErrorIterator.php

@@ -265,6 +266,16 @@ public function seek($position)
        }
    }

+    public function getFormErrorByCode($code)


What about hasErrorCode? And what if there are many errors with the same code?

I suggest either to return a boolean: false => no such error, true => error(s), or empty array/array of error(s).

@HeahDude I would prefer return array/empty array, what name give for this method?

Maybe just add an "s" to error

FormErrorIterator::getFormErrorsByCode duplicates terms, the context is clear due the class name. We're dealing with form errors. Ie. you could go with FormErrorIterator::getByCode or maybe findByCode.

However if we can get a new FormErrorIterator instance for one or more codes that would be truly convenient.. ie.
$specificErrros = $errors->withCodes(array(Constraint::CODE, OtherConstraint::CODE));

For quick one-liners, you could consider adding hasCode.

Koc · 2016-08-02T20:29:56Z

//cc @webmozart

ro0NL · 2016-09-21T18:05:39Z

src/Symfony/Component/Validator/ConstraintViolationList.php

+    {
+        $violations = array();
+        foreach ($this as $violation) {
+            if (in_array($violation->getCode(), $codes, true)) {


$codes should be casted to array. Imo this may also be typehinted.

@ro0NL I've added support passing code or array of codes. No need wrap single code with array

Personally i'd favor API like

final public function findByCode($code) { return $this->findByCodes(array($code)); } public function findByCodes(array $codes) { }

But this is fine 👍

ro0NL · 2016-09-24T13:08:52Z

src/Symfony/Component/Form/FormErrorIterator.php

+    public function findByCodes($codes)
+    {
+        $codes = (array) $codes;
+        $formErrors = array();


Could be $errors

ro0NL · 2016-09-24T13:09:01Z

src/Symfony/Component/Form/FormErrorIterator.php

+    {
+        $codes = (array) $codes;
+        $formErrors = array();
+        foreach ($this as $formError) {


Should be $error

ro0NL · 2016-09-24T13:22:31Z

src/Symfony/Component/Form/FormErrorIterator.php

+     *
+     * @return static New instance which contains only specific errors.
+     */
+    public function findByCodes($codes)


As this only works for errors caused by the validator component...im not sure coupling hardcoded is appropriate. It's convenient though.. but maybe this should be findByCause..

$errros->findByCause(function($cause) use ($codes) { return $cause instanceof ConstraintViolation && in_array($cause->getCode(), (array) $codes, true); });

I haven't see any benefits from public method findByCause - too much code for writing closure. It equals to writing foreach.

Koc · 2016-09-28T21:40:32Z

@fabpot @webmozart tests pass, examples have updated

ro0NL · 2016-09-28T21:55:09Z

src/Symfony/Component/Form/Tests/FormErrorIteratorTest.php

+        $form->addError(new FormError('Error 2!', null, array(), null, $cause));
+        $cause = new ConstraintViolation('Error 3!', null, array(), null, '', null, null, 'code2');
+        $form->addError(new FormError('Error 3!', null, array(), null, $cause));
+        $formErrors = $form->getErrors();


Perhaps should be tested with nested errors.

fabpot · 2017-03-22T23:25:38Z

Thank you @Koc.

…straint fails. (Koc) This PR was merged into the 3.3-dev branch. Discussion ---------- [DX][Form][Validator] Add ability check if cocrete constraint fails. | Q | A | | --- | --- | | Branch? | master | | Bug fix? | no | | New feature? | yes | | BC breaks? | no | | Deprecations? | no | | Tests pass? | wait for travis | | Fixed tickets | #15154 | | License | MIT | | Doc PR | should open | Sometimes for big forms with multiple constraints we should handle some errors separately. ``` php // when using validator $constraintViolations = $validator->validate(...); if (count($constraintViolations->findByCodes(UniqueEntity::NOT_UNIQUE_ERROR))) { // display some message or send email or etc } // when using forms if (count($form->getErrors()->findByCodes(UniqueEntity::NOT_UNIQUE_ERROR))) { // display some message or send email or etc } ``` This PR add some useful methods to handle this. Before we should iterate all failed constraints using foreach. Feel free to suggest better names for new methods. Commits ------- 29a3a7e Add ability retrieve errors by their code.

carsonbot added Status: Needs Review DX DX = Developer eXperience (anything that improves the experience of using Symfony) Form Validator Feature labels Aug 1, 2016

HeahDude reviewed Aug 1, 2016
View reviewed changes

Koc force-pushed the get-errors-by-code branch from 19d66ba to f3e2159 Compare September 21, 2016 16:10

ro0NL reviewed Sep 21, 2016

View reviewed changes

Koc force-pushed the get-errors-by-code branch 2 times, most recently from c2e1323 to 5eb0822 Compare September 24, 2016 10:18

ro0NL reviewed Sep 24, 2016

View reviewed changes

Add ability retrieve errors by their code.

29a3a7e

Koc force-pushed the get-errors-by-code branch from 5eb0822 to 29a3a7e Compare September 24, 2016 20:11

ro0NL reviewed Sep 28, 2016

View reviewed changes

nicolas-grekas added this to the 3.x milestone Dec 6, 2016

fabpot merged commit 29a3a7e into symfony:master Mar 22, 2017

nicolas-grekas modified the milestones: 3.x, 3.3 Mar 24, 2017

javiereguiluz mentioned this pull request Apr 9, 2017

[Form][Validator] Add ability check if concrete constraint fails symfony/symfony-docs#7786

Closed

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

ro0NL mentioned this pull request Oct 21, 2018

[Form] FormErrorIterator do not filter only with Constraint causes #28649

Closed

Koc deleted the get-errors-by-code branch July 22, 2019 12:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DX][Form][Validator] Add ability check if cocrete constraint fails. #19496

[DX][Form][Validator] Add ability check if cocrete constraint fails. #19496

Koc commented Aug 1, 2016 •

edited

Loading

HeahDude Aug 1, 2016 •

edited

Loading

Koc Aug 2, 2016

HeahDude Aug 2, 2016

ro0NL Aug 7, 2016 •

edited

Loading

Koc commented Aug 2, 2016

ro0NL Sep 21, 2016

Koc Sep 24, 2016

ro0NL Sep 24, 2016

ro0NL Sep 24, 2016

ro0NL Sep 24, 2016

ro0NL Sep 24, 2016

Koc Sep 24, 2016

Koc commented Sep 28, 2016

ro0NL Sep 28, 2016

fabpot commented Mar 22, 2017

[DX][Form][Validator] Add ability check if cocrete constraint fails. #19496

[DX][Form][Validator] Add ability check if cocrete constraint fails. #19496

Conversation

Koc commented Aug 1, 2016 • edited Loading

HeahDude Aug 1, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL Aug 7, 2016 • edited Loading

Choose a reason for hiding this comment

Koc commented Aug 2, 2016

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

Koc commented Sep 28, 2016

Choose a reason for hiding this comment

fabpot commented Mar 22, 2017

Koc commented Aug 1, 2016 •

edited

Loading

HeahDude Aug 1, 2016 •

edited

Loading

ro0NL Aug 7, 2016 •

edited

Loading