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 da655a9368 Merge branch '2.3' into 2.7
* 2.3:
  Typo fix
  [2.3] Static Code Analysis for Components
  Added support \IteratorAggregate for UniqueEntityValidator
  Fix #17306 Paths with % in it are note allowed (like urlencoded)
  Added sort order SORT_STRING for params in UriSigner
  Remove normalizer cache in Serializer class
2016-01-12 18:44:11 +01:00
..
Constraints Merge branch '2.3' into 2.7 2015-11-18 14:41:01 +01:00
Context fixes CS 2015-08-24 09:13:45 +02:00
Exception fixes CS 2015-08-24 09:13:45 +02:00
Mapping Merge branch '2.3' into 2.7 2016-01-12 18:44:11 +01:00
Resources/translations Merge branch '2.3' into 2.7 2015-12-26 14:37:43 +01:00
Tests Merge branch '2.3' into 2.7 2015-12-28 14:11:03 +01:00
Util [Validator] Property paths starting with 0 are broken. 2015-05-05 03:29:27 +02:00
Validator Fixed properties not explicitily declared 2015-09-14 11:40:15 +02:00
Violation fixes CS 2015-08-24 09:13:45 +02:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md [Validator] Deprecated PHP7-incompatible constraints and related validators 2015-05-15 12:10:43 +02:00
ClassBasedInterface.php Normalized @deprecated annotations. 2015-01-05 16:02:26 +01:00
composer.json Merge branch '2.3' into 2.7 2015-10-30 13:10:21 -07:00
Constraint.php Merge branch '2.3' into 2.7 2015-09-29 14:06:14 +02:00
ConstraintValidator.php Merge branch '2.3' into 2.7 2015-09-29 14:06:14 +02: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 remove api tags from code 2015-09-28 19:11:22 +02:00
ConstraintViolation.php Silence invasive deprecation warnings, opt-in for warnings 2015-06-08 10:37:21 +01:00
ConstraintViolationInterface.php Merge branch '2.3' into 2.7 2015-09-29 14:06:14 +02:00
ConstraintViolationList.php made {@inheritdoc} annotations consistent across the board 2014-04-16 09:04:20 +02:00
ConstraintViolationListInterface.php remove api tags from code 2015-09-28 19:11:22 +02:00
DefaultTranslator.php Silence invasive deprecation warnings, opt-in for warnings 2015-06-08 10:37:21 +01:00
ExecutionContext.php Silence invasive deprecation warnings, opt-in for warnings 2015-06-08 10:37:21 +01:00
ExecutionContextInterface.php Merge branch '2.3' into 2.7 2015-09-29 14:06:14 +02:00
GlobalExecutionContextInterface.php Normalized @deprecated annotations. 2015-01-05 16:02:26 +01:00
GroupSequenceProviderInterface.php fixed CS 2012-07-09 14:54:20 +02:00
LICENSE Update copyright year 2016-01-01 23:53:47 -03:00
MetadataFactoryInterface.php Normalized @deprecated annotations. 2015-01-05 16:02:26 +01:00
MetadataInterface.php Normalized @deprecated annotations. 2015-01-05 16:02:26 +01:00
ObjectInitializerInterface.php remove api tags from code 2015-09-28 19:11:22 +02:00
phpunit.xml.dist Add missing exclusions from phpunit.xml.dist 2015-11-18 09:19:46 +01:00
PropertyMetadataContainerInterface.php Normalized @deprecated annotations. 2015-01-05 16:02:26 +01:00
PropertyMetadataInterface.php fixes CS 2015-08-24 09:13:45 +02:00
README.md [Validator] Use the new interface in the README 2015-12-21 13:16:02 +01:00
Validation.php fixes CS 2015-08-24 09:13:45 +02:00
ValidationVisitor.php Silence invasive deprecation warnings, opt-in for warnings 2015-06-08 10:37:21 +01:00
ValidationVisitorInterface.php [Validator] adds more deprecation notices. 2015-01-05 16:02:27 +01:00
Validator.php Silence invasive deprecation warnings, opt-in for warnings 2015-06-08 10:37:21 +01:00
ValidatorBuilder.php Silence invasive deprecation warnings, opt-in for warnings 2015-06-08 10:37:21 +01:00
ValidatorBuilderInterface.php fixes CS 2015-08-24 09:13:45 +02:00
ValidatorInterface.php Merge branch '2.3' into 2.7 2015-09-29 14:06:14 +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->validate('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->validate($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/silexphp/Silex/blob/master/src/Silex/Provider/ValidatorServiceProvider.php

Documentation:

https://symfony.com/doc/2.7/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