Come creare vincoli di validazione personalizzati¶

È possibile creare vincoli personalizzati estendendo la classe base Constraint. Come esempio, creeremo un semplice validatore, che verifica se una stringa contenga solo caratteri alfanumerici.

Creare la classe Constraint¶

Innanzitutto, occorre creare una classe Constraint, che estenda Constraint:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

// src/Acme/DemoBundle/Validator/Constraints/ContainsAlphanumeric.php
namespace Acme\DemoBundle\Validator\Constraints;

use Symfony\Component\Validator\Constraint;

/**
 * @Annotation
 */
class ContainsAlphanumeric extends Constraint
{
    public $message = 'The string "%string%" contains an illegal character: it can only contain letters or numbers.';
}

Creare il validatore¶

Come si può vedere, un vincolo è estremamente minimalistico. La validazione vera e propria è effettuata da un'altra classe di "validazione dei vincoli". La classe per la validazione dei vincoli è definita dal metodo del vincolo validatedBy(), che usa una semplice logica predefinita:

1
2
3
4
5

// nella classe base Symfony\Component\Validator\Constraint
public function validatedBy()
{
    return get_class($this).'Validator';
}

In altre parole, se si crea un Constraint, ovvero un vincolo, personalizzato (come MioVincolo), Symfony2, automaticamente, cercherà anche un'altra la classe, MioVincoloValidator per effettuare la validazione vera e propria.

Anche la classe validatrice è semplice e richiede solo un metodo obbligatorio: validate:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

// src/Acme/DemoBundle/Validator/Constraints/ContainsAlphanumericValidator.php
namespace Acme\DemoBundle\Validator\Constraints;

use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;

class ContainsAlphanumericValidator extends ConstraintValidator
{
    public function validate($value, Constraint $constraint)
    {
        if (!preg_match('/^[a-zA-Za0-9]+$/', $value, $matches)) {
            $this->context->addViolation($constraint->message, array('%string%' => $value));
        }
    }
}

New in version 2.1: Il metodo isValid è stato rinominato validate in Symfony 2.1. Il metodo setMessage è stato deprecato, a favore della chiamata ad addViolation sul contesto.

Usare il nuovo validatore¶

Usare il nuovo validatore è molto facile, come quelli forniti da Symfony2:

Se il proprio vincolo contiene opzioni, dovrebbero essere proprietà pubbliche nella classe Constraint creata in precedenza. Tali opzioni possono essere configurate, come le opzioni dei vincoli del nucleo di Symfony.

1
2
3
4

public function validatedBy()
{
    return 'nome_alias';
}

1
2
3
4

public function getTargets()
{
    return self::CLASS_CONSTRAINT;
}

1
2
3
4
5
6
7
8
9

class ProtocolClassValidator extends ConstraintValidator
{
    public function validate($protocol, Constraint $constraint)
    {
        if ($protocol->getFoo() != $protocol->getBar()) {
            $this->context->addViolationAtSubPath('foo', $constraint->message, array(), null);
        }
    }
}