Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

[READ-ONLY] Subtree split of the Symfony Validator Component -- clone into Symfony/Component/ (master at symfony/symfony)

Octocat-spinner-32 Constraints fixed types in phpdocs
Octocat-spinner-32 Context fixed types in phpdocs
Octocat-spinner-32 Exception [Validator] Improved performance of *ContextualValidator::validate()
Octocat-spinner-32 Mapping fixed types in phpdocs
Octocat-spinner-32 Resources Merge branch '2.4'
Octocat-spinner-32 Tests Merge branch '2.4'
Octocat-spinner-32 Util [Validator] Added inline documentation for the PropertyPath utility c…
Octocat-spinner-32 Validator made types consistent with those defined in Hack
Octocat-spinner-32 Violation fixed types in phpdocs
Octocat-spinner-32 .gitignore Added missing files .gitignore
Octocat-spinner-32 CHANGELOG.md [Validator] Documented changes in the UPGRADE files
Octocat-spinner-32 ClassBasedInterface.php [Validator] Added deprecation notes
Octocat-spinner-32 Constraint.php [Validator] Optimized use statements
Octocat-spinner-32 ConstraintValidator.php made {@inheritdoc} annotations consistent across the board
Octocat-spinner-32 ConstraintValidatorFactory.php Merge branch '2.4'
Octocat-spinner-32 ConstraintValidatorFactoryInterface.php removed unneeded use statements
Octocat-spinner-32 ConstraintValidatorInterface.php [Validator] Refactored the GraphWalker into an implementation of the …
Octocat-spinner-32 ConstraintViolation.php Merge branch '2.4'
Octocat-spinner-32 ConstraintViolationInterface.php fixed types in phpdocs
Octocat-spinner-32 ConstraintViolationList.php made {@inheritdoc} annotations consistent across the board
Octocat-spinner-32 ConstraintViolationListInterface.php fixed types in phpdocs
Octocat-spinner-32 DefaultTranslator.php Merge branch '2.4'
Octocat-spinner-32 ExecutionContext.php [Validator] Adapted CHANGELOG
Octocat-spinner-32 ExecutionContextInterface.php Merge branch '2.4'
Octocat-spinner-32 GlobalExecutionContextInterface.php [Validator] Added deprecation notes
Octocat-spinner-32 GroupSequenceProviderInterface.php fixed CS
Octocat-spinner-32 LICENSE update year on licenses
Octocat-spinner-32 MetadataFactoryInterface.php Merge branch '2.4'
Octocat-spinner-32 MetadataInterface.php [Validator] Improved inline documentation of the metadata classes
Octocat-spinner-32 ObjectInitializerInterface.php [Validator] Refactored the GraphWalker into an implementation of the …
Octocat-spinner-32 PropertyMetadataContainerInterface.php Merge branch '2.4'
Octocat-spinner-32 PropertyMetadataInterface.php [Validator] Added deprecation notes
Octocat-spinner-32 README.md updated version to 2.5
Octocat-spinner-32 Validation.php [FrameworkBundle] Implemented configuration to select the desired Val…
Octocat-spinner-32 ValidationVisitor.php [Validator] Optimized use statements
Octocat-spinner-32 ValidationVisitorInterface.php Merge branch '2.4'
Octocat-spinner-32 Validator.php made {@inheritdoc} annotations consistent across the board
Octocat-spinner-32 ValidatorBuilder.php fixed types in phpdocs
Octocat-spinner-32 ValidatorBuilderInterface.php made types consistent with those defined in Hack
Octocat-spinner-32 ValidatorInterface.php Merge branch '2.4'
Octocat-spinner-32 composer.json fixed typo in composer.json
Octocat-spinner-32 phpunit.xml.dist made usage of Composer autoloader for subtree-split unit tests
README.md

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.5/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
Something went wrong with that request. Please try again.