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 cafd4af7cd Merge branch '2.3' into 2.7
* 2.3:
  [DomCrawler] Invalid uri created from forms if base tag present
  [Console] update param type phpdoc for StreamOutput
  [Console] fix typo in OutputInterface
  [HttpKernel] fix broken multiline <esi:remove>
  [DoctrineBridge] Fixed #14840
  [FrameworkBundle] add a suggest for the serializer component
  [Yaml] Fix the parsing of float keys
  [Console] Ensure the console output is only detected as decorated when both stderr and stdout support colors
  Improve exception messages.
  Fix that two DirectoryResources with different patterns would be deduplicated
  Tests fix clockmock
  [WebProfilerBundle] Added tabindex="-1" to not interfer with normal UX
  missing "YAML" in the exception message.
  [framework-bundle] Add Test for TranslationUpdateCommand
  Use ObjectManager interface instead of EntityManager
2015-09-14 16:14:09 +02:00
..
Constraints [2.7] Clean deprecated interfaces 2015-09-04 22:16:46 +02: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 2015-09-14 16:14:09 +02:00
Resources/translations Merge branch '2.3' into 2.7 2015-09-10 10:05:42 +02:00
Tests Merge branch '2.3' into 2.7 2015-09-14 16:14:09 +02:00
Util [Validator] Property paths starting with 0 are broken. 2015-05-05 03:29:27 +02:00
Validator fixes CS 2015-08-24 09:13:45 +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 Require symfony/intl ~2.4 when Locale::setDefault() is used 2015-09-01 15:39:59 +02:00
Constraint.php fixes CS 2015-08-24 09:13:45 +02:00
ConstraintValidator.php Silence invasive deprecation warnings, opt-in for warnings 2015-06-08 10:37:21 +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 Silence invasive deprecation warnings, opt-in for warnings 2015-06-08 10:37:21 +01:00
ConstraintViolationInterface.php [2.7] Clean deprecated interfaces 2015-09-04 22:16:46 +02: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 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 [Validator] remove partial deprecation annotation 2015-06-08 18:16:07 +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 Updated copyright to 2015 2015-01-01 13:56:52 +01: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 [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 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 Merge branch '2.3' into 2.7 2015-09-06 10:36:38 +02: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.6' into 2.7 2015-05-05 03:30:36 +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/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