How to Validate Raw Values (Scalar Values and Arrays)

How to Validate Raw Values (Scalar Values and Arrays)

Usually you will be validating entire objects. But sometimes, you want to validate a simple value - like to verify that a string is a valid email address. From inside a controller, it looks like this:

  1. // ...
  2. use Symfony\Component\Validator\Constraints as Assert;
  3. use Symfony\Component\Validator\Validator\ValidatorInterface;
  5. // ...
  6. public function addEmail($email, ValidatorInterface $validator)
  7. {
  8.     $emailConstraint = new Assert\Email();
  9.     // all constraint "options" can be set this way
  10.     $emailConstraint->message = 'Invalid email address';
  12.     // use the validator to validate the value
  13.     $errors = $validator->validate(
  14.         $email,
  15.         $emailConstraint
  16.     );
  18.     if (0 === count($errors)) {
  19.         // ... this IS a valid email address, do something
  20.     } else {
  21.         // this is *not* a valid email address
  22.         $errorMessage = $errors[0]->getMessage();
  24.         // ... do something with the error
  25.     }
  27.     // ...
  28. }

By calling validate() on the validator, you can pass in a raw value and the constraint object that you want to validate that value against. A full list of the available constraints - as well as the full class name for each constraint - is available in the constraints reference section.

Validation of arrays is possible using the Collection constraint:

  1. use Symfony\Component\Validator\Constraints as Assert;
  2. use Symfony\Component\Validator\Validation;
  4. $validator = Validation::createValidator();
  6. $input = [
  7.     'name' => [
  8.         'first_name' => 'Fabien',
  9.         'last_name' => 'Potencier',
  10.     ],
  11.     'email' => '[email protected]',
  12.     'simple' => 'hello',
  13.     'eye_color' => 3,
  14.     'file' => null,
  15.     'password' => 'test',
  16.     'tags' => [
  17.         [
  18.             'slug' => 'symfony_doc',
  19.             'label' => 'symfony doc',
  20.         ],
  21.     ],
  22. ];
  24. $groups = new Assert\GroupSequence(['Default', 'custom']);
  26. $constraint = new Assert\Collection([
  27.     // the keys correspond to the keys in the input array
  28.     'name' => new Assert\Collection([
  29.         'first_name' => new Assert\Length(['min' => 101]),
  30.         'last_name' => new Assert\Length(['min' => 1]),
  31.     ]),
  32.     'email' => new Assert\Email(),
  33.     'simple' => new Assert\Length(['min' => 102]),
  34.     'eye_color' => new Assert\Choice([3, 4]),
  35.     'file' => new Assert\File(),
  36.     'password' => new Assert\Length(['min' => 60]),
  37.     'tags' => new Assert\Optional([
  38.         new Assert\Type('array'),
  39.         new Assert\Count(['min' => 1]),
  40.         new Assert\All([
  41.             new Assert\Collection([
  42.                 'slug' => [
  43.                     new Assert\NotBlank(),
  44.                     new Assert\Type(['type' => 'string']),
  45.                 ],
  46.                 'label' => [
  47.                     new Assert\NotBlank(),
  48.                 ],
  49.             ]),
  50.             new CustomUniqueTagValidator(['groups' => 'custom']),
  51.         ]),
  52.     ]),
  53. ]);
  55. $violations = $validator->validate($input, $constraint, $groups);

The validate() method returns a Symfony\Component\Validator\ConstraintViolationList object, which acts like an array of errors. Each error in the collection is a Symfony\Component\Validator\ConstraintViolation object, which holds the error message on its getMessage() method.

Note

When using groups with the Collection constraint, be sure to use the Optional constraint when appropriate as explained in its reference documentation.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.