lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mise a jour commentaires pour doc

Browse Source
This commit is contained in:
Laurent Destailleur 2004-08-07 14:41:29 +00:00
parent d6c0e4deb5
commit 33dd73e6a4
1 changed files with 95 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

154
htdocs/lib/functions.inc.php
View File

@ -35,8 +35,10 @@
/*! /*!
\brief envoi des messages dolibarr dans syslog \brief Envoi des messages dolibarr dans syslog.
\param message message a envoyer a syslog \param message message a envoyer a syslog
Le \a message est envoyé dans syslog dans la catégorie LOG_USER.
*/ */
function dolibarr_syslog($message) function dolibarr_syslog($message)
@ -51,10 +53,10 @@ function dolibarr_syslog($message)
} }
/*! /*!
\brief header d'une fiche \brief Affiche le header d'une fiche
\param links liens \param links liens
\param active \param active 0 par défaut
\remarks active = 0 par défaut \param title
*/ */
@ -91,18 +93,16 @@ function dolibarr_fiche_head($links, $active=0, $title='')
} }
/*! /*!
\brief insertion d'une constantes dans la base de données \brief Insertion d'une constante dans la base de données.
\param db base de données \param db handler d'accès base
\param name nom de la constante \param name nom de la constante
\param value valeur de la constante \param value valeur de la constante
\param type type de constante \param type type de constante (chaine par défaut)
\param visible la constante est t'elle visible \param visible la constante est t'elle visible (0 par défaut)
\param note explication de la constante \param note explication de la constante
\remarks type = chaine par défaut \return 0 pour raté, 1 pour réussi
\remarks visible = 0 par défaut \see dolibarr_del_const
\remarks retourne 0 pour raté, 1 pour réussi
*/ */
function dolibarr_set_const($db, $name, $value, $type='chaine', $visible=0, $note='') function dolibarr_set_const($db, $name, $value, $type='chaine', $visible=0, $note='')
{ {
$sql = "REPLACE INTO llx_const SET name = '$name', value='$value', visible=$visible, type='$type', note='$note'"; $sql = "REPLACE INTO llx_const SET name = '$name', value='$value', visible=$visible, type='$type', note='$note'";
@ -118,10 +118,11 @@ function dolibarr_set_const($db, $name, $value, $type='chaine', $visible=0, $not
} }
/*! /*!
\brief effacement d'une constante dans la base de données \brief Effacement d'une constante dans la base de données
\param db base de données \param db handler d'accès base
\param name nom ou rowid de la constante \param name nom ou rowid de la constante
\remarks retourne 0 pour raté, 1 pour réussi \return 0 pour raté, 1 pour réussi
\see dolibarr_set_const
*/ */
function dolibarr_del_const($db, $name) function dolibarr_del_const($db, $name)
@ -139,9 +140,9 @@ function dolibarr_del_const($db, $name)
} }
/*! /*!
\brief formattage des nombres \brief Formattage des nombres
\param ca valeur a formater \param ca valeur a formater
\return cat valeur formatée \return int valeur formatée
*/ */
function dolibarr_print_ca($ca) function dolibarr_print_ca($ca)
@ -167,10 +168,10 @@ function dolibarr_print_ca($ca)
} }
/*! /*!
\brief formattage de la date \brief Formattage de la date
\param time date timestamp ou au format YYYY-MM-DD \param time date timestamp ou au format YYYY-MM-DD
\param format format de la date "%d %b %Y" \param format format de la date "%d %b %Y"
\remarks retourne la date formatée \return string date formatée
*/ */
function dolibarr_print_date($time,$format="%d %b %Y") function dolibarr_print_date($time,$format="%d %b %Y")
@ -202,7 +203,7 @@ function dolibarr_print_date($time,$format="%d %b %Y")
/*! /*!
\brief affiche les informations d'un objet \brief Affiche les informations d'un objet
\param object objet a afficher \param object objet a afficher
*/ */
@ -227,7 +228,7 @@ function dolibarr_print_object_info($object)
} }
/*! /*!
\brief formattage du telephone \brief Formattage du telephone
\param phone numéro de telephone à formater \param phone numéro de telephone à formater
\return phone numéro de téléphone formaté \return phone numéro de téléphone formaté
\remarks net tient pas en compte le format belge 02/211 34 83 \remarks net tient pas en compte le format belge 02/211 34 83
@ -435,7 +436,7 @@ function img_previous($alt = "default")
/*! /*!
\brief fonction de login \brief fonction de login
\remarks if faut changer le code html dans la fonction pour changer le design \remarks il faut changer le code html dans la fonction pour changer le design
\remarks le css devrait etre pris dans le repetoire de dolibarr et ne pas etre en dur ! \remarks le css devrait etre pris dans le repetoire de dolibarr et ne pas etre en dur !
*/ */
@ -518,7 +519,8 @@ function loginfunction()
} }
/*! /*!
\brief Affiche message erreur de type acces interdit \brief Affiche message erreur de type acces interdit et arrete le programme
\remarks l'appel a cette fonction termine le code
*/ */
function accessforbidden() function accessforbidden()
@ -533,6 +535,8 @@ function accessforbidden()
/*! /*!
\brief Affiche message erreur system avec toutes les informations pour faciliter le diagnostique et la remontée des bugs \brief Affiche message erreur system avec toutes les informations pour faciliter le diagnostique et la remontée des bugs
On doit appeler cette fonction quand une erreur technique bloquante est rencontrée
\remarks l'appel a cette fonction termine le code
*/ */
function dolibarr_print_error($db='',$msg='') function dolibarr_print_error($db='',$msg='')
@ -559,9 +563,10 @@ function dolibarr_print_error($db='',$msg='')
} }
/*! /*!
\brief deplacer les fichiers telechargés \brief Deplacer les fichiers telechargés
\param src_file fichier source \param src_file fichier source
\param dest_file fichier de destination \param dest_file fichier de destination
\return int le resultat du move_uploaded_file
*/ */
function doliMoveFileUpload($src_file, $dest_file) function doliMoveFileUpload($src_file, $dest_file)
@ -577,6 +582,12 @@ function doliMoveFileUpload($src_file, $dest_file)
} }
/*!
\brief
\param db handler d'accès base
\param user object utilisateur
*/
function dolibarr_user_page_param($db, &$user) function dolibarr_user_page_param($db, &$user)
{ {
foreach ($GLOBALS["_GET"] as $key=>$value) foreach ($GLOBALS["_GET"] as $key=>$value)
@ -632,10 +643,10 @@ function dolibarr_user_page_param($db, &$user)
} }
/*! /*!
\brief transcodage de francs en euros \brief Transcodage de francs en euros
\param zonein zone de depart \param zonein zone de depart
\param devise type de devise \param devise type de devise
\return r \return r resultat transcodé
*/ */
function transcoS2L($zonein,$devise) function transcoS2L($zonein,$devise)
@ -836,14 +847,12 @@ function transcoS2L($zonein,$devise)
/*! /*!
\brief affichage du titre d'une liste \brief Affichage du titre d'une liste
\param name \param name
\param file \param file
\param field \param field
\param begin \param begin ("" par defaut)
\param options \param options ("" par defaut)
\remarks begin = "" par défaut
\remarks options = "" par défaut
*/ */
function print_liste_field_titre($name, $file, $field, $begin="", $options="") function print_liste_field_titre($name, $file, $field, $begin="", $options="")
@ -862,14 +871,10 @@ function print_liste_field_titre($name, $file, $field, $begin="", $options="")
\param name \param name
\param file \param file
\param field \param field
\param begin \param begin ("" par defaut)
\param options \param options ("" par defaut)
\param td \param td ("" par defaut)
\param sortfield \param sortfield ("" par defaut)
\remarks begin = "" par défaut
\remarks options = "" par défaut
\remarks td = "" par défaut
\remarks sortfield = "" par défaut
*/ */
function print_liste_field_titre_new($name, $file, $field, $begin="", $options="", $td="", $sortfield="") function print_liste_field_titre_new($name, $file, $field, $begin="", $options="", $td="", $sortfield="")
@ -892,7 +897,7 @@ function print_liste_field_titre_new($name, $file, $field, $begin="", $options="
} }
/*! /*!
\brief affichage d'un titre \brief Affichage d'un titre
\param titre le titre a afficher \param titre le titre a afficher
*/ */
@ -902,9 +907,9 @@ function print_titre($titre)
} }
/*! /*!
\brief affichage d'un titre d'une fiche aligné a droite \brief Affichage d'un titre d'une fiche, aligné a gauche
\param titre le titre a afficher \param titre le titre a afficher
\param mesg message afficher \param mesg message suplémentaire à afficher à droite
*/ */
function print_fiche_titre($titre, $mesg='') function print_fiche_titre($titre, $mesg='')
@ -919,7 +924,7 @@ function print_fiche_titre($titre, $mesg='')
} }
/*! /*!
\brief effacement d'un fichier \brief Effacement d'un fichier
\param file fichier a effacer \param file fichier a effacer
*/ */
@ -930,7 +935,7 @@ function dol_delete_file($file)
/*! /*!
\brief fonction print_barre_liste \brief Fonction print_barre_liste
\param titre titre de la page \param titre titre de la page
\param page numéro de la page \param page numéro de la page
\param file lien \param file lien
@ -938,6 +943,7 @@ function dol_delete_file($file)
\param sortfield \param sortfield
\param sortorder \param sortorder
\param form \param form
\param num nombre d'élément total
*/ */
function print_barre_liste($titre, $page, $file, $options='', $sortfield='', $sortorder='', $form='', $num=-1) function print_barre_liste($titre, $page, $file, $options='', $sortfield='', $sortorder='', $form='', $num=-1)
@ -989,10 +995,10 @@ function print_barre_liste($titre, $page, $file, $options='', $sortfield='', $so
} }
/*! /*!
\brief fonction servant a afficher les fleches de navigation dans les pages de listes \brief Fonction servant a afficher les fleches de navigation dans les pages de listes
\param page numéro de la page \param page numéro de la page
\param file lien \param file lien
\param options \param options autres parametres d'url a propager dans les liens ("" par defaut)
\param nextpage page suivante \param nextpage page suivante
*/ */
@ -1012,9 +1018,10 @@ function print_fleche_navigation($page,$file,$options='', $nextpage)
/*! /*!
\brief fonction servant a afficher un menu déroulant sur le type de paiement \brief Fonction servant a afficher un menu déroulant sur le type de paiement
\param value \param db handler d'accès base
\remarks value peut avoir la valeur 0 ou 1 \param nomselect Nom de la zone select html
\param value Critere de filtrage sur les type de paiement
*/ */
function print_type_paiement_select($db,$nomselect,$value=-1) function print_type_paiement_select($db,$nomselect,$value=-1)
@ -1043,9 +1050,8 @@ function print_type_paiement_select($db,$nomselect,$value=-1)
} }
/*! /*!
\brief fonction servant a afficher les mois dans un liste déroulante \brief Fonction servant a afficher les mois dans un liste déroulante
\param set_time \param set_time ("" par defaut)
\remarks set_time = '' par défaut
*/ */
function print_date_select($set_time='') function print_date_select($set_time='')
@ -1123,12 +1129,10 @@ function print_date_select($set_time='')
} }
/*! /*!
\brief fonction servant a afficher les heures/minutes dans un liste déroulante \brief Fonction servant a afficher les heures/minutes dans un liste déroulante
\param prefix \param prefix
\param begin \param begin (1 par defaut)
\param end \param end (23 par defaut)
\remarks begin = 1 par défaut
\remarks end = 23 par défaut
*/ */
function print_heure_select($prefix,$begin=1,$end=23) { function print_heure_select($prefix,$begin=1,$end=23) {
@ -1149,7 +1153,7 @@ function print_heure_select($prefix,$begin=1,$end=23) {
} }
/*! /*!
\brief fonction servant a afficher une durée dans une liste déroulante \brief Fonction servant a afficher une durée dans une liste déroulante
\param prefix \param prefix
*/ */
@ -1174,11 +1178,10 @@ function print_duree_select($prefix)
/*! /*!
\brief fonction qui retourne un montant monétaire formaté \brief Fonction qui retourne un montant monétaire formaté
\param amount montant a formater \param amount montant a formater
\param html formatage html ou pas \param html formatage html ou pas (0 par defaut)
\remarks html = 0 par défaut \remarks fonction utilisée dans les pdf et les pages html
\remarks fnction utilisée dans les pdf et les pages html
*/ */
@ -1199,7 +1202,7 @@ function price($amount, $html=0)
} }
/*! /*!
\brief fonction qui convertit des euros en francs \brief Fonction qui convertit des euros en francs
\param euros somme en euro à convertir \param euros somme en euro à convertir
\return price \return price
*/ */
@ -1210,7 +1213,7 @@ function francs($euros)
} }
/*! /*!
\brief fonction qui calcule la tva \brief Fonction qui calcule la tva
\param euros somme en euro \param euros somme en euro
\param taux taux de tva \param taux taux de tva
*/ */
@ -1223,7 +1226,7 @@ function tva($euros, $taux=19.6)
} }
/*! /*!
\brief fonction qui calcule le montant tva incluse \brief Fonction qui calcule le montant tva incluse
\param euros somme en euro \param euros somme en euro
\param taux taux de tva \param taux taux de tva
*/ */
@ -1247,7 +1250,7 @@ function yn($yesno, $case=1) {
} }
/*! /*!
\brief fonction qui affiche des statistiques \brief Fonction qui affiche des statistiques
\param basename \param basename
\param bc1 \param bc1
\param bc2 \param bc2
@ -1298,10 +1301,10 @@ function stat_print($basename,$bc1,$bc2,$ftc, $jour) {
} }
/*! /*!
\brief fonction qui permet d'envoyer les infos dans un fichier de log \brief Fonction qui permet d'envoyer les infos dans un fichier de log
\param str chaine a mettre dans le fichier \param str chaine a mettre dans le fichier
\param log nom du fichier de log \param log nom du fichier de log
\remarks cette fonction ne marchera qui si la constante MAIN_DEBUG = 1 \remarks Cette fonction ne marchera qui si la constante MAIN_DEBUG = 1
*/ */
function logfile($str,$log="/var/log/dolibarr/dolibarr.log") function logfile($str,$log="/var/log/dolibarr/dolibarr.log")
@ -1333,10 +1336,9 @@ function logfile($str,$log="/var/log/dolibarr/dolibarr.log")
} }
/*! /*!
\brief fonction pour créer un mot de passe aléatoire \brief Fonction pour créer un mot de passe aléatoire
\param longueur longueur du mot de passe \param longueur longueur du mot de passe (8 par defaut)
\param sel donnée aléatoire \param sel donnée aléatoire
\remarks la longueur est fixée a 8 par défaut
\remarks la fonction a été prise sur http://www.uzine.net/spip \remarks la fonction a été prise sur http://www.uzine.net/spip
*/ */
@ -1363,7 +1365,7 @@ function creer_pass_aleatoire($longueur = 8, $sel = "") {
} }
/*! /*!
\brief fonction pour initialiser sel \brief Fonction pour initialiser sel
\remarks la fonction a été prise sur http://www.uzine.net/spip \remarks la fonction a été prise sur http://www.uzine.net/spip
*/ */
@ -1374,10 +1376,10 @@ function initialiser_sel() {
} }
/*! /*!
\brief fonction pour qui retourne le rowid d'un departement par son code \brief Fonction pour qui retourne le rowid d'un departement par son code
\param db base de données \param db handler d'accès base
\param code code région \param code Code région
\param pays_id id du pays \param pays_id Id du pays
*/ */
function departement_rowid($db,$code, $pays_id) function departement_rowid($db,$code, $pays_id)