Validateurs

Note

Le module Validators utilise la classe statique ValidatorsManager pour gérer la validation.

La validation permet de vérifier que les données membres d’un objet respectent certaines contraintes.

Ajout de validators

Soit la classe Author que nous souhaitons utiliser dans notre application :

app/models/Author.php

     namespace models;

     class Author {
             /**
              * @var string
              * @validator("notEmpty")
              */
             private $name;

             public function getName(){
                     return $this->name;
             }

             public function setName($name){
                     $this->name=$name;
             }
     }

Une contrainte de validation a été ajoutée sur le membre name avec l’annotation @validator, de façon à rendre sa saisie obligatoire.

Génération du cache

Exécuter cette commande dans la console pour générer le cache de la classe Author :

Ubiquity init-cache -t=models

Le cache du validateur est généré dans le fichier app/cache/contents/validators/models/Author.cache.php.

Validation d’instances

Une instance

public function testValidateAuthor(){
        $author=new Author();
        //Do something with $author
        $violations=ValidatorsManager::validate($author);
        if(sizeof($violations)>0){
                echo implode('<br>', ValidatorsManager::validate($author));
        }else{
                echo 'The author is valid!';
        }
}

Si le name de l’instance de author est vide, l’action devrait afficher :

name : This value should not be empty

La méthode validate retroune un tableau d’instances de ConstraintViolation .

Plusieurs instances

public function testValidateAuthors(){
        $authors=DAO::getAll(Author::class);
        $violations=ValidatorsManager::validateInstances($author);
        foreach($violations as $violation){
                echo $violation.'<br>';
        }
}

Génération des models avec validateurs par défaut

Lorsque les classes sont générées automatiquement à partir de la base de données, des validateurs par défaut sont associés aux membres, basés su les méta-données des champs.

Ubiquity create-model User

app/models/Author.php

     namespace models;
     class User{
             /**
              * @id
              * @column("name"=>"id","nullable"=>false,"dbType"=>"int(11)")
              * @validator("id","constraints"=>array("autoinc"=>true))
             **/
             private $id;

             /**
              * @column("name"=>"firstname","nullable"=>false,"dbType"=>"varchar(65)")
              * @validator("length","constraints"=>array("max"=>65,"notNull"=>true))
             **/
             private $firstname;

             /**
              * @column("name"=>"lastname","nullable"=>false,"dbType"=>"varchar(65)")
              * @validator("length","constraints"=>array("max"=>65,"notNull"=>true))
             **/
             private $lastname;

             /**
              * @column("name"=>"email","nullable"=>false,"dbType"=>"varchar(255)")
              * @validator("email","constraints"=>array("notNull"=>true))
              * @validator("length","constraints"=>array("max"=>255))
             **/
             private $email;

             /**
              * @column("name"=>"password","nullable"=>true,"dbType"=>"varchar(255)")
              * @validator("length","constraints"=>array("max"=>255))
             **/
             private $password;

             /**
              * @column("name"=>"suspended","nullable"=>true,"dbType"=>"tinyint(1)")
              * @validator("isBool")
             **/
             private $suspended;
     }

Ces validateurs peuvent être modifiés.
Les modifications doivent toujours être suivies d’une ré-initialisation du cache des models.

Ubiquity init-cache -t=models

Les informations relatives aux validateurs existants sur les models peuvent être affichées avec les devtools :

Ubiquity info:validation -m=User

Retourne les validateurs associés au champ email :

Ubiquity info:validation email -m=User

Les informations de validation sont également accessibles depuis la partie models des webtools :

Types de validators

Basic

Validator	Rôles	Contraintes	Valeurs acceptées
isBool	Vérifie si la valeur est un booléen		true,false,0,1
isEmpty	Vérifie si la valeur n’est pas vide		“”,null
isFalse	Vérifie si la valeur est false		false,”false”,0,”0”
isNull	Vérifie si la valeur est nulle		null
isTrue	Vérifie si la valeur est true		true,”true”,1,”1”
notEmpty	Vérifie si la valeur n’est pas vide		!null && !””
notNull	Vérifie si la valeur n’est pas nulle		!null
type	Vérifie que la valeur est du type {type}	{type}

Comparison

Dates

Multiples

Strings