Affichage conditionnel des saisies : syntaxe des tests
Les saisies peuvent recevoir une option afficher_si
qui permet de conditionner leur affichage en fonction de la valeur d’une ou plusieurs autres saisies.
Ceci peut être utile par exemple pour faire varier les questions en fonction de la réponse à des questions précédentes.
Cet article décrit la syntaxe utilisable dans les conditions. Pour la manière de gérer ces saisies conditionnelles, voir l’article : « Génération de saisies conditionnelles avec afficher_si
».
Il correspond à l’état des tests possibles avec :
- la version 3.55.0 du plugin Saisies pour SPIP < 4.0 ;
- la version 4.2.0 du plugin pour SPIP ≥ 4.0.
Rappel : moment des tests
Le test des valeurs se fait selon deux modes différents :
- côté navigateur, en JavaScript ;
- côté serveur, en PHP.
Cette double validation est nécessaire non seulement en termes d’accessibilité, mais aussi pour éviter d’avoir des messages d’erreur sur des champs obligatoires, mais dont l’affichage est conditionné par la valeur d’un autre champ, et donc qui ne sont pas tout le temps obligatoires.
C’est pourquoi les possibilités de tests sont limitées, mais suffisamment souples pour couvrir un large usage.
Dans la suite du présent article, tout ce qui est entre <
et >
doit être remplacé par une valeur réelle.
Syntaxe de base
Un test simple se décompose ainsi :
-
!
opérateur facultatif de négation, inverse la suite du test ; -
@<nom du champ>@
obligatoire ; -
:TOTAL
(facultatif) immédiatement après le second arobase, pour compter le nombre de valeur d’un champ (voir plus bas), depuis la version 3.30.0 du plugin Saisies ; -
opérateur
parmi :-
==
test d’égalité avec<valeur>
; -
!=
test d’inégalité avec<valeur>
; - « > » test de supériorité avec
<valeur>
: - « >= » test de supériorité ou d’égalité avec
<valeur>
; - « <" test d’infériorité avec
<valeur>
; - »<=" test d’infériorité ou d’égalité avec
<valeur>
; - « MATCH » pour vérifier qu’une chaîne valide une expression régulière, depuis la version 3.41.0 du plugin Saisies, cf. la section détaillée ;
- « !MATCH » pour vérifier qu’une chaîne ne valide pas une expression régulière, depuis la version 3.41.0 du plugin Saisies, cf. la section détaillée ;
-
IN
vérifie l’appartenance à un ensemble de valeurs, cf. la section détaillée ; -
!IN
vérifie la non appartenance à un ensemble de valeurs, cf. la section détaillée ;
-
-
"<valeur>"
ou'<valeur>'
ou<valeur_numerique_entiere>
la valeur à tester :- pour les champs de type clé/valeur (bouton radio, liste déroulante, etc.), il s’agit de la valeur de la clé et non pas de la valeur lisible par les humain·e·s ;
- la présence de guillemet est obligatoire, sauf si vous voulez tester une valeur numérique entière.
Exemples
@champ_1@ == "oui"
vérifie que le champ_1
est égal à « oui ».
@champ_1@ != "oui"
vérifie que le champ_1
est différent de « oui ».
Tests sur les expressions régulières
La syntaxe @<champ>@ MATCH '/<regexp>/<modificateur facultatif>'
permet de vérifier que le champ <champ>
suit une expression régulière.
Il faut être faire attention aux contraintes suivantes :
- l’expression régulière doit être systématiquement entre
/
; - l’expression régulière et ses modificateurs doivent être valides à la fois :
On pourrait utiliser un site comme https://regex101.com/ pour tester les expressions régulières.
À l’inverse la syntaxe @<champ>@ !MATCH '/<regexp>/<modificateur facultatif>'
permet de vérifier que le champ <champ>
ne suit pas une expression régulière.
Exemples
@input_1@ MATCH '/@domaine.ext$/'
vérifie que la valeur du champ input_1
finit par @domaine.ext
.
@input_1@ !MATCH '/@domaine.ext$/'
vérifie que la valeur du champ input_1
ne finit pas par @domaine.ext
.
L’opérateur IN
L’opérateur IN
prend un sens différent selon que la saisie testée prend une valeur unique (par exemple pour les boutons radios) ou une valeur multiple (par exemple pour les cases à cocher).
IN
pour les champs à valeur unique
Pour les champs à valeur unique, IN permet de s’assurer que le champ a une valeur appartenant à une liste de valeurs à tester, séparés par une virgule.
Exemple
@radio_1@ IN "choix1,choix2,choix3"
Vérifie que radio_1
vaut choix1
ou choix2
ou choix3
.
L’opérateur inverse !IN
permet de s’assurer que le champ ne vaut aucune de ces valeurs.
@radio_1@ !IN "choix1,choix2,choix3"
Vérifie que radio_1
vaut ni choix1
ni choix2
ni choix3
.
IN
pour les champs à valeur multiple
Les cases à cocher multiples et les sélections multiples renvoient des tableaux, et non pas de simples chaînes. Comment tester qu’une valeur est cochée ? En utilisant l’opérateur IN
. <valeur>
doit contenir la liste des valeurs à tester, séparées par des virgules.
Exemple
@checkbox_1@ IN "a,b"
Vérifie que la clé a
ou la clé b
est cochée pour le champ chechbox_1
.
Attention : pour que la condition soit vérifiée, il faut et il suffit qu’une seule ou plusieurs des valeurs cochées, mais pas nécessairement toutes, figure(nt) dans la liste des valeurs à droites du IN.
L’opérateur inverse !IN
vérifie qu’aucune des valeurs de <valeur>
n’est cochée.
Exemple
@checkbox_1@ !IN "a,b"
Vérifie que NI la clé a
NI la clé b
ne sont cochées dans le champ @checkbox_1@
.
Test sur le nombre de cases cochées / de fichiers envoyés
Depuis la version 3.30.0 du plugin il est possible de tester :
- le nombre de cases cochées pour une saisie checkbox
- le nombre de fichiers envoyées pour une saisies fichiers
de CVT-Upload.
Pour ce faire, la syntaxe est la même.
@<champ>@:TOTAL <operateur> <valeur>
Exemples
Pour vérifier que deux cases au moins sont cochées :
@checkbox@:TOTAL > 1
Avec cvt_upload, pour vérifier si l’on a plus de 2 fichiers envoyés :
@fichiers_1@:TOTAL > 2
Test simplifié
Pour les champs de type « case à cocher » unique, où il importe essentiellement de vérifier si la case est cochée, il est possible de faire un simple test : @<champ>@
, sans <opérateur>
ni "<valeur>"
. Un !
peut être mis avant @<champ>@
.
Mieux vaut cependant être explicite et tester @<champ>@ == "on"
ou @<champ>@ != "on"
.
Tests combinés
Il est possible de combiner les tests de plusieurs champs en utilisant les opérateurs booléens communs à PHP et à JavaScript, à savoir :
- ||
pour OU ;
- &&
pour ET ;
- !
pour NON ;
- ainsi que ()
pour regrouper des tests.
Exemples
@champ_1@ == "oui" || @champ_2@ == "oui"
Affiche la saisie si champ_1
est égal à oui
ou bien si champ_2
est égal à oui
, ou si les deux sont égaux à oui
.
@champ_1@ == "oui" && @champ_2@ == "oui"
Affiche la saisie si champ_1
est égal à oui
ET si champ_2
est égal à oui
.
(@champ_1@ == "oui" || @champ_2@ == "oui") && ! (@champ_1@ == "oui" && @champ_2@ == "oui")
Affiche la saisie si champ_1
est égal à oui
OU si champ_2
est égal à oui
, mais pas si les deux sont égaux à oui
en même temps.
Tester la présence de plugin
La syntaxe @plugin:<préfix>@
permet de tester que le plugin de préfixe <préfix>
est activé. Réciproquement, !@plugin:<préfix>@
permet de vérifier que ce plugin n’est pas activé.
Exemple
@plugin:article_pdf@
N’affiche la saisie que si le plugin article_pdf
est activé.
Tester la valeur d’une configuration
La syntaxe @config:<champ>:<sous_champ>@
ou @config:<champ>/<sous_champ>@
permet de tester la valeur de la configuration <champ>/<sous_champ>
avec lire_config()
(équivalent PHP de #CONFIG
).
Exemple
Pour tester si le nom du site est égal à « Mon site SPIP » :
@config:nom_site@ == "Mon site SPIP"
La profondeur des sous-champs est illimitée [1].
Résumé
Sont gérés avec afficher_si
:
- les tests de valeur de champ
@<champ>@
et"<valeur>"
/'<valeur>'
; - le nombre de valeurs retenues dans une saisie à plusieurs valeurs :
@<saisie>@:TOTAL
; - les tests de présence de plugin
@plugin:<plugin>@
; - les tests de valeur de configuration
@config:<config>@
; - les égalités et inégalités :
==
et!=
; - les expressions régulières
MATCH
et!MATCH
; - la présence ou l’absence d’une valeur pour un champ à valeurs multiples :
IN
et!IN
; - la combinaison de tests :
!
,&&
,||
,()
.
Tout le reste n’est pas géré :
- côté PHP, tout test qui contient autre chose sera purement et simplement ignoré ;
- côté JS, cela risque de planter.
Notes
[1] Depuis la version 3.11.0 du plugin saisies
.