From 12cfb6aa23cbefb7b5027033d994abc29cc4b752 Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Mon, 12 Jul 2021 23:56:54 +0200 Subject: [PATCH] doc: improve contrib / LSformRules section --- doc/contrib/contrib.docbook | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/contrib/contrib.docbook b/doc/contrib/contrib.docbook index 50136b17..23f816c3 100644 --- a/doc/contrib/contrib.docbook +++ b/doc/contrib/contrib.docbook @@ -660,7 +660,16 @@ les possibilités de contribution. Cette méthode devra retourner True ou False si la valeur testée est respectivement valide ou - invalide. + invalide. Elle pourra également déclencher une exception LSformRuleException qui lui permettra de donner des messages + d'erreurs elle-même sur le(s) problème(s) detecté(s) durant l'analyse de la valeur passée. Le constructeur de ce type d'exception prend + en tant que premier paramètre un tableau de messages d'erreurs (ou un simple message d'erreur) qui seront retournés à l'utilisateur. + + Par défaut, les valeurs de l'attribut sont testées une à une via la méthode validate(). Cependant, il est + possible d'implémenter une méthode de validation pour toutes les valeurs de l'attribut en une seule fois en affectant la valeur + false à la constante de classe validate_one_by_one. Dans ce cas, l'ensemble des valeurs de l'attribut seront + passées via le paramètre $value à la méthode validate() (sous la forme d'un tableau). Cela pourra par + exemple être utile pour implémenter une validation de la cohérence des valeurs les unes vis à vis des autres (unicité, nombre maximum de + valeurs, …).