We use cookies on this site to enhance your user experience. By clicking "OK, I Agree" or using our site, you consent to the use of cookies unless you have disabled them. View our cookie policy to learn more.
OK, I AGREE
TRACK
Symfony 4 >
COURSE
Symfony 4 Forms: Build, Render & Conquer!
Buy Access to Course

Custom Validator

Keep on Learning!

If you liked what you've learned so far, dive in!
Subscribe to get access to this tutorial plus
video, code and script downloads.

Start your All-Access Pass
Buy just this tutorial for $12.00
Previous Chapter

Next Chapter
Edit on Github

With a Subscription, click any sentence in the script to jump to that part of the video!

Login Subscribe

Unfortunately, you can't use the @UniqueEntity() validation constraint above a class that is not an entity: it's just a known limitation. But, fortunately, this gives us the perfect excuse to create a custom validation constraint! Woo!

When you can't find a built-in validation constraint that does what you need, the next thing to try is the @Assert\Callback constraint. We use this in the Article class. But, it has one limitation: because the method lives inside an entity class - we do not have access to any services. In our case, in order to know whether or not the email is taken yet, we need to make a query and so we do need to access a service.

Generating the Constraint Validator

When that's your situation, it's time for a custom validation constraint. They're awesome anyways and we're going to cheat! Find your terminal and run:

php bin/console make:validator

Call the class, how about, UniqueUser. Oh, this created two classes: UniqueUser and UniqueUserValidator. You'll find these inside a new Validator/ directory. Look at UniqueUser first: it's basically a dumb configuration object. This will be the class we use for our annotation.

18 lines src/Validator/UniqueUser.php
... lines 1 - 6
/**
* @Annotation
*/
class UniqueUser extends Constraint
{
/*
* Any public properties become valid options for the annotation.
* Then, use these in your validator class.
*/
public $message = 'The value "{{ value }}" is not valid.';
}

The actual validation is handled by UniqueUserValidator: Symfony will pass it the value being validated and a Constraint object - which will be that UniqueUser object we just saw. We'll use it to read some options to help us get our job done. For example, in the generated code, it reads the message property from the $constraint and sets that as the validation error. That's literally reading this public $message property from UniqueUser.

19 lines src/Validator/UniqueUserValidator.php
... lines 1 - 7
class UniqueUserValidator extends ConstraintValidator
{
public function validate($value, Constraint $constraint)
{
/* @var $constraint App\Validator\UniqueUser */
$this->context->buildViolation($constraint->message)
->setParameter('{{ value }}', $value)
->addViolation();
}
}

Configuring the Annotation

Ok: let's bring this generated code to life! Step 1: make sure your annotation class - UniqueUser - is ready to go. In general, an annotation can either be added above a class or above a property. Well, you can also add annotations above methods - that works pretty similar to properties.

If you add a validation annotation above your class, then during validation, the value that's passed to that validator is the entire object. If you add it above a property, then the value that's passed is just that property's value. So, if you need access to multiple fields on an object for validation, then you'll need to create an annotation that can be used above the class. In this situation, I'm going to delete @UniqueEntity and, instead, add the new annotation above my $email property: @UniqueUser. Hit tab to auto-complete that and get the use statement.

28 lines src/Form/Model/UserRegistrationFormModel.php
... lines 1 - 4
use App\Validator\UniqueUser;
... lines 6 - 7
class UserRegistrationFormModel
{
/**
... lines 11 - 12
* @UniqueUser()
*/
public $email;
... lines 16 - 26
}

Nice! Now, go back to your annotation class, we need to do a bit more work. To follow an example, press shift+ shift and open the core NotBlank annotation class. See that @Target() annotation above the class? This is a special annotation... that configures, um, the annotation system! @Target tells the annotation system where your annotation is allowed to be used. Copy that and paste it above our class. This says that it's okay for this annotation to be used above a property, above a method or even inside of another annotation... which is a bit more of a complex case, but we'll leave it.

19 lines src/Validator/UniqueUser.php
... lines 1 - 6
/**
... line 8
* @Target({"PROPERTY", "ANNOTATION"})
*/
class UniqueUser extends Constraint
... lines 12 - 19

What if you instead want your annotation to be put above a class? Open the UniqueEntity class as an example. Yep, you would use the CLASS target. The other thing you would need to do is override the getTargets() method. Wait, why is there an @Target annotation and a getTargets() method - isn't that redundant? Basically, yep! These provide more or less the same info to two different systems: the annotation system and the validation system. The getTargets() method defaults to PROPERTY - so you only need to override it if your annotation should be applied to a class.

Configuring your Annotation Properties

Phew! The last thing we need to do inside of UniqueUser is give it a better default $message: we'll set it to the same thing that we have above our User class: I think you've already registered. Paste that and... cool!

19 lines src/Validator/UniqueUser.php
... lines 1 - 10
class UniqueUser extends Constraint
{
... lines 13 - 16
public $message = 'I think you\'re already registered!';
}

If you need to be able to configure more things on your annotation - just create more public properties on UniqueUser. Any properties on this class can be set or overridden as options when using the annotation. In UserRegistrationFormModel, I won't do it now, but we could add a message= option: that string would ultimately be set on the message property.

Before we try this, go to UniqueUserValidator. See the setParameter() line? The makes it possible to add wildcards to your message - like:

The email {{ value }} is already registered

We could keep that, but since I'm not going to use it, I'll remove it. And... cool! With this setup, when we submit, this validator will be called and it will always fail. That's a good start. Let's try it!

Filling in the Validator Logic

Move over and refresh to resubmit the form. Yes! Our validator is working... it just doesn't have any logic yet! This is the easy part! Let's think about it: we need to make a query from inside the validator. Fortunately, these validator classes are services. And so, we can use our favorite trick: dependency injection!

Add an __construct() method on top with a UserRepository $userRepository argument. I'll hit alt+Enter to create that property and set it. Below, let's say $existingUser = $this->userRepository->findOneBy() to query for an email set to $value. Remember: because we put the annotation above the email property, $value will be that property's value.

Next, very simply, if (!$existingUser) then return. That's it.

34 lines src/Validator/UniqueUserValidator.php
... lines 1 - 8
class UniqueUserValidator extends ConstraintValidator
{
private $userRepository;
public function __construct(UserRepository $userRepository)
{
$this->userRepository = $userRepository;
}
... line 17
public function validate($value, Constraint $constraint)
{
$existingUser = $this->userRepository->findOneBy([
'email' => $value
]);
if (!$existingUser) {
return;
}
... lines 27 - 31
}
}

One note: if this were an edit form where a user could change their email, this validator would need to make sure that the existing user wasn't actually just this user, if they submitted without changing their email. In that case, we would need $value to be the entire object so that we could use the id to be sure of this. To do that, you would need to change UniqueUser so that it lives above the class, instead of the property. You would also need to add an id property to UserRegistrationFormModel.

But, for us, this is it! Move back over, refresh and... got it! Try entering a new user and adding the novalidate attribute so we can be lazy and keep the other fields blank. Submit! Error gone. Try [email protected] with the same novalidate trick. And... the error is back.

Custom validation constraints, check! Next, we're going to update our Article form to add a few new drop-down select fields, but... with a catch: when the user selects an option from the first drop-down, the options of the second drop-down will need to update dynamically. Woh.

Leave a comment!

  • 2019-07-22 Mike

    I found out, that you don't need to set the errorPath explicitly.

    This is dynamic:


    $errorPath = null !== $constraint->errorPath ? $constraint->errorPath : $fields[0];

                    $this->context->buildViolation($constraint->message)
                        ->atPath($errorPath)
                        ->setParameter('{{ value }}', $value->$fieldName)
                        ->addViolation();

    Btw. thanks SymfonyCast Team for your outstanding work!

  • 2019-03-28 Diego Aguiar

    Ah, sorry about that. I forgot to mention that step

  • 2019-03-28 Çağlar

    Thanks for helps. I also called atPath function in "UniqueUserValidator" to make it work:

    $this->context->buildViolation($constraint->message)
    ->atPath($constraint->errorPath)
    ->setParameter('{{ value }}', $value->email)
    ->addViolation();

  • 2019-03-27 Diego Aguiar

    Ohh, you created a Class constraint instead of a Property constraint, that's why the error appears as a global error, you can manipulate the error path by defining a public property "errorPath" on your constraint class. Then just set that value on your annotations:


    /**
    * @UniqueUser(
    * fields={"email"}
    * errorPath="email"
    * )
    */
    class UserFormModel
  • 2019-03-25 Çağlar

    The other validations' origin is their fields, I did not activate error_bubling. I think it is not weird, it just does not know on which field it needs to show error. I tried to imitate "UniqueEntity" to show it field but I could not make it work.
    UniqueUser:
    /**
    * @Annotation
    * @Target({"CLASS", "ANNOTATION"})
    */
    class UniqueUser extends Constraint
    {
    public $fields = [];
    public function getRequiredOptions()
    {
    return ['fields'];
    }
    public function getDefaultOption()
    {
    return 'fields';
    }

    /**
    * {@inheritdoc}
    */
    public function getTargets()
    {
    return self::CLASS_CONSTRAINT;
    }

    /*
    * Any public properties become valid options for the annotation.
    * Then, use these in your validator class.
    */
    public $message = 'The email "{{ value }}" is already used by another user.';
    }

    UserFormModel:
    /**
    * @UniqueUser(
    * fields={"email"}
    * )
    */
    class UserFormModel
    {
    public $id;

    /**
    * @Assert\NotBlank()
    */
    public $name;

    /**
    * @Assert\NotBlank()
    * @Assert\Email()
    */
    public $email;

    UniqueUserValidator:
    class UniqueUserValidator extends ConstraintValidator
    {
    private $userRepository;

    public function __construct(UserRepository $userRepository)
    {
    $this->userRepository = $userRepository;
    }

    public function validate($value, Constraint $constraint)
    {
    $existingUser = $this->userRepository->findOneByEmail($value->email, $value->id);

    if (!$existingUser) {
    return;
    }

    /* @var $constraint \App\Validator\UniqueUser */

    $this->context->buildViolation($constraint->message)
    ->setParameter('{{ value }}', $value->email)
    ->addViolation();
    }
    }

  • 2019-03-25 Diego Aguiar

    Hey @Çağlar

    That's a bit weird. Did you activate the "error_bubling" property on your form field?

    Cheers!

  • 2019-03-24 Çağlar

    I followed the instructions to validate email on edit form. It works but it shows validator message on the top of the form. How can I change back the error's origin to email field?

  • 2019-03-15 Diego Aguiar

    Hey Paul Steven

    How did you build your login form? If you did it manually, then you will have to print those errors manually as well

    Cheers!

  • 2019-03-14 Paul Steven

    My email & password validation error messages aren't showing anymore :( They are visible in the Profiler.validator calls but not being written to the page... Any ideas where I've went wrong?

  • 2018-12-31 weaverryan

    Hey Kris!

    Ah, very clever of you! But... nope! The reason an entity is not a service is not *actually* because it's an entity.. and so that makes it special somehow. The key thing is that an "entity" is something that we do NOT want handled by the container. Why? Because the container will only ever allow a single instance of an object. And so, these "data-holding" object don't fit well int that model. For example, if I want to display 10 products on a page, it TOTALLY makes sense to have 10 Product entity objects.

    Let me say it a different way. If you code cleanly, you will have 2 different types of classes/objects

    A) Simple model objects: objects that hold data but don't really do much work. It makes sense to have multiple instances of these objects at any given time. An entity is an example of this, but so UserRegistrationFormModel

    B) Service objects: objects that do not hold much data (maybe just some config) and primarily do work. An important property of these is that it only makes sense to have ONE instance of these classes ever. For example, think of some "mailer" object. If you need to send 5 emails, do you need 5 Mailer instances? Nope - just 1 - and you would call some "sendEmail" message on it 5 times (just an example). THESE are the objects that the container is meant to instantiate.

    Now, for your specific situation :). Do to how "friendly" Symfony's config is, you technically CAN use UserRegistrationFormModel as a service - Symfony just sees this as a class, and so if you, for example, add UserRegistrationForModel as an argument to a controller, Symfony will say "Oh, that must be a service, let's instantiate it, autowire all its arguments, and pass it in". But, this is improper use, and it'll bite you eventually. Most importantly, it starts to "blur" that clean distinction between model classes and service classes.

    Let me know if that makes sense. What you're thinking is not surprising - I was actually wondering if this aspect would begin to confuse people :).

    Cheers!

  • 2018-12-29 Kris

    Hi, on video you said:

    But, it has one limitation: because the method lives inside an entity class - we do not have access to any services. In our case, in order to know whether or not the email is taken yet, we need to make a query and so we do need to access a service.


    ..but our UserRegistrationFormModel isn't entity ;] and we can use autowiring ;]

Edit on Github
Previous Chapter
Next Chapter