6e0d0850f4
* 3.0: [DependencyInjection] fix dumped YAML snytax Remove InputOption::VALUE_REQUIRED mode from $default parameter description as InputOption::setDefault() throws an exception only when called in InputOption::VALUE_NONE mode. In practice the $default value could still be accessed in InputOption::VALUE_REQUIRED mode in case InputOption was never set but accessed from InputDefinition::getOption() method [Yaml] always restore the error handler in tests [FrameworkBundle] fix YAML syntax fix YAML syntax in functional tests config [HttpFoundation] [Session] Removed unnecessary PHP version check as minimum requirement is now 5.5.9 [Form] Fixed violation mapping if multiple forms are using the same (or part of the same) property path fix FQCN in tests added by #17694 Fix locale and written standard inconsistencies for Norwegian translations [Form] [Validator] Fix locale inconsistencies in Norwegian translations [TwigBridge] Symfony 3.1 forward compatibility fixed CS [DependencyInjection] fixed exceptions thrown by get method of ContainerBuilder [Yaml] properly parse lists in object maps [FrameworkBundle] Remove unused private method. [Form] remove useless code in ResizeFormListener [Config] Fix EnumNodeDefinition to allow building enum nodes with one element [Form] remove deprecated empty_value_in_choices fix choice_value option in EntityType and add some tests |
||
---|---|---|
.. | ||
Constraints | ||
Context | ||
Exception | ||
Mapping | ||
Resources/translations | ||
Tests | ||
Util | ||
Validator | ||
Violation | ||
.gitignore | ||
CHANGELOG.md | ||
composer.json | ||
Constraint.php | ||
ConstraintValidator.php | ||
ConstraintValidatorFactory.php | ||
ConstraintValidatorFactoryInterface.php | ||
ConstraintValidatorInterface.php | ||
ConstraintViolation.php | ||
ConstraintViolationInterface.php | ||
ConstraintViolationList.php | ||
ConstraintViolationListInterface.php | ||
GroupSequenceProviderInterface.php | ||
LICENSE | ||
ObjectInitializerInterface.php | ||
phpunit.xml.dist | ||
README.md | ||
Validation.php | ||
ValidatorBuilder.php | ||
ValidatorBuilderInterface.php |
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/3.1/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