Vérifier

Publié le : 27 mai 2011 – Dernière modification le 28 mai 2023 – par RastaPopoulos – 34 commentaires

1
2
3
4
5
28 votes
Une API générique pour vérifier une valeur.

Introduction

Ce plugin est un outil de dévelopement. Il propose une API basée sur une fonction centrale verifier($valeur, $type, $options) permettant de vérifier qu’une valeur correspond à un critère.

Pour cela, l’API se base sur le même principe d’extension que la fonction autoriser() de SPIP : on peut écrire autant de fonctions qu’on veut, qui définissent un « type » de vérification particulier.

Retours

La fonction retourne une chaîne vide si la vérification se passe bien. Et retourne une chaîne expliquant l’erreur si ce n’est pas concluant.

On peut donc utiliser le retour de cette fonction directement comme information dans la fonction verifier() d’un formulaire CVT.

Montrez moi le code ! 

// On charge la fonction centrale
$verifier = charger_fonction('verifier', 'inc/');

// On l'utilise
$verifier($valeur, $type_de_test, $options_enventuelles);

// Concrètement
$valeur_test = 50;
$erreur = $verifier($valeur_test, 'entier'); // C'est bon ! $erreur = ""
$erreur = $verifier($valeur_test, 'entier', array('min'=>100)); // C'est pas bon ! $erreur = "Une explication de l'erreur"

Quelles sont les possibilités ?

Vous trouverez la liste des vérifications actuellement disponibles par ici : Références des vérifications.

Ajouter des vérifications

Pour ajouter une vérification, il faut écrire un fichier verifier/truc.php avec dedans une fonction verifier_truc_dist($valeur, $options=array()) et retourner une chaîne vide ou non, comme décrit précédemment.

function verifier_truc_dist($valeur, $options=array()){
	// Je fais des tests et c'est bon
	if ($valeur == 'ok')
		return '';
	// Et si c'est pas bon
	else
		// J'explique pourquoi
		return _T('une_explication');
}

Utilisation auto-magique avec le plugin Saisies

Lorsqu’on décrit une liste de saisies sous forme de tableau normalisé, il est possible de déclarer une vérification à faire pour une saisie. On peut alors passer la liste entière dans la fonction saisies_verifier($saisies) et... magie !

$saisies = array(
	array(
		'saisie' => 'input',
		'options' => array(
			'nom' => 'test',
			'label' => 'Un nombre entre 100 et 500',
			'obligatoire' => 'oui'
		),
		'verifier' => array(
			'type' => 'entier',
			'options' => array(
				'min' => 100,
				'max' => 500
			)
		)
	),
);

include_spip('inc/saisies');
$erreurs = saisies_verifier($saisies); // Et hop pour le verifier() de CVT !

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

4 discussions

  • 3
    JLuc

    Coucou bonjour,
    Peut on faire appel à des vérifications dans les paramètres d’une #SAISIE dans un squelette ?
    Je trouve pas de doc mais ça été fait dans le plugin ICS par exemple : https://git.spip.net/spip-contrib-extensions/import_ics/src/branch/master/formulaires/editer_almanach.html#L19 ... sauf que ça ne semble pas marcher quand j’essaie avec :

    [(#SAISIE{input,numero,
  label=Numéro,
  verifier=#ARRAY{type,entier}
})]

    dans un formulaire de configuration défini par son HTML seul.

    • RastaPopoulos

      Nope, ça n’a aucun sens, puisque #SAISIE c’est juste un #INCLURE, un squelette HTML. Alors que verifier c’est du PHP.

      La doc (ici ou sur Saisies) explique bien : c’est dans une description en tableau PHP.

    • JLuc

      Ah Ok du coup j’ai créé un ticket pour ics.
      Mais les #SAISIES sont bien associées à du php quelque part puisque ça s’enregistre en config. S’il y a un traiter() automagique, ne pourrait il pas y avoir un verifier() ?

    • RastaPopoulos

      Non, pas du tout, les #SAISIE ne sont associés à aucun PHP. Ça génère des champs « name=truc » en HTML, et ensuite c’est l’API « CVT Configurer » du core qui lit ça, et qui enregistre les valeurs en meta, sans aucun rapport avec Saisies. Ce qu’il lit c’est juste les « name=truc » finaux.

    Répondre à ce message

  • 2
    Thrax

    Est-ce possible de faire deux vérifications successives, en utilisation auto-magique avec le plugin Saisies (une liste de saisies sous forme de tableau normalisé), pour une même saisie ?

    $saisies = array(
	array(
		'saisie' => 'input',
		'options' => array(
			'nom' => 'test',
			'label' => 'Un nombre pair entre 100 et 500',
			'obligatoire' => 'oui'
		),
		'verifier' => array(
			'type' => 'entier',
			'options' => array(
				'min' => 100,
				'max' => 500
			)
		)
		'verifier' => array(
			'type' => 'nombre_pair', // vérification créée pour le plaisir
			'options' => array(
				'suggestion' => 'superieure',
			)
		)
	),
);

    Il semble que la succession de ces déclarations rendent inopérantes toutes les vérifications.

    La solution que je vois serait de créer une vérification (en fonction) qui vérifie l’ensemble des vérifications souhaitées, mais avant de le faire, je souhaite m’assurer que l’on ne puisse pas simplement déclarer successivement une liste de vérification sous forme de tableau normalisé.

    Merci par avance pour votre aide.

    • Maïeul

      Non, il n’y a pas de mecanisme pour permettre plusieurs verifications. Avec ta syntaxe là seule la dernière verification sera effectuée, car c’est la seule qui restera dans le tableau.

      1. Effectivement je conseille de créer une verification qui effectue elle même plusieurs verif
      2. Cela étant on pourrait imaginer d’étendre la syntaxe des verif automagique de saisies, à voir comment cependant (notamment pour ne pas casser le fonctionnement existant)

    • Thrax

      Merci Maïeul pour ta réponse.

    Répondre à ce message

  • 1
    clyde

    Bonjour,
    J’ai encore un site en php 5.3.3 donc spip 3.1 et j’ai une erreur fatale sur le fichier verifier/telephone.php.

    La « short syntax arrays » est utilisée à 2 endroits dans ce fichier :
    ligne 109 :

    foreach (['fixe', 'mobile', 'all'] as $format_test) {

    à remplacer par

    foreach (array('fixe', 'mobile', 'all') as $format_test) {

    et ligne 135 :

    if (!in_array($what, [$format, 'all']) and preg_match($pattern, $tel)){

    à remplacer par

    if (!in_array($what, array($format, 'all')) and preg_match($pattern, $tel)){

    Merci !

    • Maïeul

      corriger sur git, je releaserai ce week-end (histoire de pas releaser tous les jours)

    Répondre à ce message

  • 6
    tcharlss

    Il me semble que dans l’exemple de code (« Montrez moi le code ! »), si on fait charger_fonction(), du coup il n’y a pas besoin de include_spip() non ?

    • RastaPopoulos

      C’est corrigé merci

    • jeanmarie

      Salut, je finalise mon mémo Tutoriel : créer des champs extras depuis un plugin mais je me rends compte que la vérification ne marche pas parce que je ne charge pas la fonction centrale.

      Mais je ne vois pas où mettre charger_fonction() ou include_spip() ?

    • RastaPopoulos

      Je ne vois pas de quoi tu parles. Si c’est la déclaration dans les saisies, bah c’est pas du tout toi-même qui fait les vérifications, c’est saisie automatiquement, et c’est censé utiliser saisies_verifier non ? Enfin en fait je ne sais pas ce que fait champs extras, mais c’est ce qui utilise les saisies qui lance les vérifications, pas toi, donc bah ya rien à faire.

    • jeanmarie

      Je dois rater un truc car la vérification ne fonctionne pas.

      Dans http://spip.pastebin.fr/63220 , je peux rentrer n’importe quoi dans mes champs adresse_spotify/adresse_qobuz alors que j’ai une vérification L32 (sur le fieldset contenant les input mais idem si je le mets directement sur les saisies input).

    • RastaPopoulos

      ça n’existe pas une vérification sur une fieldset, ça ne veut rien dire :)

    • jeanmarie

      Ah ok, je me disais que ça s’appliquait sur les champs à l’intérieur :)

      Effectivement, c’est bon sur la saisie input ! Pourtant, j’avais essayé ça aussi, mais pas comme il faut sans doute :/

      Merci en tout cas.

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom