Référence du fichier htdocs/lib/functions.inc.php

Ensemble de fonctions de base de dolibarr sous forme d'include. Plus de détails...

Aller au code source de ce fichier.

Fonctions
	dolibarr_syslog ($message)
	envoi des messages dolibarr dans syslog
	dolibarr_fiche_head ($links, $active=0)
	header d'une fiche
	dolibarr_set_const ($db, $name, $value, $type='chaine', $visible=0, $note='')
	insertion d'une constantes dans la base de données
	dolibarr_del_const ($db, $name)
	effacement d'une constante dans la base de données
	dolibarr_print_ca ($ca)
	formattage des nombres
	dolibarr_print_date ($time, $format="%d %b %Y")
	formattage de la date
	dolibarr_print_object_info ($object)
	affiche les informations d'un objet
	dolibarr_print_phone ($phone)
	formattage du telephone
	loginfunction ()
	fonction de login
	accessforbidden ()
	acces interdit
	doliMoveFileUpload ($src_file, $dest_file)
	deplacer les fichiers telechargés
	transcoS2L ($zonein, $devise)
	transcodage de francs en euros
	print_liste_field_titre ($name, $file, $field, $begin="", $options="")
	affichage du titre d'une liste
	print_liste_field_titre_new ($name, $file, $field, $begin="", $options="", $td="", $sortfield="")
	affichage du titre d'une liste avec possibilité de tri et de choix du type de la balise td
	print_titre ($titre)
	affichage d'un titre
	print_fiche_titre ($titre, $mesg='')
	affichage d'un titre d'une fiche aligné a droite
	dol_delete_file ($file)
	effacement d'un fichier
	block_access ()
	accès refusé
	print_fleche_navigation ($page, $file, $options='', $nextpage)
	fonction servant a afficher les fleches de navigation dans les pages de listes
	print_oui_non ($value)
	fonction servant a afficher un menu déroulant avec oui ou non
	print_date_select ($set_time='')
	fonction servant a afficher les mois dans un liste déroulante
	print_heure_select ($prefix, $begin=1, $end=23)
	fonction servant a afficher les heures/minutes dans un liste déroulante
	print_duree_select ($prefix)
	fonction servant a afficher une durée dans une liste déroulante
	price ($amount, $html=0)
	fonction qui retourne un montant monétaire formaté
	francs ($euros)
	fonction qui convertit des euros en francs
	tva ($euros, $taux=19.6)
	fonction qui calcule la tva
	inctva ($euros, $taux=1.196)
	fonction qui calcule le montant tva incluse
	stat_print ($basename, $bc1, $bc2, $ftc, $jour)
	fonction qui affiche des statistiques
	logfile ($str, $log="/var/log/dolibarr/dolibarr.log")
	fonction qui permet d'envoyer les infos dans un fichier de log
	creer_pass_aleatoire ($longueur=8, $sel="")
	fonction pour créer un mot de passe aléatoire
	initialiser_sel ()
	fonction pour initialiser sel

---

Description détaillée

Ensemble de fonctions de base de dolibarr sous forme d'include.

Auteur:

Rodolphe Quiedeville

Jean-Louis Bergamo

Laurent Destailleur

Version:

1.2.

Ensemble de fonctions de base de dolibarr sous forme d'include

Définition dans le fichier functions.inc.php.

---

Documentation des fonctions

creer_pass_aleatoire (  $  longueur = 8, $  sel = "" )

fonction pour créer un mot de passe aléatoire Paramètres: longueur  longueur du mot de passe sel  donnée aléatoire Remarques: la longueur est fixée a 8 par défaut la fonction a été prise sur http://www.uzine.net/spip Définition à la ligne 1224 du fichier functions.inc.php.

dol_delete_file (  $  file  )

effacement d'un fichier Paramètres: file  fichier a effacer Définition à la ligne 735 du fichier functions.inc.php.

dolibarr_del_const (  $  db, $  name )

effacement d'une constante dans la base de données Paramètres: db  base de données name  nom de la constante Remarques: retourne 0 pour raté, 1 pour réussi Définition à la ligne 124 du fichier functions.inc.php.

dolibarr_fiche_head (  $  links, $  active = 0 )

header d'une fiche Paramètres: links  liens active  Remarques: active = 0 par défaut Définition à la ligne 63 du fichier functions.inc.php.

dolibarr_print_ca (  $  ca  )

formattage des nombres Paramètres: ca  valeur a formater Renvoie: cat valeur formatée Définition à la ligne 144 du fichier functions.inc.php.

dolibarr_print_date (  $  time, $  format = "%d %b %Y" )

formattage de la date Paramètres: time  date format  format de la date "%d %b %Y" Remarques: retourne la date formatée Définition à la ligne 173 du fichier functions.inc.php.

dolibarr_print_object_info (  $  object  )

affiche les informations d'un objet Paramètres: object  objet a afficher Définition à la ligne 184 du fichier functions.inc.php.

dolibarr_print_phone (  $  phone  )

formattage du telephone Paramètres: phone  numéro de telephone à formater Renvoie: phone numéro de téléphone formaté Remarques: net tient pas en compte le format belge 02/211 34 83 Définition à la ligne 199 du fichier functions.inc.php.

dolibarr_set_const (  $  db, $  name, $  value, $  type = 'chaine', $  visible = 0, $  note = '' )

insertion d'une constantes dans la base de données Paramètres: db  base de données name  nom de la constante value  valeur de la constante type  type de constante visible  la constante est t'elle visible note  explication de la constante Remarques: type = chaine par défaut visible = 0 par défaut retourne 0 pour raté, 1 pour réussi Définition à la ligne 103 du fichier functions.inc.php.

dolibarr_syslog (  $  message  )

envoi des messages dolibarr dans syslog Paramètres: message  message a envoyer a syslog Définition à la ligne 44 du fichier functions.inc.php.

doliMoveFileUpload (  $  src_file, $  dest_file )

deplacer les fichiers telechargés Paramètres: src_file  fichier source dest_file  fichier de destination Définition à la ligne 377 du fichier functions.inc.php.

francs (  $  euros  )

fonction qui convertit des euros en francs Paramètres: euros  somme en euro à convertir Renvoie: price Définition à la ligne 1007 du fichier functions.inc.php. Références price().

inctva (  $  euros, $  taux = 1.196 )

fonction qui calcule le montant tva incluse Paramètres: euros  somme en euro taux  taux de tva Définition à la ligne 1031 du fichier functions.inc.php.

initialiser_sel (   )

fonction pour initialiser sel Remarques: la fonction a été prise sur http://www.uzine.net/spip Définition à la ligne 1251 du fichier functions.inc.php.

logfile (  $  str, $  log = "/var/log/dolibarr/dolibarr.log" )

fonction qui permet d'envoyer les infos dans un fichier de log Paramètres: str  chaine a mettre dans le fichier log  nom du fichier de log Remarques: cette fonction ne marchera qui si la constante MAIN_DEBUG = 1 Définition à la ligne 1188 du fichier functions.inc.php.

loginfunction (   )

fonction de login Remarques: if faut changer le code html dans la fonction pour changer le design le css devrait etre pris dans le repetoire de dolibarr et ne pas etre en dur ! Définition à la ligne 281 du fichier functions.inc.php.

price (  $  amount, $  html = 0 )

fonction qui retourne un montant monétaire formaté Paramètres: amount  montant a formater html  formatage html ou pas Remarques: html = 0 par défaut fnction utilisée dans les pdf et les pages html Définition à la ligne 985 du fichier functions.inc.php. Référencé par francs().

print_date_select (  $  set_time = ''  )

fonction servant a afficher les mois dans un liste déroulante Paramètres: set_time  Remarques: set_time = '' par défaut Définition à la ligne 852 du fichier functions.inc.php.

print_duree_select (  $  prefix  )

fonction servant a afficher une durée dans une liste déroulante Paramètres: prefix  Définition à la ligne 957 du fichier functions.inc.php.

print_fiche_titre (  $  titre, $  mesg = '' )

affichage d'un titre d'une fiche aligné a droite Paramètres: titre  le titre a afficher mesg  message afficher Définition à la ligne 719 du fichier functions.inc.php.

print_fleche_navigation (  $  page, $  file, $  options = '', $  nextpage )

fonction servant a afficher les fleches de navigation dans les pages de listes Paramètres: page  numéro de la page file  lien options  nextpage  page suivante Définition à la ligne 812 du fichier functions.inc.php.

print_heure_select (  $  prefix, $  begin = 1, $  end = 23 )

fonction servant a afficher les heures/minutes dans un liste déroulante Paramètres: prefix  begin  end  Remarques: begin = 1 par défaut end = 23 par défaut Définition à la ligne 935 du fichier functions.inc.php.

print_liste_field_titre (  $  name, $  file, $  field, $  begin = "", $  options = "" )

affichage du titre d'une liste Paramètres: name  file  field  begin  options  Remarques: begin = "" par défaut options = "" par défaut Définition à la ligne 658 du fichier functions.inc.php.

print_liste_field_titre_new (  $  name, $  file, $  field, $  begin = "", $  options = "", $  td = "", $  sortfield = "" )

affichage du titre d'une liste avec possibilité de tri et de choix du type de la balise td Paramètres: name  file  field  begin  options  td  sortfield  Remarques: begin = "" par défaut options = "" par défaut td = "" par défaut sortfield = "" par défaut Définition à la ligne 684 du fichier functions.inc.php.

print_oui_non (  $  value  )

fonction servant a afficher un menu déroulant avec oui ou non Paramètres: value  Remarques: value peut avoir la valeur 0 ou 1 Définition à la ligne 832 du fichier functions.inc.php.

print_titre (  $  titre  )

affichage d'un titre Paramètres: titre  le titre a afficher Définition à la ligne 708 du fichier functions.inc.php.

stat_print (  $  basename, $  bc1, $  bc2, $  ftc, $  jour )

fonction qui affiche des statistiques Paramètres: basename  bc1  bc2  ftc  jour  Définition à la ligne 1046 du fichier functions.inc.php.

transcoS2L (  $  zonein, $  devise )

transcodage de francs en euros Paramètres: zonein  zone de depart devise  type de devise Renvoie: r Définition à la ligne 451 du fichier functions.inc.php.

tva (  $  euros, $  taux = 19.6 )

fonction qui calcule la tva Paramètres: euros  somme en euro taux  taux de tva Définition à la ligne 1018 du fichier functions.inc.php. Référencé par calcul_price().

---