From 88ed6de9793ba225d8969790b99a025c4dc89c0c Mon Sep 17 00:00:00 2001
From: "gilles.vincent@gmail.com" <>
Date: Thu, 29 Apr 2010 01:37:33 +0000
Subject: [PATCH] Documentation PHPDoc pour plus tard
---
inc/verifier.php | 4 ++--
verifier/date.php | 4 ++++
verifier/email.php | 20 ++++++++++++++------
verifier/entier.php | 12 ++++++++----
verifier/regex.php | 10 +++++++---
verifier/siren_siret.php | 9 +++++++--
verifier/taille.php | 4 ++++
verifier/telephone.php | 6 +++++-
verifier/url.php | 4 ++++
9 files changed, 55 insertions(+), 18 deletions(-)
diff --git a/inc/verifier.php b/inc/verifier.php
index db692a1..58503f6 100644
--- a/inc/verifier.php
+++ b/inc/verifier.php
@@ -3,7 +3,7 @@
// Sécurité
if (!defined("_ECRIRE_INC_VERSION")) return;
-/*
+/**
* 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.
@@ -40,7 +40,7 @@ function inc_verifier_dist($valeur, $type, $options=null){
return $erreur;
}
-/*
+/**
* Liste toutes les vérifications possibles
*
* @return Retourne un tableau listant les vérifications et leurs options
diff --git a/verifier/date.php b/verifier/date.php
index c4f6df0..65f5942 100644
--- a/verifier/date.php
+++ b/verifier/date.php
@@ -8,6 +8,10 @@ if (!defined("_ECRIRE_INC_VERSION")) return;
* TODO : introduire via les options le FORMAT de la date, pour accepter différentes écritures
* On pourrait faire mieux, genre vérifier les jours en fonction du mois
* Mais c'est pas très important, on reste simple
+ *
+ * @param string $valeur La valeur à vérifier.
+ * @param array $option tableau d'options [NON UTILISE].
+ * @return string Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
*/
function verifier_date_dist($valeur, $options=array()){
diff --git a/verifier/email.php b/verifier/email.php
index 8270436..d8d9551 100644
--- a/verifier/email.php
+++ b/verifier/email.php
@@ -3,8 +3,12 @@
// Sécurité
if (!defined("_ECRIRE_INC_VERSION")) return;
-/*
- * Verifie la validite d'une adresse de courriel.
+/**
+ * Vérifie la validité d'une adresse de courriel.
+ *
+ * @param string $valeur La valeur à vérifier.
+ * @param array $option Un éventuel tableau d'options.
+ * @return string Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
*/
function verifier_email_dist($valeur, $options=array()){
include_spip('inc/filtres');
@@ -36,10 +40,11 @@ function verifier_email_dist($valeur, $options=array()){
/**
* Changement de la RegExp d'origine
- * Non respect des RFC beaucoup trop souples à mon sens
- * On INTERDIT les mails dont les domaines ne sont pas "valides"
- * On INTERDIT les adresses qui comportent autre chose que des tirets / tirets bas / point
- * (même si les autres caractères sont autorisés, tant pis, ils sont trop rares)
+ *
+ * Respect de la RFC5322
+ * @link (phraseur détaillé ici : http://www.dominicsayers.com/isemail/)
+ * @param string $valeur La valeur à vérifier
+ * @return boolean Retourne true uniquement lorsque le mail est valide
*/
function verifier_email_de_maniere_stricte($valeur){
// Si c'est un spammeur autant arreter tout de suite
@@ -58,6 +63,9 @@ function verifier_email_de_maniere_stricte($valeur){
/**
* Vérifier que le courriel utilisé n'est pas
* déjà présent en base SPIP_AUTEURS
+ *
+ * @param string $valeur La valeur à vérifier
+ * @return boolean Retourne false lorsque le mail est déjà utilisé
*/
function verifier_disponibilite_email($valeur){
include_spip('base/abstract_sql');
diff --git a/verifier/entier.php b/verifier/entier.php
index 5de8d5d..af7a85b 100644
--- a/verifier/entier.php
+++ b/verifier/entier.php
@@ -3,11 +3,15 @@
// Sécurité
if (!defined("_ECRIRE_INC_VERSION")) return;
-/*
- * Verifie qu'un entier coherent peut etre extrait de la valeur
+/**
+ * Vérifie qu'un entier cohérent peut être extrait de la valeur
* Options :
- * - min : valeur minimale acceptee
- * - max : valeur maximale acceptee
+ * - min : valeur minimale acceptée
+ * - max : valeur maximale acceptée
+ *
+ * @param string $valeur La valeur à vérifier.
+ * @param array $option Si ce tableau associatif contient une valeur pour 'min' ou 'max', un contrôle supplémentaire sera effectué.
+ * @return string Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
*/
function verifier_entier_dist($valeur, $options=array()){
$erreur = _T('verifier:erreur_entier');
diff --git a/verifier/regex.php b/verifier/regex.php
index 7cca282..f70692e 100644
--- a/verifier/regex.php
+++ b/verifier/regex.php
@@ -3,10 +3,14 @@
// Sécurité
if (!defined("_ECRIRE_INC_VERSION")) return;
-/*
- * Verifie une valeur suivant une expression reguliere.
+/**
+ * Vérifié une valeur suivant une expression régulière.
* Options :
- * - modele : chaine representant l'expression
+ * - modele : chaine représentant l'expression
+ *
+ * @param string $valeur La valeur à vérifier.
+ * @param array $option Contient une chaine représentant l'expression.
+ * @return string Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
*/
function verifier_regex_dist($valeur, $options=array()){
if (preg_match($options['modele'], $valeur))
diff --git a/verifier/siren_siret.php b/verifier/siren_siret.php
index b284a77..733993f 100644
--- a/verifier/siren_siret.php
+++ b/verifier/siren_siret.php
@@ -4,13 +4,18 @@
if (!defined("_ECRIRE_INC_VERSION")) return;
/**
+ * Validation d'un SIREN ou d'un SIRET
+ *
* 1/ Un SIREN comporte STRICTEMENT 9 caractères
* 1b/ Un SIRET comporte strictement 14 caractères
* 2/ Un siren/siret utilise une clef de controle "1-2"
- * Un siren/siret est donc valide si la somme des chiffres paires
+ * Un siren/siret est donc valide si la somme des chiffres pairs
* + la somme du double de tous les chiffres impairs (16 = 1+6 = 7) est un multiple de 10
+ *
+ * @param string $valeur La valeur à vérifier.
+ * @param array $option Indique s'il faut tester le SIREN ou le SIRET.
+ * @return string Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
*/
-
function verifier_siren_siret_dist($valeur, $options=array()){
if (!$options['mode'] or !in_array($options['mode'], array('siren', 'siret'))){
$mode = 'siren';
diff --git a/verifier/taille.php b/verifier/taille.php
index 6bbb5d1..4d4d892 100644
--- a/verifier/taille.php
+++ b/verifier/taille.php
@@ -5,6 +5,10 @@ if (!defined("_ECRIRE_INC_VERSION")) return;
/**
* Vérifier une taille minimale/maximale, pour un mot de passe par exemple
+ *
+ * @param string $valeur La valeur à vérifier.
+ * @param array $option Les éléments à vérifier (min, max, egal).
+ * @return string Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
*/
function verifier_taille_dist($valeur, $options=array()){
diff --git a/verifier/telephone.php b/verifier/telephone.php
index 132280f..cc5cc53 100644
--- a/verifier/telephone.php
+++ b/verifier/telephone.php
@@ -3,8 +3,12 @@
// Sécurité
if (!defined("_ECRIRE_INC_VERSION")) return;
-/*
+/**
* Vérifie un numéro de téléphone. Pour l'instant seulement avec le schéma français.
+ *
+ * @param string $valeur La valeur à vérifier.
+ * @param array $option [INUTILISE].
+ * @return string Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
*/
function verifier_telephone_dist($valeur, $options=array()){
$erreur = _T('verifier:erreur_telephone');
diff --git a/verifier/url.php b/verifier/url.php
index 4539556..df1d5ea 100644
--- a/verifier/url.php
+++ b/verifier/url.php
@@ -7,6 +7,10 @@ if (!defined("_ECRIRE_INC_VERSION")) return;
* Une URL commence par HTTP:// contient un domaine, etc.
* Doit pouvoir recevoir en option le protocole (ou pas) FTP SSH SFTP HTTP etc.
* Si pas de protocole spécifié, commencer à :// ??
+ *
+ * @param string $valeur La valeur à vérifier.
+ * @param array $option [INUTILISE].
+ * @return string Retourne une chaine vide si c'est valide, sinon une chaine expliquant l'erreur.
*/
function verifier_url_dist($valeur, $options=array()){
$erreur = _T('verifier:erreur_url');
--
GitLab