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 3b837dc5c1 Merge branch '2.5'
* 2.5:
  [Translator] Use quote to surround invalid locale
  [Validator] Fixed memory leak in ValidatorBuilder
  [FrameworkBundle] changed KernelTestCase::getKernelClass() to check $_SERVER['KERNEL_DIR'] before invoking getPhpUnitXmlDir()
  Optimize assertLocale regexp
  [ExpressionLanguage] Fixed an issue with # characters in double quoted string literals
  [Validator] Fixed object initializers in 2.5 version of the Validator
  Add some tweaks to the pt_BR translations
  [Validator] Backported #11410 to 2.3: Object initializers are called only once per object
  [Translator][FrameworkBundle] Added @ to the list of allowed chars in Translator
  [Process] Reduce I/O load on Windows platform
  [Form] Check if IntlDateFormatter constructor returned a valid object before using it

Conflicts:
	src/Symfony/Component/Process/ProcessPipes.php
2014-07-24 19:03:35 +02:00
..
Constraints [Validator] no need to initialize properties with null 2014-06-17 12:31:26 +02:00
Context [Validator] Fixed object initializers in 2.5 version of the Validator 2014-07-21 10:57:43 +02:00
Exception [Validator] Improved performance of *ContextualValidator::validate() 2014-03-30 18:28:59 +02:00
Mapping [Validator] no need to initialize properties with null 2014-06-17 12:31:26 +02:00
Resources/translations Merge branch '2.5' 2014-07-24 19:03:35 +02:00
Tests Merge branch '2.5' 2014-07-24 19:03:35 +02:00
Util [Validator] Fix array notation in the PropertyPath::append() 2014-06-13 15:18:45 +02:00
Validator [Validator] Fixed object initializers in 2.5 version of the Validator 2014-07-21 10:57:43 +02:00
Violation fixed types in phpdocs 2014-04-16 12:36:34 +02:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
CHANGELOG.md [Validator] Improve UserPassword message 2014-07-23 10:41:34 +02:00
ClassBasedInterface.php [Validator] Added deprecation notes 2014-03-30 18:28:57 +02:00
composer.json updated version to 2.6 2014-05-23 16:36:49 +02:00
Constraint.php Merge branch '2.4' 2014-04-18 22:40:13 +02:00
ConstraintValidator.php made {@inheritdoc} annotations consistent across the board 2014-04-16 09:04:20 +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 [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.4' 2014-04-16 12:36:21 +02:00
ConstraintViolationInterface.php fixed types in phpdocs 2014-04-16 12:30:19 +02:00
ConstraintViolationList.php made {@inheritdoc} annotations consistent across the board 2014-04-16 09:04:20 +02:00
ConstraintViolationListInterface.php fixed types in phpdocs 2014-04-16 12:30:19 +02:00
DefaultTranslator.php Merge branch '2.4' 2014-04-16 10:08:40 +02:00
ExecutionContext.php Merge branch '2.4' 2014-04-18 22:40:13 +02:00
ExecutionContextInterface.php Merge branch '2.4' 2014-04-16 10:08:40 +02:00
GlobalExecutionContextInterface.php [Validator] Added deprecation notes 2014-03-30 18:28:57 +02:00
GroupSequenceProviderInterface.php fixed CS 2012-07-09 14:54:20 +02:00
LICENSE update year on licenses 2014-01-07 08:19:25 -05:00
MetadataFactoryInterface.php Merge branch '2.4' 2014-04-16 12:36:21 +02: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 removed defaults from PHPUnit configuration 2014-07-07 12:13:42 +02: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 updated version to 2.6 2014-05-23 16:36:49 +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 [Validator] remove wrong deprecation message 2014-07-11 15:26:12 +02:00
Validator.php made {@inheritdoc} annotations consistent across the board 2014-04-16 10:09:16 +02:00
ValidatorBuilder.php Merge branch '2.5' 2014-07-24 19:03:35 +02:00
ValidatorBuilderInterface.php made types consistent with those defined in Hack 2014-04-16 10:09:01 +02:00
ValidatorInterface.php Merge branch '2.4' 2014-04-16 10:08:40 +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\True(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:

http://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.phar install
$ phpunit