This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Component/Validator
Fabien Potencier c6d9af374f bug #15115 [Validator] always evaluate binary format when changed (xabbuh)
This PR was merged into the 2.6 branch.

Discussion
----------

[Validator] always evaluate binary format when changed

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #13891
| License       | MIT
| Doc PR        |

Commits
-------

2ad7e67 [Validator] always evaluate binary format when changed
2015-07-01 21:58:06 +02:00
..
Constraints bug #15115 [Validator] always evaluate binary format when changed (xabbuh) 2015-07-01 21:58:06 +02:00
Context Merge branch '2.5' into 2.6 2014-12-05 13:00:15 +01:00
Exception [Validator] Improved performance of *ContextualValidator::validate() 2014-03-30 18:28:59 +02:00
Mapping [2.6] Fix @link annotations 2015-04-10 20:22:21 +02:00
Resources/translations Merge branch '2.3' into 2.6 2015-06-27 22:15:38 +02:00
Tests bug #15115 [Validator] always evaluate binary format when changed (xabbuh) 2015-07-01 21:58:06 +02:00
Util [Validator] Property paths starting with 0 are broken. 2015-05-05 03:29:27 +02:00
Validator [2.6][Validator] Fix BC for Validator's validate method 2015-06-28 16:52:59 +02:00
Violation Removed dead code and various cleaning 2015-01-21 21:57:55 +01:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md Merge branch '2.3' into 2.6 2015-05-15 11:48:50 +02:00
ClassBasedInterface.php [Validator] Added deprecation notes 2014-03-30 18:28:57 +02:00
composer.json Merge branch '2.3' into 2.6 2015-05-02 17:18:45 +02:00
Constraint.php Merge branch '2.3' into 2.6 2015-04-08 07:30:27 +02:00
ConstraintValidator.php CS: general fixes 2015-03-25 00:47:08 +01:00
ConstraintValidatorFactory.php Merge branch '2.4' 2014-04-16 10:08:40 +02:00
ConstraintValidatorFactoryInterface.php removed unneeded use statements 2014-01-01 08:52:14 +01:00
ConstraintValidatorInterface.php [Validator] Refactored the GraphWalker into an implementation of the Visitor design pattern. 2012-11-24 13:00:28 +01:00
ConstraintViolation.php Merge branch '2.3' into 2.5 2014-12-02 21:15:53 +01:00
ConstraintViolationInterface.php Fixes various phpdoc and coding standards. 2015-01-02 09:58:20 +01:00
ConstraintViolationList.php made {@inheritdoc} annotations consistent across the board 2014-04-16 09:04:20 +02:00
ConstraintViolationListInterface.php Docblock fixes 2014-11-30 13:33:44 +00:00
DefaultTranslator.php Merge branch '2.3' into 2.6 2015-04-11 09:16:15 +02:00
ExecutionContext.php Merge branch '2.4' 2014-04-18 22:40:13 +02:00
ExecutionContextInterface.php [Validator] remove partial deprecation annotation 2015-06-08 18:16:07 +02:00
GlobalExecutionContextInterface.php Merge branch '2.3' into 2.5 2015-01-03 09:01:13 +01:00
GroupSequenceProviderInterface.php fixed CS 2012-07-09 14:54:20 +02:00
LICENSE Updated copyright to 2015 2015-01-01 13:56:52 +01:00
MetadataFactoryInterface.php Docblock fixes 2014-11-30 13:33:44 +00:00
MetadataInterface.php [Validator] Improved inline documentation of the metadata classes 2014-03-30 18:28:58 +02:00
ObjectInitializerInterface.php [Validator] Refactored the GraphWalker into an implementation of the Visitor design pattern. 2012-11-24 13:00:28 +01:00
phpunit.xml.dist [2.3] require-dev PHPUnit bridge 2015-02-24 11:24:26 +01:00
PropertyMetadataContainerInterface.php Merge branch '2.4' 2014-04-16 12:36:21 +02:00
PropertyMetadataInterface.php [Validator] Added deprecation notes 2014-03-30 18:28:57 +02:00
README.md Merge branch '2.3' into 2.6 2015-05-15 11:48:50 +02:00
Validation.php [FrameworkBundle] Implemented configuration to select the desired Validator API 2014-03-30 18:31:00 +02:00
ValidationVisitor.php [Validator] Fixed object initializers in 2.5 version of the Validator 2014-07-21 10:57:43 +02:00
ValidationVisitorInterface.php Merge branch '2.3' into 2.5 2014-12-02 21:15:53 +01:00
Validator.php Merge branch '2.4' into 2.5 2014-09-22 11:14:18 +02:00
ValidatorBuilder.php Merge branch '2.5' into 2.6 2015-01-05 15:28:40 +01:00
ValidatorBuilderInterface.php CS fixes 2014-12-04 20:26:11 +00:00
ValidatorInterface.php [2.6][Validator] Fix Interface reference in docblock 2015-05-04 14:41:38 +02:00

Validator Component

This component is based on the JSR-303 Bean Validation specification and enables specifying validation rules for classes using XML, YAML, PHP or annotations, which can then be checked against instances of these classes.

Usage

The component provides "validation constraints", which are simple objects containing the rules for the validation. Let's validate a simple string as an example:

use Symfony\Component\Validator\Validation;
use Symfony\Component\Validator\Constraints\Length;

$validator = Validation::createValidator();

$violations = $validator->validateValue('Bernhard', new Length(array('min' => 10)));

This validation will fail because the given string is shorter than ten characters. The precise errors, here called "constraint violations", are returned by the validator. You can analyze these or return them to the user. If the violation list is empty, validation succeeded.

Validation of arrays is possible using the Collection constraint:

use Symfony\Component\Validator\Validation;
use Symfony\Component\Validator\Constraints as Assert;

$validator = Validation::createValidator();

$constraint = new Assert\Collection(array(
    'name' => new Assert\Collection(array(
        'first_name' => new Assert\Length(array('min' => 101)),
        'last_name' => new Assert\Length(array('min' => 1)),
    )),
    'email' => new Assert\Email(),
    'simple' => new Assert\Length(array('min' => 102)),
    'gender' => new Assert\Choice(array(3, 4)),
    'file' => new Assert\File(),
    'password' => new Assert\Length(array('min' => 60)),
));

$violations = $validator->validateValue($input, $constraint);

Again, the validator returns the list of violations.

Validation of objects is possible using "constraint mapping". With such a mapping you can put constraints onto properties and objects of classes. Whenever an object of this class is validated, its properties and method results are matched against the constraints.

use Symfony\Component\Validator\Validation;
use Symfony\Component\Validator\Constraints as Assert;

class User
{
    /**
     * @Assert\Length(min = 3)
     * @Assert\NotBlank
     */
    private $name;

    /**
     * @Assert\Email
     * @Assert\NotBlank
     */
    private $email;

    public function __construct($name, $email)
    {
        $this->name = $name;
        $this->email = $email;
    }

    /**
     * @Assert\IsTrue(message = "The user should have a Google Mail account")
     */
    public function isGmailUser()
    {
        return false !== strpos($this->email, '@gmail.com');
    }
}

$validator = Validation::createValidatorBuilder()
    ->enableAnnotationMapping()
    ->getValidator();

$user = new User('John Doe', 'john@example.com');

$violations = $validator->validate($user);

This example uses the annotation support of Doctrine Common to map constraints to properties and methods. You can also map constraints using XML, YAML or plain PHP, if you dislike annotations or don't want to include Doctrine. Check the documentation for more information about these drivers.

Resources

Silex integration:

https://github.com/fabpot/Silex/blob/master/src/Silex/Provider/ValidatorServiceProvider.php

Documentation:

https://symfony.com/doc/2.6/book/validation.html

JSR-303 Specification:

http://jcp.org/en/jsr/detail?id=303

You can run the unit tests with the following command:

$ cd path/to/Symfony/Component/Validator/
$ composer install
$ phpunit