[2.2] [Validator] "AnyOf" validation constraint #4861

olegstepura · 2012-07-11T15:02:41Z

Bug fix: no
Feature addition: yes
Backwards compatibility break: no
Symfony2 tests pass: yes
Todo: documentation (hopefully not me)
License of the code: MIT
Documentation PR: none

Here is proposal for AnyOf validation constraint. It's used to validate against any of given child validation constraints. If any of child validation constraints will pass validation of given value then AnyOf will pass as well.

<?php
// src/Acme/UserBundle/Entity/User.php
namespace Acme\UserBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class User
{
    /**
     * @Assert\AnyOf({
     *     @Assert\Null
     *     @Assert\MinLength(3),
     * })
     */
     protected $secondName;
}

This will pass validation without violations if $secondName is a null OR if it's a string with a minimum length of 3.
Actually it was created to be used together with a more complex constraints.

olegstepura · 2012-07-11T15:05:57Z

BTW I named it AnyOf instead of just Any so that noone think of it as an opposite to All validation constraint. It's purpose is totally different.

stof · 2012-07-11T17:24:31Z

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

+ */
+class AnyOf extends Constraint
+{
+    public $message = 'Value "{{ value }}" did not pass validation against any of constraints in the list [{{ constraints }}]';


this is wrong. we don't want to display a list of constraint classes to the visitor seing a form error.

I refactored the code to only display all the child violations if validation against AnyOf failed. The only bad thing here is that there is no message that there had to be ANY of those to match. But merging those messages into AnyOf's own error message is not a good idea as well.

olegstepura · 2012-07-12T10:39:03Z

@stof what do you think about constraint naming? I described the reason I named it so in the first comment but maybe it should be named just Any in spite of that?

stof · 2012-07-12T13:01:42Z

I think AnyOf is better than Any to avoid confusion with All, as they are indeed totally different.

olegstepura · 2012-07-12T13:30:30Z

Do you accept extending All? This prevents copy-pasting, but makes those classes connected where they maybe shouldn't be.

Tobion · 2012-07-12T13:36:02Z

Your example with Null or MinLength is bad because MinLength alone also allows null. So in this case AnyOf is not even necessary.

olegstepura · 2012-07-12T15:24:42Z

@Tobion Yes, I know, this is why I wrote that actually it was created to be used together with a more complex constraints.

The better example may be with Min(10) and Max(5) so that we do not accept 6-9 but do accept all other values.
If any further refactor will be needed I will also change Constraints used in tests.

olegstepura · 2012-07-13T13:48:28Z

BTW, why does Symfony\Component\Validator\ConstraintViolationList still implement \IteratorAggregate, \Countable, \ArrayAccess by itself and not uses Doctrine\Common\Collections\ArrayCollection or some similar indoor solution to prevent copy-pasting of similar functions and allow for more usable methods to exist at ConstraintViolationList?

In this case ->toArray() method could be very helpful, for example. Using iterator_to_array() must be slower.

stof · 2012-07-13T19:03:21Z

@olegstepura Using the Doctrine ArrayCollection would introduce a hard dependency to doctrine common in the component.

olegstepura · 2012-07-13T19:19:00Z

@stof Then creating some symfony/common to store such common things makes sense. I'm sure this class is not the only one in the framework that implements all this interfaces, and each class implements it again and agian by itself.

There is Form, FormView, Options, ConstraintViolationList to name a few..

stof · 2012-07-13T19:36:17Z

Having a common base class for them does not make sense. They are different concepts. It could be a use case for traits, but Symfony cannot drop the support of PHP 5.3.

olegstepura · 2012-07-13T19:38:18Z

Well, ok, you know better. Any other improvements on this pull request needed to be done?

stof · 2012-07-13T20:26:34Z

Well, the description marks it for 2.2, so it is not the priority (priority is to release beta3)

stof · 2012-10-13T17:42:52Z

@bschussek @fabpot ping

linniksa · 2012-10-28T08:38:46Z

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

+use Symfony\Component\Validator\ConstraintValidator;
+
+/**
+ * AnyValidator class.


this should be equals name of the class or just removed

This PR was merged into the master branch. Commits ------- a7ce6be Fixed typos Discussion ---------- Fixed typos

This PR was merged into the master branch. Commits ------- 2817a47 [Finder] Fixed filename containing space bug in gnu adapter. 9bf7cb0 [Finder] Added filename containing space to tests. Discussion ---------- [Finder] Fixed filename containing space bug in gnu find adapter. Bug fix: yes Feature addition: no Backwards compatibility break: no Symfony2 tests pass: yes Fixes: symfony#5851 `GNU find` adapter now uses `cut` instead of `awk`.

…o any_of_validator Conflicts: src/Symfony/Component/Validator/Constraints/AnyOfValidator.php

webmozart · 2012-12-13T16:27:41Z

See also #5749.

Do we really need this? In #5749, which was closed today, no real need was seen for this functionality.

olegstepura · 2012-12-14T11:11:57Z

@bschussek I'm not sure why you created those functionality, but I did that when I had a need for it. It was not an abstract function. But since it's open already for 5 months and no one can tell if this will ever be merged maybe it'll be closed as well sometimes.

webmozart · 2012-12-14T13:04:47Z

@olegstepura Yes, let's close this until more people cry for it - then at least we'll be able to have a lively discussion about it. :)

stof reviewed Jul 11, 2012
View reviewed changes

Oleg Stepura added 2 commits July 12, 2012 13:30

Added AnyOf Validation constraint and validator

d191529

Updates according to stof's comments on symfony#4861

fa2b2ab

linniksa reviewed Oct 28, 2012
View reviewed changes

pborreli and others added 7 commits October 28, 2012 23:25

Fixed typos

a7ce6be

merged branch pborreli/sun-typos (PR symfony#5858)

ba15925

This PR was merged into the master branch. Commits ------- a7ce6be Fixed typos Discussion ---------- Fixed typos

Added AnyOf Validation constraint and validator

644e47d

Updates according to stof's comments on symfony#4861

8009416

Class name in comment should be equal to the actual class name

a5ede61

Merge branch 'any_of_validator' of github.com:olegstepura/symfony int…

eece240

…o any_of_validator Conflicts: src/Symfony/Component/Validator/Constraints/AnyOfValidator.php

webmozart closed this Dec 14, 2012

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.2] [Validator] "AnyOf" validation constraint #4861

[2.2] [Validator] "AnyOf" validation constraint #4861

olegstepura commented Jul 11, 2012

olegstepura commented Jul 11, 2012

stof Jul 11, 2012

olegstepura Jul 12, 2012

olegstepura commented Jul 12, 2012

stof commented Jul 12, 2012

olegstepura commented Jul 12, 2012

Tobion commented Jul 12, 2012

olegstepura commented Jul 12, 2012

olegstepura commented Jul 13, 2012

stof commented Jul 13, 2012

olegstepura commented Jul 13, 2012

stof commented Jul 13, 2012

olegstepura commented Jul 13, 2012

stof commented Jul 13, 2012

stof commented Oct 13, 2012

linniksa Oct 28, 2012

webmozart commented Dec 13, 2012

olegstepura commented Dec 14, 2012

webmozart commented Dec 14, 2012

[2.2] [Validator] "AnyOf" validation constraint #4861

[2.2] [Validator] "AnyOf" validation constraint #4861

Conversation

olegstepura commented Jul 11, 2012

olegstepura commented Jul 11, 2012

stof Jul 11, 2012

Choose a reason for hiding this comment

olegstepura Jul 12, 2012

Choose a reason for hiding this comment

olegstepura commented Jul 12, 2012

stof commented Jul 12, 2012

olegstepura commented Jul 12, 2012

Tobion commented Jul 12, 2012

olegstepura commented Jul 12, 2012

olegstepura commented Jul 13, 2012

stof commented Jul 13, 2012

olegstepura commented Jul 13, 2012

stof commented Jul 13, 2012

olegstepura commented Jul 13, 2012

stof commented Jul 13, 2012

stof commented Oct 13, 2012

linniksa Oct 28, 2012

Choose a reason for hiding this comment

webmozart commented Dec 13, 2012

olegstepura commented Dec 14, 2012

webmozart commented Dec 14, 2012