Browse Source

PHPDoc

svn/attic/verifier/117540
tcharlss@bravecassine.com 5 years ago
parent
commit
e8645fb6d4
  1. 9
      inc/verifier.php
  2. 8
      verifier/code_postal.php
  3. 8
      verifier/comparaison_champ.php
  4. 8
      verifier/couleur.php
  5. 8
      verifier/date.php
  6. 10
      verifier/decimal.php
  7. 8
      verifier/email.php
  8. 8
      verifier/entier.php
  9. 8
      verifier/fichiers.php
  10. 10
      verifier/id_document.php
  11. 8
      verifier/id_objet.php
  12. 15
      verifier/image_upload.php
  13. 13
      verifier/image_upload_multiple.php
  14. 18
      verifier/isbn.php
  15. 9
      verifier/password.php
  16. 9
      verifier/regex.php
  17. 8
      verifier/siren_siret.php
  18. 8
      verifier/taille.php
  19. 8
      verifier/telephone.php
  20. 21
      verifier_fonctions.php

9
inc/verifier.php

@ -1,4 +1,12 @@
<?php
/**
* Fonctions de l'API de vérification
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {
@ -7,6 +15,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
/**
* Fonction de base de l'API de vérification.
*
* @param mixed $valeur La valeur a verifier.
* @param string $type Le type de verification a appliquer.
* @param array $options Un eventuel tableau d'options suivant le type.

8
verifier/code_postal.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un code postal
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

8
verifier/comparaison_champ.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : Comparaison de champs
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

8
verifier/couleur.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un code couleur
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

8
verifier/date.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'une date
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

10
verifier/decimal.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un nombre décimal
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {
@ -6,7 +14,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
}
/**
* Vérifie qu'un entier cohérent peut être extrait de la valeur
* Vérifie qu'un nombre décimal cohérent peut être extrait de la valeur
* Options :
* - min : valeur minimale acceptée
* - max : valeur maximale acceptée

8
verifier/email.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'una adresse de courriel
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

8
verifier/entier.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un nombre entier
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

8
verifier/fichiers.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un envoi de fichiers
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined("_ECRIRE_INC_VERSION")) {

10
verifier/id_document.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un identifiant de document
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {
@ -6,7 +14,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
}
/**
* Vérifie que la valeur correspond à un id_dcoument valide
* Vérifie que la valeur correspond à un id_document valide
*
* @param string $valeur
* La valeur à vérifier.

8
verifier/id_objet.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un ientifiant d'objet
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

15
verifier/image_upload.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification d'un upload d'image
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined("_ECRIRE_INC_VERSION")) {
@ -7,7 +15,12 @@ if (!defined("_ECRIRE_INC_VERSION")) {
/**
* Vérifier un upload d'image unique
* Cette fonction est depréciée, on utilisera de préférence la vérification 'fichiers', plus souple, et à laquelle la présente fonction renvoie.
*
* Cette fonction est depréciée, on utilisera de préférence la vérification 'fichiers', plus souple, et à laquelle la présente fonction renvoie.
*
* @deprecated
* @see verifier/fichiers.php
*
* @param array $valeur
* Le sous tableau de $_FILES à vérifier, $_FILES['logo'] par exemple
* Doit être un champ avec un seul upload

13
verifier/image_upload_multiple.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification d'un upload d'image
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined("_ECRIRE_INC_VERSION")) {
@ -9,7 +17,10 @@ if (!defined("_ECRIRE_INC_VERSION")) {
* Vérifier un upload d'image unique ou multiple
*
* Cette fonction n'est conservée que pour compatibilité ascendant.
* Lui préferer la vérification 'fichiers', qui possède plus d'options, et qui est d'ailleurs appeler ici.
* Lui préferer la vérification 'fichiers', qui possède plus d'options, et qui est d'ailleurs appelée ici.
*
* @deprecated
* @see verifier/fichiers.php
*
* @param array $valeur
* Le sous tableau de $_FILES à vérifier

18
verifier/isbn.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un numéro ISBN
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {
@ -6,9 +14,9 @@ if (!defined('_ECRIRE_INC_VERSION')) {
}
/**
* Validation d'un numero ISBN
* Validation d'un numéro ISBN
*
* d apres https://fr.wikipedia.org/wiki/Numéro_ISBN
* d'après https://fr.wikipedia.org/wiki/Numéro_ISBN
* ISBN-13 : longeur totale 13 caracteres divises en 5 segments de la forme G - A - B - C - K
* G: 3 caracteres (978 ou 979)
* A: de 1 a 5 caracteres (code de la zone geographique)
@ -21,9 +29,9 @@ if (!defined('_ECRIRE_INC_VERSION')) {
* K: 1 caractere entre 0 et 9, ou X (cle de controle calculee d apres les autres chiffres)
* ex: 2-1234-5680-X
*
* Avec un numero ISBN comportant des tirets, on pourrait utiliser une regex
* pour verifier que chaque segment comporte le nombre adequat de caracteres.
* Cependant ca ne permet pas d indiquer precisement la nature de l erreur.
* Avec un numéro ISBN comportant des tirets, on pourrait utiliser une regex
* pour vérifier que chaque segment comporte le nombre adequat de caractères.
* Cependant ça ne permet pas d'indiquer précisement la nature de l'erreur.
* La regex au cas ou : "/^(97[89][- ]){0,1}[0-9]{1,5}[- ][0-9]{1,7}[- ][0-9]{1,6}[- ][0-9X]$/"
*
*

9
verifier/password.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un mot de passe
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
@ -6,6 +14,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
/**
* Vérifie les passwords
*
* Options :
*
* - match : Nom du champ avec lequel le password dois correspondre

9
verifier/regex.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'une valeur selon une expression régulière
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {
@ -7,6 +15,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
/**
* Vérifié une valeur suivant une expression régulière.
*
* Options :
* - modele : chaine représentant l'expression
*

8
verifier/siren_siret.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un numéro SIREN/SIRET
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

8
verifier/taille.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la taille (nb de caractères) d'une valeur
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

8
verifier/telephone.php

@ -1,4 +1,12 @@
<?php
/**
* API de vérification : vérification de la validité d'un numéro de téléphone
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {

21
verifier_fonctions.php

@ -1,9 +1,30 @@
<?php
/**
* Fonctions utiles au plugin API de vérification
*
* @plugin verifier
* @copyright 2018
* @author Les Développements Durables
* @licence GNU/GPL
* @package SPIP\Verifier\Fonctions
*/
// Sécurité
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
/**
* Liste toutes les vérifications possibles
*
* @uses verifier_lister_disponibles()
* @filtre verifier_lister_disponibles
*
* @param string $repertoire
* Dans quel repertoire chercher les yaml.
* @return array
* Un tableau listant les vérifications et leurs options
*/
function filtre_verifier_lister_disponibles_dist($repertoire = 'verifier') {
include_spip('inc/verifier');

Loading…
Cancel
Save