diff --git a/doc/dev/php/html/CMailFile_8class_8php.html b/doc/dev/php/html/CMailFile_8class_8php.html new file mode 100644 index 00000000000..a8758feef21 --- /dev/null +++ b/doc/dev/php/html/CMailFile_8class_8php.html @@ -0,0 +1,33 @@ + + +dolibarr: CMailFile.class.php File Reference + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

Référence du fichier htdocs/lib/CMailFile.class.php

Classe permettant d'envoyer des attachements par mail. +Plus de détails... +

+ +

+Aller au code source de ce fichier. + + + + + +

Classes

class  CMailFile
 Classe permettant d'envoyer des attachements par mail. Plus de détails...

+


Description détaillée

+Classe permettant d'envoyer des attachements par mail. +

+

Auteur:
Dan Potter.

+Eric Seigne

+Laurent Destailleur.

+
Version:
1.2.
+ +

+Définition dans le fichier CMailFile.class.php.


Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/annotated.html b/doc/dev/php/html/annotated.html new file mode 100644 index 00000000000..69d07168164 --- /dev/null +++ b/doc/dev/php/html/annotated.html @@ -0,0 +1,17 @@ + + +dolibarr: Annotated Index + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

dolibarr Liste des classes

Liste des classes, structures, unions et interfaces avec une brève description: + + + +
CMailFileClasse permettant d'envoyer des attachements par mail
DoliDbClasse permettant de gérér la database de dolibarr
WebcalClasse permettant d'acceder a la database webcalendar
+
Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/classCMailFile-members.html b/doc/dev/php/html/classCMailFile-members.html new file mode 100644 index 00000000000..0cd56eefad3 --- /dev/null +++ b/doc/dev/php/html/classCMailFile-members.html @@ -0,0 +1,14 @@ + + +dolibarr: Liste des membres + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

CMailFile Liste des membres

Liste complète des membres de CMailFile, y compris les membres hérités:

+ +
CMailFile($subject, $to, $from, $msg, $filename_list, $mimetype_list, $mimefilename_list, $addr_cc="")CMailFile


Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/classCMailFile.html b/doc/dev/php/html/classCMailFile.html new file mode 100644 index 00000000000..b9bf87a4be9 --- /dev/null +++ b/doc/dev/php/html/classCMailFile.html @@ -0,0 +1,126 @@ + + +dolibarr: CMailFile class Reference + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

Référence de la classe CMailFile

Classe permettant d'envoyer des attachements par mail. +Plus de détails... +

+Liste de tous les membres + + + + + +

Fonctions membres publiques

 CMailFile ($subject, $to, $from, $msg, $filename_list, $mimetype_list, $mimefilename_list, $addr_cc="")
 CMailFile.

+


Description détaillée

+Classe permettant d'envoyer des attachements par mail. +

+

Remarques:
Eric Seigne <eric.seigne@ryxeo.com> 2004.01.08

+ajout de la gestion des cc:

+ajout de l'expedition de plusieurs fichiers

+Laurent Destailleur 2004.02.10

+correction d'un disfonctionnement à la gestion des attachements multiples

+ +

+ +

+Définition à la ligne 40 du fichier CMailFile.class.php.


Documentation des contructeurs et destructeur

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CMailFile::CMailFile subject,
to,
from,
msg,
filename_list,
mimetype_list,
mimefilename_list,
addr_cc = ""
+
+ + + + + +
+   + + +

+CMailFile. +

+

Paramètres:
+ + + + + + + + + +
subject 
to 
from 
msg 
filename_list 
mimetype_list 
mimefilename_list 
addr_cc 
+
+ +

+Définition à la ligne 64 du fichier CMailFile.class.php.

+


La documentation de cette classe a été générée à partir du fichier suivant: +
Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/classDoliDb-members.html b/doc/dev/php/html/classDoliDb-members.html new file mode 100644 index 00000000000..71ab3ceee67 --- /dev/null +++ b/doc/dev/php/html/classDoliDb-members.html @@ -0,0 +1,39 @@ + + +dolibarr: Liste des membres + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

DoliDb Liste des membres

Liste complète des membres de DoliDb, y compris les membres hérités:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
affected_rows()DoliDb
begin($do=1)DoliDb
clone()DoliDb
close()DoliDb
commit($do=1)DoliDb
connect($host, $login, $passwd)DoliDb
create_db($database)DoliDb
DoliDb($type= 'mysql', $host= '', $user= '', $pass= '', $name= '')DoliDb
errno()DoliDb
error()DoliDb
fetch_array()DoliDb
fetch_field()DoliDb
fetch_object()DoliDb
fetch_row()DoliDb
free()DoliDb
idate($fname)DoliDb
last_insert_id()DoliDb
list_tables($database)DoliDb
num_fields()DoliDb
num_rows()DoliDb
pconnect($host, $login, $passwd)DoliDb
plimit($limit=0, $offset=0)DoliDb
query($query, $limit="", $offset="")DoliDb
result($nb, $fieldname)DoliDb
rollback($do=1)DoliDb
select_db($database)DoliDb


Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/classDoliDb.html b/doc/dev/php/html/classDoliDb.html new file mode 100644 index 00000000000..dfa4718b3d2 --- /dev/null +++ b/doc/dev/php/html/classDoliDb.html @@ -0,0 +1,1138 @@ + + +dolibarr: DoliDb class Reference + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

Référence de la classe DoliDb

Classe permettant de gérér la database de dolibarr. +Plus de détails... +

+Liste de tous les membres + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Fonctions membres publiques

 DoliDb ($type= 'mysql', $host= '', $user= '', $pass= '', $name= '')
 ouverture d'une connection vers le serveur et/ou une database.

 select_db ($database)
 selectionne une database.

 connect ($host, $login, $passwd)
 connection vers une database.

 create_db ($database)
 création d'une database.

 clone ()
 copie d'une database.

 pconnect ($host, $login, $passwd)
 ouverture d'une connection vers une database.

 close ()
 fermeture d'une connection vers une database.

 begin ($do=1)
 debut d'une transaction.

 commit ($do=1)
 écriture d'une transaction.

 rollback ($do=1)
 éffacement d'une transaction et retour au ancienne valeurs.

 query ($query, $limit="", $offset="")
 requete vers une database.

 list_tables ($database)
 liste des tables dans une database.

 result ($nb, $fieldname)
 renvoie les données de la requete.

 free ()
 désalloue la memoire de la requete.

 fetch_object ()
 renvoie les données comme un objet.

 plimit ($limit=0, $offset=0)
 défini les limites de la requète.

 idate ($fname)
 formatage de la date en fonction des locales.

 fetch_array ()
 renvoie les données dans un tableau.

 fetch_row ()
 renvoie les données comme un tableau.

fetch_field ()
 obtient les données d'un colonne et renvoie les données sous forme d'objet.

 num_rows ()
 renvoie le nombre de lignes dans le resultat de la requete.

 num_fields ()
 renvoie le nombre de champs dans le resultat de la requete.

 error ()
 renvoie le texte de l'erreur mysql de l'operation precedente.

 errno ()
 renvoie la valeur numerique de l'erreur mysql de l'operation precedente.

 last_insert_id ()
 obtient l'id genéré par le précedent INSERT.

 affected_rows ()
 obtient le nombre de lignes affectées dans la précédente opération.

+


Description détaillée

+Classe permettant de gérér la database de dolibarr. +

+Ensemble des fonctions permettant de gérer la database de dolibarr +

+ +

+Définition à la ligne 41 du fichier mysql.lib.php.


Documentation des contructeurs et destructeur

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DoliDb::DoliDb type = 'mysql',
host = '',
user = '',
pass = '',
name = ''
+
+ + + + + +
+   + + +

+ouverture d'une connection vers le serveur et/ou une database. +

+

Paramètres:
+ + + + + + +
type type de base de données (mysql ou pgsql)
host addresse de la base de données
user nom de l'utilisateur autorisé
pass mot de passe
name nom de la database
+
+ +

+Définition à la ligne 57 du fichier mysql.lib.php. +

+Références connect(), et select_db().

+


Documentation des fonctions membres

+

+ + + + +
+ + + + + + + + +
DoliDb::affected_rows  ) 
+
+ + + + + +
+   + + +

+obtient le nombre de lignes affectées dans la précédente opération. +

+

Renvoie:
rows
+ +

+Définition à la ligne 448 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + + +
DoliDb::begin do = 1  ) 
+
+ + + + + +
+   + + +

+debut d'une transaction. +

+

Paramètres:
+ + +
do 
+
+
Renvoie:
string
+ +

+Définition à la ligne 216 du fichier mysql.lib.php. +

+Références begin(), et query(). +

+Référencé par begin().

+

+ + + + +
+ + + + + + + + +
DoliDb::clone  ) 
+
+ + + + + +
+   + + +

+copie d'une database. +

+

Renvoie:
resource
+ +

+Définition à la ligne 179 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + +
DoliDb::close  ) 
+
+ + + + + +
+   + + +

+fermeture d'une connection vers une database. +

+

Renvoie:
resource
+ +

+Définition à la ligne 205 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + + +
DoliDb::commit do = 1  ) 
+
+ + + + + +
+   + + +

+écriture d'une transaction. +

+

Paramètres:
+ + +
do 
+
+
Renvoie:
string
+ +

+Définition à la ligne 234 du fichier mysql.lib.php. +

+Références commit(), et query(). +

+Référencé par commit().

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
DoliDb::connect host,
login,
passwd
+
+ + + + + +
+   + + +

+connection vers une database. +

+

Paramètres:
+ + + + +
host addresse de la base de données
login nom de l'utilisateur autorisé
passwd mot de passe
+
+
Renvoie:
resource
+ +

+Définition à la ligne 149 du fichier mysql.lib.php. +

+Références connect(). +

+Référencé par connect(), et DoliDb().

+

+ + + + +
+ + + + + + + + + +
DoliDb::create_db database  ) 
+
+ + + + + +
+   + + +

+création d'une database. +

+

Paramètres:
+ + +
database nom de la database
+
+
Renvoie:
result resultat 1 pour ok, 0 pour non ok
+ +

+Définition à la ligne 162 du fichier mysql.lib.php. +

+Références create_db(). +

+Référencé par create_db().

+

+ + + + +
+ + + + + + + + +
DoliDb::errno  ) 
+
+ + + + + +
+   + + +

+renvoie la valeur numerique de l'erreur mysql de l'operation precedente. +

+

Renvoie:
error_num
+ +

+Définition à la ligne 425 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + +
DoliDb::error  ) 
+
+ + + + + +
+   + + +

+renvoie le texte de l'erreur mysql de l'operation precedente. +

+

Renvoie:
error_text
+ +

+Définition à la ligne 415 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + +
DoliDb::fetch_array  ) 
+
+ + + + + +
+   + + +

+renvoie les données dans un tableau. +

+

Renvoie:
array
+ +

+Définition à la ligne 365 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + +
DoliDb::fetch_object  ) 
+
+ + + + + +
+   + + +

+renvoie les données comme un objet. +

+

Renvoie:
resource
+ +

+Définition à la ligne 319 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + +
DoliDb::fetch_row  ) 
+
+ + + + + +
+   + + +

+renvoie les données comme un tableau. +

+

Renvoie:
array
+ +

+Définition à la ligne 375 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + +
DoliDb::free  ) 
+
+ + + + + +
+   + + +

+désalloue la memoire de la requete. +

+

Renvoie:
resource
+ +

+Définition à la ligne 309 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + + +
DoliDb::idate fname  ) 
+
+ + + + + +
+   + + +

+formatage de la date en fonction des locales. +

+

Paramètres:
+ + +
fname 
+
+
Renvoie:
date
+ +

+Définition à la ligne 355 du fichier mysql.lib.php. +

+Références idate(). +

+Référencé par idate().

+

+ + + + +
+ + + + + + + + +
DoliDb::last_insert_id  ) 
+
+ + + + + +
+   + + +

+obtient l'id genéré par le précedent INSERT. +

+

Renvoie:
id
+ +

+Définition à la ligne 438 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + + +
DoliDb::list_tables database  ) 
+
+ + + + + +
+   + + +

+liste des tables dans une database. +

+

Paramètres:
+ + +
database nom de la database
+
+
Renvoie:
resource
+ +

+Définition à la ligne 286 du fichier mysql.lib.php. +

+Références list_tables(). +

+Référencé par list_tables().

+

+ + + + +
+ + + + + + + + +
DoliDb::num_fields  ) 
+
+ + + + + +
+   + + +

+renvoie le nombre de champs dans le resultat de la requete. +

+

Renvoie:
int
+ +

+Définition à la ligne 405 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + +
DoliDb::num_rows  ) 
+
+ + + + + +
+   + + +

+renvoie le nombre de lignes dans le resultat de la requete. +

+

Renvoie:
int
+ +

+Définition à la ligne 395 du fichier mysql.lib.php.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
DoliDb::pconnect host,
login,
passwd
+
+ + + + + +
+   + + +

+ouverture d'une connection vers une database. +

+

Paramètres:
+ + + + +
host addresse de la base de données
login nom de l'utilisateur autorisé
passwd mot de passe
+
+
Renvoie:
resource
+ +

+Définition à la ligne 194 du fichier mysql.lib.php. +

+Références pconnect(). +

+Référencé par pconnect().

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
DoliDb::plimit limit = 0,
offset = 0
+
+ + + + + +
+   + + +

+défini les limites de la requète. +

+

Paramètres:
+ + + +
limit 
offset 
+
+
Renvoie:
limit
+ +

+Définition à la ligne 331 du fichier mysql.lib.php. +

+Références plimit(). +

+Référencé par plimit().

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
DoliDb::query query,
limit = "",
offset = ""
+
+ + + + + +
+   + + +

+requete vers une database. +

+

Paramètres:
+ + + + +
query contenu de la query
limit 
offset 
+
+
Renvoie:
resource
+ +

+Définition à la ligne 272 du fichier mysql.lib.php. +

+Références query(). +

+Référencé par begin(), commit(), query(), et rollback().

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
DoliDb::result nb,
fieldname
+
+ + + + + +
+   + + +

+renvoie les données de la requete. +

+

Paramètres:
+ + + +
nb contenu de la query
fieldname nom du champ
+
+
Renvoie:
resource
+ +

+Définition à la ligne 299 du fichier mysql.lib.php. +

+Références result(). +

+Référencé par result().

+

+ + + + +
+ + + + + + + + + +
DoliDb::rollback do = 1  ) 
+
+ + + + + +
+   + + +

+éffacement d'une transaction et retour au ancienne valeurs. +

+

Paramètres:
+ + +
do 
+
+
Renvoie:
string
+ +

+Définition à la ligne 252 du fichier mysql.lib.php. +

+Références query(), et rollback(). +

+Référencé par rollback().

+

+ + + + +
+ + + + + + + + + +
DoliDb::select_db database  ) 
+
+ + + + + +
+   + + +

+selectionne une database. +

+

Paramètres:
+ + +
database nom de la database
+
+
Renvoie:
resource
+ +

+Définition à la ligne 136 du fichier mysql.lib.php. +

+Références select_db(). +

+Référencé par DoliDb(), et select_db().

+


La documentation de cette classe a été générée à partir du fichier suivant: +
Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/classWebcal-members.html b/doc/dev/php/html/classWebcal-members.html new file mode 100644 index 00000000000..1c0f1004508 --- /dev/null +++ b/doc/dev/php/html/classWebcal-members.html @@ -0,0 +1,16 @@ + + +dolibarr: Liste des membres + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

Webcal Liste des membres

Liste complète des membres de Webcal, y compris les membres hérités:

+ + + +
add($user, $date, $texte, $desc)Webcal
get_next_id()Webcal
Webcal()Webcal


Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/classWebcal.html b/doc/dev/php/html/classWebcal.html new file mode 100644 index 00000000000..cad713e7736 --- /dev/null +++ b/doc/dev/php/html/classWebcal.html @@ -0,0 +1,142 @@ + + +dolibarr: Webcal class Reference + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

Référence de la classe Webcal

Classe permettant d'acceder a la database webcalendar. +Plus de détails... +

+Liste de tous les membres + + + + + + + + + + + +

Fonctions membres publiques

Webcal ()
 Permet de se connecter a la database webcalendar.

 add ($user, $date, $texte, $desc)
 ajoute une entree dans le calendrier de l'utilsateur

 get_next_id ()
 obtient l'id suivant dans le webcalendar

+


Description détaillée

+Classe permettant d'acceder a la database webcalendar. +

+Ensemble des fonctions permettant d'acceder a la database webcalendar +

+ +

+Définition à la ligne 37 du fichier webcal.class.php.


Documentation des fonctions membres

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Webcal::add user,
date,
texte,
desc
+
+ + + + + +
+   + + +

+ajoute une entree dans le calendrier de l'utilsateur +

+

Paramètres:
+ + + + + +
[in] user le login de l'utilisateur
[in] date la date de l'evenement dans le calendrier
[in] texte le titre a indiquer dans l'evenement
[in] desc la description a indiquer dans l'evenement
+
+ +

+Définition à la ligne 65 du fichier webcal.class.php. +

+Références add(), et get_next_id(). +

+Référencé par add().

+

+ + + + +
+ + + + + + + + +
Webcal::get_next_id  ) 
+
+ + + + + +
+   + + +

+obtient l'id suivant dans le webcalendar +

+

Valeurs retournées:
+ + +
id retourne l'id suivant dans le webcalendar
+
+ +

+Définition à la ligne 118 du fichier webcal.class.php. +

+Référencé par add().

+


La documentation de cette classe a été générée à partir du fichier suivant: +
Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/classWebcal_1_1Webcal.html b/doc/dev/php/html/classWebcal_1_1Webcal.html new file mode 100644 index 00000000000..7f8b9dafbac --- /dev/null +++ b/doc/dev/php/html/classWebcal_1_1Webcal.html @@ -0,0 +1,25 @@ + + +dolibarr: Webcal::Webcal class Reference + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de fichier
+

Référence de la classe Webcal::Webcal

Classe permettant d'acceder a la database webcalendar. +Plus de détails... +

+ + +
+


Description détaillée

+Classe permettant d'acceder a la database webcalendar. +

+Ensemble des fonctions permettant d'acceder a la database webcalendar. +

+


La documentation de cette classe a été générée à partir du fichier suivant: +
Généré le Thu Jul 15 20:40:51 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/classes.html b/doc/dev/php/html/classes.html new file mode 100644 index 00000000000..9b03b8181a9 --- /dev/null +++ b/doc/dev/php/html/classes.html @@ -0,0 +1,18 @@ + + +dolibarr: Alphabetical index + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

dolibarr Index des classes

C | D | W

+ +
  C  
+
  D  
+
DoliDb   
  W  
+
Webcal   
CMailFile   

C | D | W

+


Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/functions.html b/doc/dev/php/html/functions.html new file mode 100644 index 00000000000..29faf039993 --- /dev/null +++ b/doc/dev/php/html/functions.html @@ -0,0 +1,47 @@ + + +dolibarr: Compound Member Index + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+
Tout | Fonctions
+ +

+Liste de tous les membres de classe documentés avec liens vers la documentation de classe de chaque membre:

+
Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/functions_8inc_8php.html b/doc/dev/php/html/functions_8inc_8php.html new file mode 100644 index 00000000000..7289523446f --- /dev/null +++ b/doc/dev/php/html/functions_8inc_8php.html @@ -0,0 +1,1518 @@ + + +dolibarr: functions.inc.php File Reference + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+

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().

+


Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/html/functions_func.html b/doc/dev/php/html/functions_func.html new file mode 100644 index 00000000000..b6a3d9645a0 --- /dev/null +++ b/doc/dev/php/html/functions_func.html @@ -0,0 +1,47 @@ + + +dolibarr: Compound Member Index + + + +
Page principale | Liste alphabétique | Liste des classes | Liste des fichiers | Membres de classe | Membres de fichier
+
Tout | Fonctions
+ +

+

+
Généré le Fri Jul 16 00:31:07 2004 pour dolibarr par + +doxygen 1.3.7
+ + diff --git a/doc/dev/php/latex/CMailFile_8class_8php.tex b/doc/dev/php/latex/CMailFile_8class_8php.tex new file mode 100644 index 00000000000..17925780e48 --- /dev/null +++ b/doc/dev/php/latex/CMailFile_8class_8php.tex @@ -0,0 +1,28 @@ +\hypertarget{CMailFile_8class_8php}{ +\section{R\'{e}f\'{e}rence du fichier htdocs/lib/CMail\-File.class.php} +\label{CMailFile_8class_8php}\index{htdocs/lib/CMailFile.class.php@{htdocs/lib/CMailFile.class.php}} +} +Classe permettant d'envoyer des attachements par mail. + + +\subsection*{Classes} +\begin{CompactItemize} +\item +class \hyperlink{classCMailFile}{CMail\-File} +\begin{CompactList}\small\item\em Classe permettant d'envoyer des attachements par mail. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Description d\'{e}taill\'{e}e} +Classe permettant d'envoyer des attachements par mail. + +\begin{Desc} +\item[Auteur:]Dan Potter. + +Eric Seigne + +Laurent Destailleur. \end{Desc} +\begin{Desc} +\item[Version:]1.2.\end{Desc} + + +D\'{e}finition dans le fichier \hyperlink{CMailFile_8class_8php-source}{CMail\-File.class.php}. \ No newline at end of file diff --git a/doc/dev/php/latex/annotated.tex b/doc/dev/php/latex/annotated.tex new file mode 100644 index 00000000000..f30bb7f9fa2 --- /dev/null +++ b/doc/dev/php/latex/annotated.tex @@ -0,0 +1,6 @@ +\section{dolibarr Liste des classes} +Liste des classes, structures, unions et interfaces avec une br\`{e}ve description:\begin{CompactList} +\item\contentsline{section}{\hyperlink{classCMailFile}{CMail\-File} (Classe permettant d'envoyer des attachements par mail )}{\pageref{classCMailFile}}{} +\item\contentsline{section}{\hyperlink{classDoliDb}{Doli\-Db} (Classe permettant de g\'{e}r\'{e}r la database de dolibarr )}{\pageref{classDoliDb}}{} +\item\contentsline{section}{\hyperlink{classWebcal}{Webcal} (Classe permettant d'acceder a la database webcalendar )}{\pageref{classWebcal}}{} +\end{CompactList} diff --git a/doc/dev/php/latex/classCMailFile.tex b/doc/dev/php/latex/classCMailFile.tex new file mode 100644 index 00000000000..233432a8aa8 --- /dev/null +++ b/doc/dev/php/latex/classCMailFile.tex @@ -0,0 +1,55 @@ +\hypertarget{classCMailFile}{ +\section{R\'{e}f\'{e}rence de la classe CMail\-File} +\label{classCMailFile}\index{CMailFile@{CMailFile}} +} +Classe permettant d'envoyer des attachements par mail. + + +\subsection*{Fonctions membres publiques} +\begin{CompactItemize} +\item +\hyperlink{classCMailFile_a0}{CMail\-File} (\$subject, \$to, \$from, \$msg, \$filename\_\-list, \$mimetype\_\-list, \$mimefilename\_\-list, \$addr\_\-cc=\char`\"{}\char`\"{}) +\begin{CompactList}\small\item\em CMail\-File. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Description d\'{e}taill\'{e}e} +Classe permettant d'envoyer des attachements par mail. + +\begin{Desc} +\item[Remarques:]Eric Seigne $<$\href{mailto:eric.seigne@ryxeo.com}{\tt eric.seigne@ryxeo.com}$>$ 2004.01.08 + +ajout de la gestion des cc: + +ajout de l'expedition de plusieurs fichiers + +Laurent Destailleur 2004.02.10 + +correction d'un disfonctionnement \`{a} la gestion des attachements multiples \end{Desc} + + + + +D\'{e}finition \`{a} la ligne 40 du fichier CMail\-File.class.php. + +\subsection{Documentation des contructeurs et destructeur} +\hypertarget{classCMailFile_a0}{ +\index{CMailFile@{CMail\-File}!CMailFile@{CMailFile}} +\index{CMailFile@{CMailFile}!CMailFile@{CMail\-File}} +\subsubsection[CMailFile]{\setlength{\rightskip}{0pt plus 5cm}CMail\-File::CMail\-File (\$ {\em subject}, \$ {\em to}, \$ {\em from}, \$ {\em msg}, \$ {\em filename\_\-list}, \$ {\em mimetype\_\-list}, \$ {\em mimefilename\_\-list}, \$ {\em addr\_\-cc} = {\tt \char`\"{}\char`\"{}})}} +\label{classCMailFile_a0} + + +CMail\-File. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em subject}]\item[{\em to}]\item[{\em from}]\item[{\em msg}]\item[{\em filename\_\-list}]\item[{\em mimetype\_\-list}]\item[{\em mimefilename\_\-list}]\item[{\em addr\_\-cc}]\end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 64 du fichier CMail\-File.class.php. + +La documentation de cette classe a \'{e}t\'{e} g\'{e}n\'{e}r\'{e}e \`{a} partir du fichier suivant:\begin{CompactItemize} +\item +htdocs/lib/\hyperlink{CMailFile_8class_8php}{CMail\-File.class.php}\end{CompactItemize} diff --git a/doc/dev/php/latex/classDoliDb.aux b/doc/dev/php/latex/classDoliDb.aux new file mode 100644 index 00000000000..a51026ef12e --- /dev/null +++ b/doc/dev/php/latex/classDoliDb.aux @@ -0,0 +1,80 @@ +\relax +\@writefile{toc}{\contentsline {section}{\numberline {3.2}R\'{e}f\'{e}rence de la classe Doli\discretionary {-}{}{}Db}{7}{section.3.2}} +\newlabel{classDoliDb}{{3.2}{7}{R\'{e}f\'{e}rence de la classe Doli\-Db\relax }{section.3.2}{}} +\newlabel{classDoliDb_a20}{{3.2}{8}{Fonctions membres publiques\relax }{section*.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.2.1}Description d\'{e}taill\'{e}e}{8}{subsection.3.2.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.2.2}Documentation des contructeurs et destructeur}{8}{subsection.3.2.2}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.2.1}DoliDb}{8}{subsubsection.3.2.2.1}} +\newlabel{classDoliDb_a0}{{3.2.2.1}{8}{DoliDb\relax }{subsubsection.3.2.2.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.2.3}Documentation des fonctions membres}{9}{subsection.3.2.3}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.1}affected\_\discretionary {-}{}{}rows}{9}{subsubsection.3.2.3.1}} +\newlabel{classDoliDb_a26}{{3.2.3.1}{9}{affected\_\-rows\relax }{subsubsection.3.2.3.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.2}begin}{9}{subsubsection.3.2.3.2}} +\newlabel{classDoliDb_a7}{{3.2.3.2}{9}{begin\relax }{subsubsection.3.2.3.2}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.3}clone}{9}{subsubsection.3.2.3.3}} +\newlabel{classDoliDb_a4}{{3.2.3.3}{9}{clone\relax }{subsubsection.3.2.3.3}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.4}close}{9}{subsubsection.3.2.3.4}} +\newlabel{classDoliDb_a6}{{3.2.3.4}{9}{close\relax }{subsubsection.3.2.3.4}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.5}commit}{10}{subsubsection.3.2.3.5}} +\newlabel{classDoliDb_a8}{{3.2.3.5}{10}{commit\relax }{subsubsection.3.2.3.5}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.6}connect}{10}{subsubsection.3.2.3.6}} +\newlabel{classDoliDb_a2}{{3.2.3.6}{10}{connect\relax }{subsubsection.3.2.3.6}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.7}create\_\discretionary {-}{}{}db}{10}{subsubsection.3.2.3.7}} +\newlabel{classDoliDb_a3}{{3.2.3.7}{10}{create\_\-db\relax }{subsubsection.3.2.3.7}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.8}errno}{11}{subsubsection.3.2.3.8}} +\newlabel{classDoliDb_a24}{{3.2.3.8}{11}{errno\relax }{subsubsection.3.2.3.8}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.9}error}{11}{subsubsection.3.2.3.9}} +\newlabel{classDoliDb_a23}{{3.2.3.9}{11}{error\relax }{subsubsection.3.2.3.9}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.10}fetch\_\discretionary {-}{}{}array}{11}{subsubsection.3.2.3.10}} +\newlabel{classDoliDb_a18}{{3.2.3.10}{11}{fetch\_\-array\relax }{subsubsection.3.2.3.10}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.11}fetch\_\discretionary {-}{}{}object}{11}{subsubsection.3.2.3.11}} +\newlabel{classDoliDb_a14}{{3.2.3.11}{11}{fetch\_\-object\relax }{subsubsection.3.2.3.11}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.12}fetch\_\discretionary {-}{}{}row}{11}{subsubsection.3.2.3.12}} +\newlabel{classDoliDb_a19}{{3.2.3.12}{11}{fetch\_\-row\relax }{subsubsection.3.2.3.12}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.13}free}{12}{subsubsection.3.2.3.13}} +\newlabel{classDoliDb_a13}{{3.2.3.13}{12}{free\relax }{subsubsection.3.2.3.13}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.14}idate}{12}{subsubsection.3.2.3.14}} +\newlabel{classDoliDb_a17}{{3.2.3.14}{12}{idate\relax }{subsubsection.3.2.3.14}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.15}last\_\discretionary {-}{}{}insert\_\discretionary {-}{}{}id}{12}{subsubsection.3.2.3.15}} +\newlabel{classDoliDb_a25}{{3.2.3.15}{12}{last\_\-insert\_\-id\relax }{subsubsection.3.2.3.15}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.16}list\_\discretionary {-}{}{}tables}{12}{subsubsection.3.2.3.16}} +\newlabel{classDoliDb_a11}{{3.2.3.16}{12}{list\_\-tables\relax }{subsubsection.3.2.3.16}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.17}num\_\discretionary {-}{}{}fields}{13}{subsubsection.3.2.3.17}} +\newlabel{classDoliDb_a22}{{3.2.3.17}{13}{num\_\-fields\relax }{subsubsection.3.2.3.17}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.18}num\_\discretionary {-}{}{}rows}{13}{subsubsection.3.2.3.18}} +\newlabel{classDoliDb_a21}{{3.2.3.18}{13}{num\_\-rows\relax }{subsubsection.3.2.3.18}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.19}pconnect}{13}{subsubsection.3.2.3.19}} +\newlabel{classDoliDb_a5}{{3.2.3.19}{13}{pconnect\relax }{subsubsection.3.2.3.19}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.20}plimit}{13}{subsubsection.3.2.3.20}} +\newlabel{classDoliDb_a15}{{3.2.3.20}{13}{plimit\relax }{subsubsection.3.2.3.20}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.21}query}{14}{subsubsection.3.2.3.21}} +\newlabel{classDoliDb_a10}{{3.2.3.21}{14}{query\relax }{subsubsection.3.2.3.21}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.22}result}{14}{subsubsection.3.2.3.22}} +\newlabel{classDoliDb_a12}{{3.2.3.22}{14}{result\relax }{subsubsection.3.2.3.22}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.23}rollback}{14}{subsubsection.3.2.3.23}} +\newlabel{classDoliDb_a9}{{3.2.3.23}{14}{rollback\relax }{subsubsection.3.2.3.23}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.3.24}select\_\discretionary {-}{}{}db}{15}{subsubsection.3.2.3.24}} +\newlabel{classDoliDb_a1}{{3.2.3.24}{15}{select\_\-db\relax }{subsubsection.3.2.3.24}{}} +\@setckpt{classDoliDb}{ +\setcounter{page}{16} +\setcounter{equation}{0} +\setcounter{enumi}{0} +\setcounter{enumii}{0} +\setcounter{enumiii}{0} +\setcounter{enumiv}{0} +\setcounter{footnote}{0} +\setcounter{mpfootnote}{0} +\setcounter{part}{0} +\setcounter{chapter}{3} +\setcounter{section}{2} +\setcounter{subsection}{3} +\setcounter{subsubsection}{24} +\setcounter{paragraph}{0} +\setcounter{subparagraph}{0} +\setcounter{figure}{0} +\setcounter{table}{0} +\setcounter{float@type}{4} +\setcounter{Item}{0} +\setcounter{Hfootnote}{0} +\setcounter{section@level}{3} +} diff --git a/doc/dev/php/latex/classDoliDb.tex b/doc/dev/php/latex/classDoliDb.tex new file mode 100644 index 00000000000..e7f75f6f89c --- /dev/null +++ b/doc/dev/php/latex/classDoliDb.tex @@ -0,0 +1,523 @@ +\hypertarget{classDoliDb}{ +\section{R\'{e}f\'{e}rence de la classe Doli\-Db} +\label{classDoliDb}\index{DoliDb@{DoliDb}} +} +Classe permettant de g\'{e}r\'{e}r la database de dolibarr. + + +\subsection*{Fonctions membres publiques} +\begin{CompactItemize} +\item +\hyperlink{classDoliDb_a0}{Doli\-Db} (\$type= 'mysql', \$host= '', \$user= '', \$pass= '', \$name= '') +\begin{CompactList}\small\item\em ouverture d'une connection vers le serveur et/ou une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a1}{select\_\-db} (\$database) +\begin{CompactList}\small\item\em selectionne une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a2}{connect} (\$host, \$login, \$passwd) +\begin{CompactList}\small\item\em connection vers une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a3}{create\_\-db} (\$database) +\begin{CompactList}\small\item\em cr\'{e}ation d'une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a4}{clone} () +\begin{CompactList}\small\item\em copie d'une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a5}{pconnect} (\$host, \$login, \$passwd) +\begin{CompactList}\small\item\em ouverture d'une connection vers une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a6}{close} () +\begin{CompactList}\small\item\em fermeture d'une connection vers une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a7}{begin} (\$do=1) +\begin{CompactList}\small\item\em debut d'une transaction. \item\end{CompactList}\item +\hyperlink{classDoliDb_a8}{commit} (\$do=1) +\begin{CompactList}\small\item\em \'{e}criture d'une transaction. \item\end{CompactList}\item +\hyperlink{classDoliDb_a9}{rollback} (\$do=1) +\begin{CompactList}\small\item\em \'{e}ffacement d'une transaction et retour au ancienne valeurs. \item\end{CompactList}\item +\hyperlink{classDoliDb_a10}{query} (\$query, \$limit=\char`\"{}\char`\"{}, \$offset=\char`\"{}\char`\"{}) +\begin{CompactList}\small\item\em requete vers une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a11}{list\_\-tables} (\$database) +\begin{CompactList}\small\item\em liste des tables dans une database. \item\end{CompactList}\item +\hyperlink{classDoliDb_a12}{result} (\$nb, \$fieldname) +\begin{CompactList}\small\item\em renvoie les donn\'{e}es de la requete. \item\end{CompactList}\item +\hyperlink{classDoliDb_a13}{free} () +\begin{CompactList}\small\item\em d\'{e}salloue la memoire de la requete. \item\end{CompactList}\item +\hyperlink{classDoliDb_a14}{fetch\_\-object} () +\begin{CompactList}\small\item\em renvoie les donn\'{e}es comme un objet. \item\end{CompactList}\item +\hyperlink{classDoliDb_a15}{plimit} (\$limit=0, \$offset=0) +\begin{CompactList}\small\item\em d\'{e}fini les limites de la requ\`{e}te. \item\end{CompactList}\item +\hyperlink{classDoliDb_a17}{idate} (\$fname) +\begin{CompactList}\small\item\em formatage de la date en fonction des locales. \item\end{CompactList}\item +\hyperlink{classDoliDb_a18}{fetch\_\-array} () +\begin{CompactList}\small\item\em renvoie les donn\'{e}es dans un tableau. \item\end{CompactList}\item +\hyperlink{classDoliDb_a19}{fetch\_\-row} () +\begin{CompactList}\small\item\em renvoie les donn\'{e}es comme un tableau. \item\end{CompactList}\item +\hypertarget{classDoliDb_a20}{ +\hyperlink{classDoliDb_a20}{fetch\_\-field} ()} +\label{classDoliDb_a20} + +\begin{CompactList}\small\item\em obtient les donn\'{e}es d'un colonne et renvoie les donn\'{e}es sous forme d'objet. \item\end{CompactList}\item +\hyperlink{classDoliDb_a21}{num\_\-rows} () +\begin{CompactList}\small\item\em renvoie le nombre de lignes dans le resultat de la requete. \item\end{CompactList}\item +\hyperlink{classDoliDb_a22}{num\_\-fields} () +\begin{CompactList}\small\item\em renvoie le nombre de champs dans le resultat de la requete. \item\end{CompactList}\item +\hyperlink{classDoliDb_a23}{error} () +\begin{CompactList}\small\item\em renvoie le texte de l'erreur mysql de l'operation precedente. \item\end{CompactList}\item +\hyperlink{classDoliDb_a24}{errno} () +\begin{CompactList}\small\item\em renvoie la valeur numerique de l'erreur mysql de l'operation precedente. \item\end{CompactList}\item +\hyperlink{classDoliDb_a25}{last\_\-insert\_\-id} () +\begin{CompactList}\small\item\em obtient l'id gen\'{e}r\'{e} par le pr\'{e}cedent INSERT. \item\end{CompactList}\item +\hyperlink{classDoliDb_a26}{affected\_\-rows} () +\begin{CompactList}\small\item\em obtient le nombre de lignes affect\'{e}es dans la pr\'{e}c\'{e}dente op\'{e}ration. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Description d\'{e}taill\'{e}e} +Classe permettant de g\'{e}r\'{e}r la database de dolibarr. + +Ensemble des fonctions permettant de g\'{e}rer la database de dolibarr + + + +D\'{e}finition \`{a} la ligne 41 du fichier mysql.lib.php. + +\subsection{Documentation des contructeurs et destructeur} +\hypertarget{classDoliDb_a0}{ +\index{DoliDb@{Doli\-Db}!DoliDb@{DoliDb}} +\index{DoliDb@{DoliDb}!DoliDb@{Doli\-Db}} +\subsubsection[DoliDb]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::Doli\-Db (\$ {\em type} = {\tt 'mysql'}, \$ {\em host} = {\tt ''}, \$ {\em user} = {\tt ''}, \$ {\em pass} = {\tt ''}, \$ {\em name} = {\tt ''})}} +\label{classDoliDb_a0} + + +ouverture d'une connection vers le serveur et/ou une database. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em type}]type de base de donn\'{e}es (mysql ou pgsql) \item[{\em host}]addresse de la base de donn\'{e}es \item[{\em user}]nom de l'utilisateur autoris\'{e} \item[{\em pass}]mot de passe \item[{\em name}]nom de la database \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 57 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences connect(), et select\_\-db(). + +\subsection{Documentation des fonctions membres} +\hypertarget{classDoliDb_a26}{ +\index{DoliDb@{Doli\-Db}!affected_rows@{affected\_\-rows}} +\index{affected_rows@{affected\_\-rows}!DoliDb@{Doli\-Db}} +\subsubsection[affected\_\-rows]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::affected\_\-rows ()}} +\label{classDoliDb_a26} + + +obtient le nombre de lignes affect\'{e}es dans la pr\'{e}c\'{e}dente op\'{e}ration. + +\begin{Desc} +\item[Renvoie:]rows \end{Desc} + + +D\'{e}finition \`{a} la ligne 448 du fichier mysql.lib.php.\hypertarget{classDoliDb_a7}{ +\index{DoliDb@{Doli\-Db}!begin@{begin}} +\index{begin@{begin}!DoliDb@{Doli\-Db}} +\subsubsection[begin]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::begin (\$ {\em do} = {\tt 1})}} +\label{classDoliDb_a7} + + +debut d'une transaction. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em do}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]string \end{Desc} + + +D\'{e}finition \`{a} la ligne 216 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences begin(), et query(). + +R\'{e}f\'{e}renc\'{e} par begin().\hypertarget{classDoliDb_a4}{ +\index{DoliDb@{Doli\-Db}!clone@{clone}} +\index{clone@{clone}!DoliDb@{Doli\-Db}} +\subsubsection[clone]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::clone ()}} +\label{classDoliDb_a4} + + +copie d'une database. + +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 179 du fichier mysql.lib.php.\hypertarget{classDoliDb_a6}{ +\index{DoliDb@{Doli\-Db}!close@{close}} +\index{close@{close}!DoliDb@{Doli\-Db}} +\subsubsection[close]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::close ()}} +\label{classDoliDb_a6} + + +fermeture d'une connection vers une database. + +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 205 du fichier mysql.lib.php.\hypertarget{classDoliDb_a8}{ +\index{DoliDb@{Doli\-Db}!commit@{commit}} +\index{commit@{commit}!DoliDb@{Doli\-Db}} +\subsubsection[commit]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::commit (\$ {\em do} = {\tt 1})}} +\label{classDoliDb_a8} + + +\'{e}criture d'une transaction. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em do}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]string \end{Desc} + + +D\'{e}finition \`{a} la ligne 234 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences commit(), et query(). + +R\'{e}f\'{e}renc\'{e} par commit().\hypertarget{classDoliDb_a2}{ +\index{DoliDb@{Doli\-Db}!connect@{connect}} +\index{connect@{connect}!DoliDb@{Doli\-Db}} +\subsubsection[connect]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::connect (\$ {\em host}, \$ {\em login}, \$ {\em passwd})}} +\label{classDoliDb_a2} + + +connection vers une database. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em host}]addresse de la base de donn\'{e}es \item[{\em login}]nom de l'utilisateur autoris\'{e} \item[{\em passwd}]mot de passe \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 149 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences connect(). + +R\'{e}f\'{e}renc\'{e} par connect(), et Doli\-Db().\hypertarget{classDoliDb_a3}{ +\index{DoliDb@{Doli\-Db}!create_db@{create\_\-db}} +\index{create_db@{create\_\-db}!DoliDb@{Doli\-Db}} +\subsubsection[create\_\-db]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::create\_\-db (\$ {\em database})}} +\label{classDoliDb_a3} + + +cr\'{e}ation d'une database. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em database}]nom de la database \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]result resultat 1 pour ok, 0 pour non ok \end{Desc} + + +D\'{e}finition \`{a} la ligne 162 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences create\_\-db(). + +R\'{e}f\'{e}renc\'{e} par create\_\-db().\hypertarget{classDoliDb_a24}{ +\index{DoliDb@{Doli\-Db}!errno@{errno}} +\index{errno@{errno}!DoliDb@{Doli\-Db}} +\subsubsection[errno]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::errno ()}} +\label{classDoliDb_a24} + + +renvoie la valeur numerique de l'erreur mysql de l'operation precedente. + +\begin{Desc} +\item[Renvoie:]error\_\-num \end{Desc} + + +D\'{e}finition \`{a} la ligne 425 du fichier mysql.lib.php.\hypertarget{classDoliDb_a23}{ +\index{DoliDb@{Doli\-Db}!error@{error}} +\index{error@{error}!DoliDb@{Doli\-Db}} +\subsubsection[error]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::error ()}} +\label{classDoliDb_a23} + + +renvoie le texte de l'erreur mysql de l'operation precedente. + +\begin{Desc} +\item[Renvoie:]error\_\-text \end{Desc} + + +D\'{e}finition \`{a} la ligne 415 du fichier mysql.lib.php.\hypertarget{classDoliDb_a18}{ +\index{DoliDb@{Doli\-Db}!fetch_array@{fetch\_\-array}} +\index{fetch_array@{fetch\_\-array}!DoliDb@{Doli\-Db}} +\subsubsection[fetch\_\-array]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::fetch\_\-array ()}} +\label{classDoliDb_a18} + + +renvoie les donn\'{e}es dans un tableau. + +\begin{Desc} +\item[Renvoie:]array \end{Desc} + + +D\'{e}finition \`{a} la ligne 365 du fichier mysql.lib.php.\hypertarget{classDoliDb_a14}{ +\index{DoliDb@{Doli\-Db}!fetch_object@{fetch\_\-object}} +\index{fetch_object@{fetch\_\-object}!DoliDb@{Doli\-Db}} +\subsubsection[fetch\_\-object]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::fetch\_\-object ()}} +\label{classDoliDb_a14} + + +renvoie les donn\'{e}es comme un objet. + +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 319 du fichier mysql.lib.php.\hypertarget{classDoliDb_a19}{ +\index{DoliDb@{Doli\-Db}!fetch_row@{fetch\_\-row}} +\index{fetch_row@{fetch\_\-row}!DoliDb@{Doli\-Db}} +\subsubsection[fetch\_\-row]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::fetch\_\-row ()}} +\label{classDoliDb_a19} + + +renvoie les donn\'{e}es comme un tableau. + +\begin{Desc} +\item[Renvoie:]array \end{Desc} + + +D\'{e}finition \`{a} la ligne 375 du fichier mysql.lib.php.\hypertarget{classDoliDb_a13}{ +\index{DoliDb@{Doli\-Db}!free@{free}} +\index{free@{free}!DoliDb@{Doli\-Db}} +\subsubsection[free]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::free ()}} +\label{classDoliDb_a13} + + +d\'{e}salloue la memoire de la requete. + +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 309 du fichier mysql.lib.php.\hypertarget{classDoliDb_a17}{ +\index{DoliDb@{Doli\-Db}!idate@{idate}} +\index{idate@{idate}!DoliDb@{Doli\-Db}} +\subsubsection[idate]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::idate (\$ {\em fname})}} +\label{classDoliDb_a17} + + +formatage de la date en fonction des locales. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em fname}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]date \end{Desc} + + +D\'{e}finition \`{a} la ligne 355 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences idate(). + +R\'{e}f\'{e}renc\'{e} par idate().\hypertarget{classDoliDb_a25}{ +\index{DoliDb@{Doli\-Db}!last_insert_id@{last\_\-insert\_\-id}} +\index{last_insert_id@{last\_\-insert\_\-id}!DoliDb@{Doli\-Db}} +\subsubsection[last\_\-insert\_\-id]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::last\_\-insert\_\-id ()}} +\label{classDoliDb_a25} + + +obtient l'id gen\'{e}r\'{e} par le pr\'{e}cedent INSERT. + +\begin{Desc} +\item[Renvoie:]id \end{Desc} + + +D\'{e}finition \`{a} la ligne 438 du fichier mysql.lib.php.\hypertarget{classDoliDb_a11}{ +\index{DoliDb@{Doli\-Db}!list_tables@{list\_\-tables}} +\index{list_tables@{list\_\-tables}!DoliDb@{Doli\-Db}} +\subsubsection[list\_\-tables]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::list\_\-tables (\$ {\em database})}} +\label{classDoliDb_a11} + + +liste des tables dans une database. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em database}]nom de la database \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 286 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences list\_\-tables(). + +R\'{e}f\'{e}renc\'{e} par list\_\-tables().\hypertarget{classDoliDb_a22}{ +\index{DoliDb@{Doli\-Db}!num_fields@{num\_\-fields}} +\index{num_fields@{num\_\-fields}!DoliDb@{Doli\-Db}} +\subsubsection[num\_\-fields]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::num\_\-fields ()}} +\label{classDoliDb_a22} + + +renvoie le nombre de champs dans le resultat de la requete. + +\begin{Desc} +\item[Renvoie:]int \end{Desc} + + +D\'{e}finition \`{a} la ligne 405 du fichier mysql.lib.php.\hypertarget{classDoliDb_a21}{ +\index{DoliDb@{Doli\-Db}!num_rows@{num\_\-rows}} +\index{num_rows@{num\_\-rows}!DoliDb@{Doli\-Db}} +\subsubsection[num\_\-rows]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::num\_\-rows ()}} +\label{classDoliDb_a21} + + +renvoie le nombre de lignes dans le resultat de la requete. + +\begin{Desc} +\item[Renvoie:]int \end{Desc} + + +D\'{e}finition \`{a} la ligne 395 du fichier mysql.lib.php.\hypertarget{classDoliDb_a5}{ +\index{DoliDb@{Doli\-Db}!pconnect@{pconnect}} +\index{pconnect@{pconnect}!DoliDb@{Doli\-Db}} +\subsubsection[pconnect]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::pconnect (\$ {\em host}, \$ {\em login}, \$ {\em passwd})}} +\label{classDoliDb_a5} + + +ouverture d'une connection vers une database. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em host}]addresse de la base de donn\'{e}es \item[{\em login}]nom de l'utilisateur autoris\'{e} \item[{\em passwd}]mot de passe \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 194 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences pconnect(). + +R\'{e}f\'{e}renc\'{e} par pconnect().\hypertarget{classDoliDb_a15}{ +\index{DoliDb@{Doli\-Db}!plimit@{plimit}} +\index{plimit@{plimit}!DoliDb@{Doli\-Db}} +\subsubsection[plimit]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::plimit (\$ {\em limit} = {\tt 0}, \$ {\em offset} = {\tt 0})}} +\label{classDoliDb_a15} + + +d\'{e}fini les limites de la requ\`{e}te. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em limit}]\item[{\em offset}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]limit \end{Desc} + + +D\'{e}finition \`{a} la ligne 331 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences plimit(). + +R\'{e}f\'{e}renc\'{e} par plimit().\hypertarget{classDoliDb_a10}{ +\index{DoliDb@{Doli\-Db}!query@{query}} +\index{query@{query}!DoliDb@{Doli\-Db}} +\subsubsection[query]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::query (\$ {\em query}, \$ {\em limit} = {\tt \char`\"{}\char`\"{}}, \$ {\em offset} = {\tt \char`\"{}\char`\"{}})}} +\label{classDoliDb_a10} + + +requete vers une database. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em query}]contenu de la query \item[{\em limit}]\item[{\em offset}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 272 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences query(). + +R\'{e}f\'{e}renc\'{e} par begin(), commit(), query(), et rollback().\hypertarget{classDoliDb_a12}{ +\index{DoliDb@{Doli\-Db}!result@{result}} +\index{result@{result}!DoliDb@{Doli\-Db}} +\subsubsection[result]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::result (\$ {\em nb}, \$ {\em fieldname})}} +\label{classDoliDb_a12} + + +renvoie les donn\'{e}es de la requete. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em nb}]contenu de la query \item[{\em fieldname}]nom du champ \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 299 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences result(). + +R\'{e}f\'{e}renc\'{e} par result().\hypertarget{classDoliDb_a9}{ +\index{DoliDb@{Doli\-Db}!rollback@{rollback}} +\index{rollback@{rollback}!DoliDb@{Doli\-Db}} +\subsubsection[rollback]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::rollback (\$ {\em do} = {\tt 1})}} +\label{classDoliDb_a9} + + +\'{e}ffacement d'une transaction et retour au ancienne valeurs. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em do}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]string \end{Desc} + + +D\'{e}finition \`{a} la ligne 252 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences query(), et rollback(). + +R\'{e}f\'{e}renc\'{e} par rollback().\hypertarget{classDoliDb_a1}{ +\index{DoliDb@{Doli\-Db}!select_db@{select\_\-db}} +\index{select_db@{select\_\-db}!DoliDb@{Doli\-Db}} +\subsubsection[select\_\-db]{\setlength{\rightskip}{0pt plus 5cm}Doli\-Db::select\_\-db (\$ {\em database})}} +\label{classDoliDb_a1} + + +selectionne une database. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em database}]nom de la database \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 136 du fichier mysql.lib.php. + +R\'{e}f\'{e}rences select\_\-db(). + +R\'{e}f\'{e}renc\'{e} par Doli\-Db(), et select\_\-db(). + +La documentation de cette classe a \'{e}t\'{e} g\'{e}n\'{e}r\'{e}e \`{a} partir du fichier suivant:\begin{CompactItemize} +\item +htdocs/lib/\hyperlink{mysql_8lib_8php}{mysql.lib.php}\end{CompactItemize} diff --git a/doc/dev/php/latex/classWebcal.aux b/doc/dev/php/latex/classWebcal.aux new file mode 100644 index 00000000000..59ceeceb34f --- /dev/null +++ b/doc/dev/php/latex/classWebcal.aux @@ -0,0 +1,33 @@ +\relax +\@writefile{toc}{\contentsline {section}{\numberline {3.3}R\'{e}f\'{e}rence de la classe Webcal}{16}{section.3.3}} +\newlabel{classWebcal}{{3.3}{16}{R\'{e}f\'{e}rence de la classe Webcal\relax }{section.3.3}{}} +\newlabel{classWebcal_a0}{{3.3}{16}{Fonctions membres publiques\relax }{section*.4}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.3.1}Description d\'{e}taill\'{e}e}{16}{subsection.3.3.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.3.2}Documentation des fonctions membres}{16}{subsection.3.3.2}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.2.1}add}{16}{subsubsection.3.3.2.1}} +\newlabel{classWebcal_a1}{{3.3.2.1}{16}{add\relax }{subsubsection.3.3.2.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.2.2}get\_\discretionary {-}{}{}next\_\discretionary {-}{}{}id}{16}{subsubsection.3.3.2.2}} +\newlabel{classWebcal_a2}{{3.3.2.2}{16}{get\_\-next\_\-id\relax }{subsubsection.3.3.2.2}{}} +\@setckpt{classWebcal}{ +\setcounter{page}{18} +\setcounter{equation}{0} +\setcounter{enumi}{0} +\setcounter{enumii}{0} +\setcounter{enumiii}{0} +\setcounter{enumiv}{0} +\setcounter{footnote}{0} +\setcounter{mpfootnote}{0} +\setcounter{part}{0} +\setcounter{chapter}{3} +\setcounter{section}{3} +\setcounter{subsection}{2} +\setcounter{subsubsection}{2} +\setcounter{paragraph}{0} +\setcounter{subparagraph}{0} +\setcounter{figure}{0} +\setcounter{table}{0} +\setcounter{float@type}{4} +\setcounter{Item}{0} +\setcounter{Hfootnote}{0} +\setcounter{section@level}{3} +} diff --git a/doc/dev/php/latex/classWebcal.tex b/doc/dev/php/latex/classWebcal.tex new file mode 100644 index 00000000000..f37f29a104a --- /dev/null +++ b/doc/dev/php/latex/classWebcal.tex @@ -0,0 +1,74 @@ +\hypertarget{classWebcal}{ +\section{R\'{e}f\'{e}rence de la classe Webcal} +\label{classWebcal}\index{Webcal@{Webcal}} +} +Classe permettant d'acceder a la database webcalendar. + + +\subsection*{Fonctions membres publiques} +\begin{CompactItemize} +\item +\hypertarget{classWebcal_a0}{ +\hyperlink{classWebcal_a0}{Webcal} ()} +\label{classWebcal_a0} + +\begin{CompactList}\small\item\em Permet de se connecter a la database webcalendar. \item\end{CompactList}\item +\hyperlink{classWebcal_a1}{add} (\$user, \$date, \$texte, \$desc) +\begin{CompactList}\small\item\em ajoute une entree dans le calendrier de l'utilsateur \item\end{CompactList}\item +\hyperlink{classWebcal_a2}{get\_\-next\_\-id} () +\begin{CompactList}\small\item\em obtient l'id suivant dans le webcalendar \item\end{CompactList}\end{CompactItemize} + + +\subsection{Description d\'{e}taill\'{e}e} +Classe permettant d'acceder a la database webcalendar. + +Ensemble des fonctions permettant d'acceder a la database webcalendar + + + +D\'{e}finition \`{a} la ligne 37 du fichier webcal.class.php. + +\subsection{Documentation des fonctions membres} +\hypertarget{classWebcal_a1}{ +\index{Webcal@{Webcal}!add@{add}} +\index{add@{add}!Webcal@{Webcal}} +\subsubsection[add]{\setlength{\rightskip}{0pt plus 5cm}Webcal::add (\$ {\em user}, \$ {\em date}, \$ {\em texte}, \$ {\em desc})}} +\label{classWebcal_a1} + + +ajoute une entree dans le calendrier de l'utilsateur + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[\mbox{$\leftarrow$} {\em user}]le login de l'utilisateur \item[\mbox{$\leftarrow$} {\em date}]la date de l'evenement dans le calendrier \item[\mbox{$\leftarrow$} {\em texte}]le titre a indiquer dans l'evenement \item[\mbox{$\leftarrow$} {\em desc}]la description a indiquer dans l'evenement \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 65 du fichier webcal.class.php. + +R\'{e}f\'{e}rences add(), et get\_\-next\_\-id(). + +R\'{e}f\'{e}renc\'{e} par add().\hypertarget{classWebcal_a2}{ +\index{Webcal@{Webcal}!get_next_id@{get\_\-next\_\-id}} +\index{get_next_id@{get\_\-next\_\-id}!Webcal@{Webcal}} +\subsubsection[get\_\-next\_\-id]{\setlength{\rightskip}{0pt plus 5cm}Webcal::get\_\-next\_\-id ()}} +\label{classWebcal_a2} + + +obtient l'id suivant dans le webcalendar + +\begin{Desc} +\item[Valeurs retourn\'{e}es:] +\begin{description} +\item[{\em id}]retourne l'id suivant dans le webcalendar \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 118 du fichier webcal.class.php. + +R\'{e}f\'{e}renc\'{e} par add(). + +La documentation de cette classe a \'{e}t\'{e} g\'{e}n\'{e}r\'{e}e \`{a} partir du fichier suivant:\begin{CompactItemize} +\item +htdocs/lib/\hyperlink{webcal_8class_8php}{webcal.class.php}\end{CompactItemize} diff --git a/doc/dev/php/latex/classWebcal_1_1Webcal.tex b/doc/dev/php/latex/classWebcal_1_1Webcal.tex new file mode 100644 index 00000000000..40cf3ccb612 --- /dev/null +++ b/doc/dev/php/latex/classWebcal_1_1Webcal.tex @@ -0,0 +1,19 @@ +\hypertarget{classWebcal_1_1Webcal}{ +\section{R\'{e}f\'{e}rence de la classe Webcal::Webcal} +\label{classWebcal_1_1Webcal}\index{Webcal::Webcal@{Webcal::Webcal}} +} +Classe permettant d'acceder a la database webcalendar. + + + + +\subsection{Description d\'{e}taill\'{e}e} +Classe permettant d'acceder a la database webcalendar. + +Ensemble des fonctions permettant d'acceder a la database webcalendar. + + + +La documentation de cette classe a \'{e}t\'{e} g\'{e}n\'{e}r\'{e}e \`{a} partir du fichier suivant:\begin{CompactItemize} +\item +htdocs/lib/\hyperlink{webcal_8class_8php}{webcal.class.php}\end{CompactItemize} diff --git a/doc/dev/php/latex/functions_8inc_8php.aux b/doc/dev/php/latex/functions_8inc_8php.aux new file mode 100644 index 00000000000..b6e4ed3ffb8 --- /dev/null +++ b/doc/dev/php/latex/functions_8inc_8php.aux @@ -0,0 +1,88 @@ +\relax +\@writefile{toc}{\contentsline {section}{\numberline {4.2}R\'{e}f\'{e}rence du fichier htdocs/lib/functions.inc.php}{20}{section.4.2}} +\newlabel{functions_8inc_8php}{{4.2}{20}{R\'{e}f\'{e}rence du fichier htdocs/lib/functions.inc.php\relax }{section.4.2}{}} +\newlabel{functions_8inc_8php_a22}{{4.2}{20}{Fonctions\relax }{section*.6}{}} +\newlabel{functions_8inc_8php_a31}{{4.2}{21}{Fonctions\relax }{section*.6}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.1}Description d\'{e}taill\'{e}e}{21}{subsection.4.2.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.2}Documentation des fonctions}{22}{subsection.4.2.2}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.1}creer\_\discretionary {-}{}{}pass\_\discretionary {-}{}{}aleatoire}{22}{subsubsection.4.2.2.1}} +\newlabel{functions_8inc_8php_a45}{{4.2.2.1}{22}{creer\_\-pass\_\-aleatoire\relax }{subsubsection.4.2.2.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.2}dol\_\discretionary {-}{}{}delete\_\discretionary {-}{}{}file}{22}{subsubsection.4.2.2.2}} +\newlabel{functions_8inc_8php_a30}{{4.2.2.2}{22}{dol\_\-delete\_\-file\relax }{subsubsection.4.2.2.2}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.3}dolibarr\_\discretionary {-}{}{}del\_\discretionary {-}{}{}const}{22}{subsubsection.4.2.2.3}} +\newlabel{functions_8inc_8php_a4}{{4.2.2.3}{22}{dolibarr\_\-del\_\-const\relax }{subsubsection.4.2.2.3}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.4}dolibarr\_\discretionary {-}{}{}fiche\_\discretionary {-}{}{}head}{22}{subsubsection.4.2.2.4}} +\newlabel{functions_8inc_8php_a2}{{4.2.2.4}{22}{dolibarr\_\-fiche\_\-head\relax }{subsubsection.4.2.2.4}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.5}dolibarr\_\discretionary {-}{}{}print\_\discretionary {-}{}{}ca}{23}{subsubsection.4.2.2.5}} +\newlabel{functions_8inc_8php_a5}{{4.2.2.5}{23}{dolibarr\_\-print\_\-ca\relax }{subsubsection.4.2.2.5}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.6}dolibarr\_\discretionary {-}{}{}print\_\discretionary {-}{}{}date}{23}{subsubsection.4.2.2.6}} +\newlabel{functions_8inc_8php_a6}{{4.2.2.6}{23}{dolibarr\_\-print\_\-date\relax }{subsubsection.4.2.2.6}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.7}dolibarr\_\discretionary {-}{}{}print\_\discretionary {-}{}{}object\_\discretionary {-}{}{}info}{23}{subsubsection.4.2.2.7}} +\newlabel{functions_8inc_8php_a7}{{4.2.2.7}{23}{dolibarr\_\-print\_\-object\_\-info\relax }{subsubsection.4.2.2.7}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.8}dolibarr\_\discretionary {-}{}{}print\_\discretionary {-}{}{}phone}{23}{subsubsection.4.2.2.8}} +\newlabel{functions_8inc_8php_a8}{{4.2.2.8}{23}{dolibarr\_\-print\_\-phone\relax }{subsubsection.4.2.2.8}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.9}dolibarr\_\discretionary {-}{}{}set\_\discretionary {-}{}{}const}{24}{subsubsection.4.2.2.9}} +\newlabel{functions_8inc_8php_a3}{{4.2.2.9}{24}{dolibarr\_\-set\_\-const\relax }{subsubsection.4.2.2.9}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.10}dolibarr\_\discretionary {-}{}{}syslog}{24}{subsubsection.4.2.2.10}} +\newlabel{functions_8inc_8php_a1}{{4.2.2.10}{24}{dolibarr\_\-syslog\relax }{subsubsection.4.2.2.10}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.11}doliMoveFileUpload}{24}{subsubsection.4.2.2.11}} +\newlabel{functions_8inc_8php_a23}{{4.2.2.11}{24}{doliMoveFileUpload\relax }{subsubsection.4.2.2.11}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.12}francs}{25}{subsubsection.4.2.2.12}} +\newlabel{functions_8inc_8php_a39}{{4.2.2.12}{25}{francs\relax }{subsubsection.4.2.2.12}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.13}inctva}{25}{subsubsection.4.2.2.13}} +\newlabel{functions_8inc_8php_a41}{{4.2.2.13}{25}{inctva\relax }{subsubsection.4.2.2.13}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.14}initialiser\_\discretionary {-}{}{}sel}{25}{subsubsection.4.2.2.14}} +\newlabel{functions_8inc_8php_a46}{{4.2.2.14}{25}{initialiser\_\-sel\relax }{subsubsection.4.2.2.14}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.15}logfile}{25}{subsubsection.4.2.2.15}} +\newlabel{functions_8inc_8php_a44}{{4.2.2.15}{25}{logfile\relax }{subsubsection.4.2.2.15}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.16}loginfunction}{26}{subsubsection.4.2.2.16}} +\newlabel{functions_8inc_8php_a21}{{4.2.2.16}{26}{loginfunction\relax }{subsubsection.4.2.2.16}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.17}price}{26}{subsubsection.4.2.2.17}} +\newlabel{functions_8inc_8php_a38}{{4.2.2.17}{26}{price\relax }{subsubsection.4.2.2.17}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.18}print\_\discretionary {-}{}{}date\_\discretionary {-}{}{}select}{26}{subsubsection.4.2.2.18}} +\newlabel{functions_8inc_8php_a35}{{4.2.2.18}{26}{print\_\-date\_\-select\relax }{subsubsection.4.2.2.18}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.19}print\_\discretionary {-}{}{}duree\_\discretionary {-}{}{}select}{26}{subsubsection.4.2.2.19}} +\newlabel{functions_8inc_8php_a37}{{4.2.2.19}{26}{print\_\-duree\_\-select\relax }{subsubsection.4.2.2.19}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.20}print\_\discretionary {-}{}{}fiche\_\discretionary {-}{}{}titre}{27}{subsubsection.4.2.2.20}} +\newlabel{functions_8inc_8php_a29}{{4.2.2.20}{27}{print\_\-fiche\_\-titre\relax }{subsubsection.4.2.2.20}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.21}print\_\discretionary {-}{}{}fleche\_\discretionary {-}{}{}navigation}{27}{subsubsection.4.2.2.21}} +\newlabel{functions_8inc_8php_a33}{{4.2.2.21}{27}{print\_\-fleche\_\-navigation\relax }{subsubsection.4.2.2.21}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.22}print\_\discretionary {-}{}{}heure\_\discretionary {-}{}{}select}{27}{subsubsection.4.2.2.22}} +\newlabel{functions_8inc_8php_a36}{{4.2.2.22}{27}{print\_\-heure\_\-select\relax }{subsubsection.4.2.2.22}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.23}print\_\discretionary {-}{}{}liste\_\discretionary {-}{}{}field\_\discretionary {-}{}{}titre}{27}{subsubsection.4.2.2.23}} +\newlabel{functions_8inc_8php_a26}{{4.2.2.23}{27}{print\_\-liste\_\-field\_\-titre\relax }{subsubsection.4.2.2.23}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.24}print\_\discretionary {-}{}{}liste\_\discretionary {-}{}{}field\_\discretionary {-}{}{}titre\_\discretionary {-}{}{}new}{28}{subsubsection.4.2.2.24}} +\newlabel{functions_8inc_8php_a27}{{4.2.2.24}{28}{print\_\-liste\_\-field\_\-titre\_\-new\relax }{subsubsection.4.2.2.24}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.25}print\_\discretionary {-}{}{}oui\_\discretionary {-}{}{}non}{28}{subsubsection.4.2.2.25}} +\newlabel{functions_8inc_8php_a34}{{4.2.2.25}{28}{print\_\-oui\_\-non\relax }{subsubsection.4.2.2.25}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.26}print\_\discretionary {-}{}{}titre}{28}{subsubsection.4.2.2.26}} +\newlabel{functions_8inc_8php_a28}{{4.2.2.26}{28}{print\_\-titre\relax }{subsubsection.4.2.2.26}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.27}stat\_\discretionary {-}{}{}print}{29}{subsubsection.4.2.2.27}} +\newlabel{functions_8inc_8php_a42}{{4.2.2.27}{29}{stat\_\-print\relax }{subsubsection.4.2.2.27}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.28}transcoS2L}{29}{subsubsection.4.2.2.28}} +\newlabel{functions_8inc_8php_a25}{{4.2.2.28}{29}{transcoS2L\relax }{subsubsection.4.2.2.28}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.2.2.29}tva}{29}{subsubsection.4.2.2.29}} +\newlabel{functions_8inc_8php_a40}{{4.2.2.29}{29}{tva\relax }{subsubsection.4.2.2.29}{}} +\@setckpt{functions_8inc_8php}{ +\setcounter{page}{30} +\setcounter{equation}{0} +\setcounter{enumi}{0} +\setcounter{enumii}{0} +\setcounter{enumiii}{0} +\setcounter{enumiv}{0} +\setcounter{footnote}{0} +\setcounter{mpfootnote}{0} +\setcounter{part}{0} +\setcounter{chapter}{4} +\setcounter{section}{2} +\setcounter{subsection}{2} +\setcounter{subsubsection}{29} +\setcounter{paragraph}{0} +\setcounter{subparagraph}{0} +\setcounter{figure}{0} +\setcounter{table}{0} +\setcounter{float@type}{4} +\setcounter{Item}{0} +\setcounter{Hfootnote}{0} +\setcounter{section@level}{3} +} diff --git a/doc/dev/php/latex/functions_8inc_8php.tex b/doc/dev/php/latex/functions_8inc_8php.tex new file mode 100644 index 00000000000..0f0190fdba9 --- /dev/null +++ b/doc/dev/php/latex/functions_8inc_8php.tex @@ -0,0 +1,615 @@ +\hypertarget{functions_8inc_8php}{ +\section{R\'{e}f\'{e}rence du fichier htdocs/lib/functions.inc.php} +\label{functions_8inc_8php}\index{htdocs/lib/functions.inc.php@{htdocs/lib/functions.inc.php}} +} +Ensemble de fonctions de base de dolibarr sous forme d'include. + + +\subsection*{Fonctions} +\begin{CompactItemize} +\item +\hyperlink{functions_8inc_8php_a1}{dolibarr\_\-syslog} (\$message) +\begin{CompactList}\small\item\em envoi des messages dolibarr dans syslog \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a2}{dolibarr\_\-fiche\_\-head} (\$links, \$active=0) +\begin{CompactList}\small\item\em header d'une fiche \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a3}{dolibarr\_\-set\_\-const} (\$db, \$name, \$value, \$type='chaine', \$visible=0, \$note='') +\begin{CompactList}\small\item\em insertion d'une constantes dans la base de donn\'{e}es \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a4}{dolibarr\_\-del\_\-const} (\$db, \$name) +\begin{CompactList}\small\item\em effacement d'une constante dans la base de donn\'{e}es \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a5}{dolibarr\_\-print\_\-ca} (\$ca) +\begin{CompactList}\small\item\em formattage des nombres \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a6}{dolibarr\_\-print\_\-date} (\$time, \$format=\char`\"{}\%d \%b \%Y\char`\"{}) +\begin{CompactList}\small\item\em formattage de la date \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a7}{dolibarr\_\-print\_\-object\_\-info} (\$object) +\begin{CompactList}\small\item\em affiche les informations d'un objet \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a8}{dolibarr\_\-print\_\-phone} (\$phone) +\begin{CompactList}\small\item\em formattage du telephone \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a21}{loginfunction} () +\begin{CompactList}\small\item\em fonction de login \item\end{CompactList}\item +\hypertarget{functions_8inc_8php_a22}{ +\hyperlink{functions_8inc_8php_a22}{accessforbidden} ()} +\label{functions_8inc_8php_a22} + +\begin{CompactList}\small\item\em acces interdit \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a23}{doli\-Move\-File\-Upload} (\$src\_\-file, \$dest\_\-file) +\begin{CompactList}\small\item\em deplacer les fichiers telecharg\'{e}s \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a25}{transco\-S2L} (\$zonein, \$devise) +\begin{CompactList}\small\item\em transcodage de francs en euros \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a26}{print\_\-liste\_\-field\_\-titre} (\$name, \$file, \$field, \$begin=\char`\"{}\char`\"{}, \$options=\char`\"{}\char`\"{}) +\begin{CompactList}\small\item\em affichage du titre d'une liste \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a27}{print\_\-liste\_\-field\_\-titre\_\-new} (\$name, \$file, \$field, \$begin=\char`\"{}\char`\"{}, \$options=\char`\"{}\char`\"{}, \$td=\char`\"{}\char`\"{}, \$sortfield=\char`\"{}\char`\"{}) +\begin{CompactList}\small\item\em affichage du titre d'une liste avec possibilit\'{e} de tri et de choix du type de la balise td \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a28}{print\_\-titre} (\$titre) +\begin{CompactList}\small\item\em affichage d'un titre \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a29}{print\_\-fiche\_\-titre} (\$titre, \$mesg='') +\begin{CompactList}\small\item\em affichage d'un titre d'une fiche align\'{e} a droite \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a30}{dol\_\-delete\_\-file} (\$file) +\begin{CompactList}\small\item\em effacement d'un fichier \item\end{CompactList}\item +\hypertarget{functions_8inc_8php_a31}{ +\hyperlink{functions_8inc_8php_a31}{block\_\-access} ()} +\label{functions_8inc_8php_a31} + +\begin{CompactList}\small\item\em acc\`{e}s refus\'{e} \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a33}{print\_\-fleche\_\-navigation} (\$page, \$file, \$options='', \$nextpage) +\begin{CompactList}\small\item\em fonction servant a afficher les fleches de navigation dans les pages de listes \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a34}{print\_\-oui\_\-non} (\$value) +\begin{CompactList}\small\item\em fonction servant a afficher un menu d\'{e}roulant avec oui ou non \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a35}{print\_\-date\_\-select} (\$set\_\-time='') +\begin{CompactList}\small\item\em fonction servant a afficher les mois dans un liste d\'{e}roulante \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a36}{print\_\-heure\_\-select} (\$prefix, \$begin=1, \$end=23) +\begin{CompactList}\small\item\em fonction servant a afficher les heures/minutes dans un liste d\'{e}roulante \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a37}{print\_\-duree\_\-select} (\$prefix) +\begin{CompactList}\small\item\em fonction servant a afficher une dur\'{e}e dans une liste d\'{e}roulante \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a38}{price} (\$amount, \$html=0) +\begin{CompactList}\small\item\em fonction qui retourne un montant mon\'{e}taire format\'{e} \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a39}{francs} (\$euros) +\begin{CompactList}\small\item\em fonction qui convertit des euros en francs \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a40}{tva} (\$euros, \$taux=19.6) +\begin{CompactList}\small\item\em fonction qui calcule la tva \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a41}{inctva} (\$euros, \$taux=1.196) +\begin{CompactList}\small\item\em fonction qui calcule le montant tva incluse \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a42}{stat\_\-print} (\$basename, \$bc1, \$bc2, \$ftc, \$jour) +\begin{CompactList}\small\item\em fonction qui affiche des statistiques \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a44}{logfile} (\$str, \$log=\char`\"{}/var/log/dolibarr/dolibarr.log\char`\"{}) +\begin{CompactList}\small\item\em fonction qui permet d'envoyer les infos dans un fichier de log \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a45}{creer\_\-pass\_\-aleatoire} (\$longueur=8, \$sel=\char`\"{}\char`\"{}) +\begin{CompactList}\small\item\em fonction pour cr\'{e}er un mot de passe al\'{e}atoire \item\end{CompactList}\item +\hyperlink{functions_8inc_8php_a46}{initialiser\_\-sel} () +\begin{CompactList}\small\item\em fonction pour initialiser sel \item\end{CompactList}\end{CompactItemize} + + +\subsection{Description d\'{e}taill\'{e}e} +Ensemble de fonctions de base de dolibarr sous forme d'include. + +\begin{Desc} +\item[Auteur:]Rodolphe Quiedeville + +Jean-Louis Bergamo + +Laurent Destailleur \end{Desc} +\begin{Desc} +\item[Version:]1.2.\end{Desc} +Ensemble de fonctions de base de dolibarr sous forme d'include + +D\'{e}finition dans le fichier \hyperlink{functions_8inc_8php-source}{functions.inc.php}. + +\subsection{Documentation des fonctions} +\hypertarget{functions_8inc_8php_a45}{ +\index{functions.inc.php@{functions.inc.php}!creer_pass_aleatoire@{creer\_\-pass\_\-aleatoire}} +\index{creer_pass_aleatoire@{creer\_\-pass\_\-aleatoire}!functions.inc.php@{functions.inc.php}} +\subsubsection[creer\_\-pass\_\-aleatoire]{\setlength{\rightskip}{0pt plus 5cm}creer\_\-pass\_\-aleatoire (\$ {\em longueur} = {\tt 8}, \$ {\em sel} = {\tt \char`\"{}\char`\"{}})}} +\label{functions_8inc_8php_a45} + + +fonction pour cr\'{e}er un mot de passe al\'{e}atoire + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em longueur}]longueur du mot de passe \item[{\em sel}]donn\'{e}e al\'{e}atoire \end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]la longueur est fix\'{e}e a 8 par d\'{e}faut + +la fonction a \'{e}t\'{e} prise sur \href{http://www.uzine.net/spip}{\tt http://www.uzine.net/spip} \end{Desc} + + +D\'{e}finition \`{a} la ligne 1224 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a30}{ +\index{functions.inc.php@{functions.inc.php}!dol_delete_file@{dol\_\-delete\_\-file}} +\index{dol_delete_file@{dol\_\-delete\_\-file}!functions.inc.php@{functions.inc.php}} +\subsubsection[dol\_\-delete\_\-file]{\setlength{\rightskip}{0pt plus 5cm}dol\_\-delete\_\-file (\$ {\em file})}} +\label{functions_8inc_8php_a30} + + +effacement d'un fichier + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em file}]fichier a effacer \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 735 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a4}{ +\index{functions.inc.php@{functions.inc.php}!dolibarr_del_const@{dolibarr\_\-del\_\-const}} +\index{dolibarr_del_const@{dolibarr\_\-del\_\-const}!functions.inc.php@{functions.inc.php}} +\subsubsection[dolibarr\_\-del\_\-const]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-del\_\-const (\$ {\em db}, \$ {\em name})}} +\label{functions_8inc_8php_a4} + + +effacement d'une constante dans la base de donn\'{e}es + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em db}]base de donn\'{e}es \item[{\em name}]nom de la constante \end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]retourne 0 pour rat\'{e}, 1 pour r\'{e}ussi \end{Desc} + + +D\'{e}finition \`{a} la ligne 124 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a2}{ +\index{functions.inc.php@{functions.inc.php}!dolibarr_fiche_head@{dolibarr\_\-fiche\_\-head}} +\index{dolibarr_fiche_head@{dolibarr\_\-fiche\_\-head}!functions.inc.php@{functions.inc.php}} +\subsubsection[dolibarr\_\-fiche\_\-head]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-fiche\_\-head (\$ {\em links}, \$ {\em active} = {\tt 0})}} +\label{functions_8inc_8php_a2} + + +header d'une fiche + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em links}]liens \item[{\em active}]\end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]active = 0 par d\'{e}faut \end{Desc} + + +D\'{e}finition \`{a} la ligne 63 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a5}{ +\index{functions.inc.php@{functions.inc.php}!dolibarr_print_ca@{dolibarr\_\-print\_\-ca}} +\index{dolibarr_print_ca@{dolibarr\_\-print\_\-ca}!functions.inc.php@{functions.inc.php}} +\subsubsection[dolibarr\_\-print\_\-ca]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-print\_\-ca (\$ {\em ca})}} +\label{functions_8inc_8php_a5} + + +formattage des nombres + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em ca}]valeur a formater \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]cat valeur format\'{e}e \end{Desc} + + +D\'{e}finition \`{a} la ligne 144 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a6}{ +\index{functions.inc.php@{functions.inc.php}!dolibarr_print_date@{dolibarr\_\-print\_\-date}} +\index{dolibarr_print_date@{dolibarr\_\-print\_\-date}!functions.inc.php@{functions.inc.php}} +\subsubsection[dolibarr\_\-print\_\-date]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-print\_\-date (\$ {\em time}, \$ {\em format} = {\tt \char`\"{}\%d\ \%b\ \%Y\char`\"{}})}} +\label{functions_8inc_8php_a6} + + +formattage de la date + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em time}]date \item[{\em format}]format de la date \char`\"{}\%d \%b \%Y\char`\"{} \end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]retourne la date format\'{e}e \end{Desc} + + +D\'{e}finition \`{a} la ligne 173 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a7}{ +\index{functions.inc.php@{functions.inc.php}!dolibarr_print_object_info@{dolibarr\_\-print\_\-object\_\-info}} +\index{dolibarr_print_object_info@{dolibarr\_\-print\_\-object\_\-info}!functions.inc.php@{functions.inc.php}} +\subsubsection[dolibarr\_\-print\_\-object\_\-info]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-print\_\-object\_\-info (\$ {\em object})}} +\label{functions_8inc_8php_a7} + + +affiche les informations d'un objet + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em object}]objet a afficher \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 184 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a8}{ +\index{functions.inc.php@{functions.inc.php}!dolibarr_print_phone@{dolibarr\_\-print\_\-phone}} +\index{dolibarr_print_phone@{dolibarr\_\-print\_\-phone}!functions.inc.php@{functions.inc.php}} +\subsubsection[dolibarr\_\-print\_\-phone]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-print\_\-phone (\$ {\em phone})}} +\label{functions_8inc_8php_a8} + + +formattage du telephone + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em phone}]num\'{e}ro de telephone \`{a} formater \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]phone num\'{e}ro de t\'{e}l\'{e}phone format\'{e} \end{Desc} +\begin{Desc} +\item[Remarques:]net tient pas en compte le format belge 02/211 34 83 \end{Desc} + + +D\'{e}finition \`{a} la ligne 199 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a3}{ +\index{functions.inc.php@{functions.inc.php}!dolibarr_set_const@{dolibarr\_\-set\_\-const}} +\index{dolibarr_set_const@{dolibarr\_\-set\_\-const}!functions.inc.php@{functions.inc.php}} +\subsubsection[dolibarr\_\-set\_\-const]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-set\_\-const (\$ {\em db}, \$ {\em name}, \$ {\em value}, \$ {\em type} = {\tt 'chaine'}, \$ {\em visible} = {\tt 0}, \$ {\em note} = {\tt ''})}} +\label{functions_8inc_8php_a3} + + +insertion d'une constantes dans la base de donn\'{e}es + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em db}]base de donn\'{e}es \item[{\em name}]nom de la constante \item[{\em value}]valeur de la constante \item[{\em type}]type de constante \item[{\em visible}]la constante est t'elle visible \item[{\em note}]explication de la constante \end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]type = chaine par d\'{e}faut + +visible = 0 par d\'{e}faut + +retourne 0 pour rat\'{e}, 1 pour r\'{e}ussi \end{Desc} + + +D\'{e}finition \`{a} la ligne 103 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a1}{ +\index{functions.inc.php@{functions.inc.php}!dolibarr_syslog@{dolibarr\_\-syslog}} +\index{dolibarr_syslog@{dolibarr\_\-syslog}!functions.inc.php@{functions.inc.php}} +\subsubsection[dolibarr\_\-syslog]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-syslog (\$ {\em message})}} +\label{functions_8inc_8php_a1} + + +envoi des messages dolibarr dans syslog + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em message}]message a envoyer a syslog \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 44 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a23}{ +\index{functions.inc.php@{functions.inc.php}!doliMoveFileUpload@{doliMoveFileUpload}} +\index{doliMoveFileUpload@{doliMoveFileUpload}!functions.inc.php@{functions.inc.php}} +\subsubsection[doliMoveFileUpload]{\setlength{\rightskip}{0pt plus 5cm}doli\-Move\-File\-Upload (\$ {\em src\_\-file}, \$ {\em dest\_\-file})}} +\label{functions_8inc_8php_a23} + + +deplacer les fichiers telecharg\'{e}s + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em src\_\-file}]fichier source \item[{\em dest\_\-file}]fichier de destination \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 377 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a39}{ +\index{functions.inc.php@{functions.inc.php}!francs@{francs}} +\index{francs@{francs}!functions.inc.php@{functions.inc.php}} +\subsubsection[francs]{\setlength{\rightskip}{0pt plus 5cm}francs (\$ {\em euros})}} +\label{functions_8inc_8php_a39} + + +fonction qui convertit des euros en francs + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em euros}]somme en euro \`{a} convertir \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]price \end{Desc} + + +D\'{e}finition \`{a} la ligne 1007 du fichier functions.inc.php. + +R\'{e}f\'{e}rences price().\hypertarget{functions_8inc_8php_a41}{ +\index{functions.inc.php@{functions.inc.php}!inctva@{inctva}} +\index{inctva@{inctva}!functions.inc.php@{functions.inc.php}} +\subsubsection[inctva]{\setlength{\rightskip}{0pt plus 5cm}inctva (\$ {\em euros}, \$ {\em taux} = {\tt 1.196})}} +\label{functions_8inc_8php_a41} + + +fonction qui calcule le montant tva incluse + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em euros}]somme en euro \item[{\em taux}]taux de tva \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 1031 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a46}{ +\index{functions.inc.php@{functions.inc.php}!initialiser_sel@{initialiser\_\-sel}} +\index{initialiser_sel@{initialiser\_\-sel}!functions.inc.php@{functions.inc.php}} +\subsubsection[initialiser\_\-sel]{\setlength{\rightskip}{0pt plus 5cm}initialiser\_\-sel ()}} +\label{functions_8inc_8php_a46} + + +fonction pour initialiser sel + +\begin{Desc} +\item[Remarques:]la fonction a \'{e}t\'{e} prise sur \href{http://www.uzine.net/spip}{\tt http://www.uzine.net/spip} \end{Desc} + + +D\'{e}finition \`{a} la ligne 1251 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a44}{ +\index{functions.inc.php@{functions.inc.php}!logfile@{logfile}} +\index{logfile@{logfile}!functions.inc.php@{functions.inc.php}} +\subsubsection[logfile]{\setlength{\rightskip}{0pt plus 5cm}logfile (\$ {\em str}, \$ {\em log} = {\tt \char`\"{}/var/log/dolibarr/dolibarr.log\char`\"{}})}} +\label{functions_8inc_8php_a44} + + +fonction qui permet d'envoyer les infos dans un fichier de log + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em str}]chaine a mettre dans le fichier \item[{\em log}]nom du fichier de log \end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]cette fonction ne marchera qui si la constante MAIN\_\-DEBUG = 1 \end{Desc} + + +D\'{e}finition \`{a} la ligne 1188 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a21}{ +\index{functions.inc.php@{functions.inc.php}!loginfunction@{loginfunction}} +\index{loginfunction@{loginfunction}!functions.inc.php@{functions.inc.php}} +\subsubsection[loginfunction]{\setlength{\rightskip}{0pt plus 5cm}loginfunction ()}} +\label{functions_8inc_8php_a21} + + +fonction de login + +\begin{Desc} +\item[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 ! \end{Desc} + + +D\'{e}finition \`{a} la ligne 281 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a38}{ +\index{functions.inc.php@{functions.inc.php}!price@{price}} +\index{price@{price}!functions.inc.php@{functions.inc.php}} +\subsubsection[price]{\setlength{\rightskip}{0pt plus 5cm}price (\$ {\em amount}, \$ {\em html} = {\tt 0})}} +\label{functions_8inc_8php_a38} + + +fonction qui retourne un montant mon\'{e}taire format\'{e} + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em amount}]montant a formater \item[{\em html}]formatage html ou pas \end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]html = 0 par d\'{e}faut + +fnction utilis\'{e}e dans les pdf et les pages html \end{Desc} + + +D\'{e}finition \`{a} la ligne 985 du fichier functions.inc.php. + +R\'{e}f\'{e}renc\'{e} par francs().\hypertarget{functions_8inc_8php_a35}{ +\index{functions.inc.php@{functions.inc.php}!print_date_select@{print\_\-date\_\-select}} +\index{print_date_select@{print\_\-date\_\-select}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-date\_\-select]{\setlength{\rightskip}{0pt plus 5cm}print\_\-date\_\-select (\$ {\em set\_\-time} = {\tt ''})}} +\label{functions_8inc_8php_a35} + + +fonction servant a afficher les mois dans un liste d\'{e}roulante + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em set\_\-time}]\end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]set\_\-time = '' par d\'{e}faut \end{Desc} + + +D\'{e}finition \`{a} la ligne 852 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a37}{ +\index{functions.inc.php@{functions.inc.php}!print_duree_select@{print\_\-duree\_\-select}} +\index{print_duree_select@{print\_\-duree\_\-select}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-duree\_\-select]{\setlength{\rightskip}{0pt plus 5cm}print\_\-duree\_\-select (\$ {\em prefix})}} +\label{functions_8inc_8php_a37} + + +fonction servant a afficher une dur\'{e}e dans une liste d\'{e}roulante + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em prefix}]\end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 957 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a29}{ +\index{functions.inc.php@{functions.inc.php}!print_fiche_titre@{print\_\-fiche\_\-titre}} +\index{print_fiche_titre@{print\_\-fiche\_\-titre}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-fiche\_\-titre]{\setlength{\rightskip}{0pt plus 5cm}print\_\-fiche\_\-titre (\$ {\em titre}, \$ {\em mesg} = {\tt ''})}} +\label{functions_8inc_8php_a29} + + +affichage d'un titre d'une fiche align\'{e} a droite + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em titre}]le titre a afficher \item[{\em mesg}]message afficher \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 719 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a33}{ +\index{functions.inc.php@{functions.inc.php}!print_fleche_navigation@{print\_\-fleche\_\-navigation}} +\index{print_fleche_navigation@{print\_\-fleche\_\-navigation}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-fleche\_\-navigation]{\setlength{\rightskip}{0pt plus 5cm}print\_\-fleche\_\-navigation (\$ {\em page}, \$ {\em file}, \$ {\em options} = {\tt ''}, \$ {\em nextpage})}} +\label{functions_8inc_8php_a33} + + +fonction servant a afficher les fleches de navigation dans les pages de listes + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em page}]num\'{e}ro de la page \item[{\em file}]lien \item[{\em options}]\item[{\em nextpage}]page suivante \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 812 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a36}{ +\index{functions.inc.php@{functions.inc.php}!print_heure_select@{print\_\-heure\_\-select}} +\index{print_heure_select@{print\_\-heure\_\-select}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-heure\_\-select]{\setlength{\rightskip}{0pt plus 5cm}print\_\-heure\_\-select (\$ {\em prefix}, \$ {\em begin} = {\tt 1}, \$ {\em end} = {\tt 23})}} +\label{functions_8inc_8php_a36} + + +fonction servant a afficher les heures/minutes dans un liste d\'{e}roulante + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em prefix}]\item[{\em begin}]\item[{\em end}]\end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]begin = 1 par d\'{e}faut + +end = 23 par d\'{e}faut \end{Desc} + + +D\'{e}finition \`{a} la ligne 935 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a26}{ +\index{functions.inc.php@{functions.inc.php}!print_liste_field_titre@{print\_\-liste\_\-field\_\-titre}} +\index{print_liste_field_titre@{print\_\-liste\_\-field\_\-titre}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-liste\_\-field\_\-titre]{\setlength{\rightskip}{0pt plus 5cm}print\_\-liste\_\-field\_\-titre (\$ {\em name}, \$ {\em file}, \$ {\em field}, \$ {\em begin} = {\tt \char`\"{}\char`\"{}}, \$ {\em options} = {\tt \char`\"{}\char`\"{}})}} +\label{functions_8inc_8php_a26} + + +affichage du titre d'une liste + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em name}]\item[{\em file}]\item[{\em field}]\item[{\em begin}]\item[{\em options}]\end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]begin = \char`\"{}\char`\"{} par d\'{e}faut + +options = \char`\"{}\char`\"{} par d\'{e}faut \end{Desc} + + +D\'{e}finition \`{a} la ligne 658 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a27}{ +\index{functions.inc.php@{functions.inc.php}!print_liste_field_titre_new@{print\_\-liste\_\-field\_\-titre\_\-new}} +\index{print_liste_field_titre_new@{print\_\-liste\_\-field\_\-titre\_\-new}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-liste\_\-field\_\-titre\_\-new]{\setlength{\rightskip}{0pt plus 5cm}print\_\-liste\_\-field\_\-titre\_\-new (\$ {\em name}, \$ {\em file}, \$ {\em field}, \$ {\em begin} = {\tt \char`\"{}\char`\"{}}, \$ {\em options} = {\tt \char`\"{}\char`\"{}}, \$ {\em td} = {\tt \char`\"{}\char`\"{}}, \$ {\em sortfield} = {\tt \char`\"{}\char`\"{}})}} +\label{functions_8inc_8php_a27} + + +affichage du titre d'une liste avec possibilit\'{e} de tri et de choix du type de la balise td + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em name}]\item[{\em file}]\item[{\em field}]\item[{\em begin}]\item[{\em options}]\item[{\em td}]\item[{\em sortfield}]\end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]begin = \char`\"{}\char`\"{} par d\'{e}faut + +options = \char`\"{}\char`\"{} par d\'{e}faut + +td = \char`\"{}\char`\"{} par d\'{e}faut + +sortfield = \char`\"{}\char`\"{} par d\'{e}faut \end{Desc} + + +D\'{e}finition \`{a} la ligne 684 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a34}{ +\index{functions.inc.php@{functions.inc.php}!print_oui_non@{print\_\-oui\_\-non}} +\index{print_oui_non@{print\_\-oui\_\-non}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-oui\_\-non]{\setlength{\rightskip}{0pt plus 5cm}print\_\-oui\_\-non (\$ {\em value})}} +\label{functions_8inc_8php_a34} + + +fonction servant a afficher un menu d\'{e}roulant avec oui ou non + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em value}]\end{description} +\end{Desc} +\begin{Desc} +\item[Remarques:]value peut avoir la valeur 0 ou 1 \end{Desc} + + +D\'{e}finition \`{a} la ligne 832 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a28}{ +\index{functions.inc.php@{functions.inc.php}!print_titre@{print\_\-titre}} +\index{print_titre@{print\_\-titre}!functions.inc.php@{functions.inc.php}} +\subsubsection[print\_\-titre]{\setlength{\rightskip}{0pt plus 5cm}print\_\-titre (\$ {\em titre})}} +\label{functions_8inc_8php_a28} + + +affichage d'un titre + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em titre}]le titre a afficher \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 708 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a42}{ +\index{functions.inc.php@{functions.inc.php}!stat_print@{stat\_\-print}} +\index{stat_print@{stat\_\-print}!functions.inc.php@{functions.inc.php}} +\subsubsection[stat\_\-print]{\setlength{\rightskip}{0pt plus 5cm}stat\_\-print (\$ {\em basename}, \$ {\em bc1}, \$ {\em bc2}, \$ {\em ftc}, \$ {\em jour})}} +\label{functions_8inc_8php_a42} + + +fonction qui affiche des statistiques + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em basename}]\item[{\em bc1}]\item[{\em bc2}]\item[{\em ftc}]\item[{\em jour}]\end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 1046 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a25}{ +\index{functions.inc.php@{functions.inc.php}!transcoS2L@{transcoS2L}} +\index{transcoS2L@{transcoS2L}!functions.inc.php@{functions.inc.php}} +\subsubsection[transcoS2L]{\setlength{\rightskip}{0pt plus 5cm}transco\-S2L (\$ {\em zonein}, \$ {\em devise})}} +\label{functions_8inc_8php_a25} + + +transcodage de francs en euros + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em zonein}]zone de depart \item[{\em devise}]type de devise \end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]r \end{Desc} + + +D\'{e}finition \`{a} la ligne 451 du fichier functions.inc.php.\hypertarget{functions_8inc_8php_a40}{ +\index{functions.inc.php@{functions.inc.php}!tva@{tva}} +\index{tva@{tva}!functions.inc.php@{functions.inc.php}} +\subsubsection[tva]{\setlength{\rightskip}{0pt plus 5cm}tva (\$ {\em euros}, \$ {\em taux} = {\tt 19.6})}} +\label{functions_8inc_8php_a40} + + +fonction qui calcule la tva + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em euros}]somme en euro \item[{\em taux}]taux de tva \end{description} +\end{Desc} + + +D\'{e}finition \`{a} la ligne 1018 du fichier functions.inc.php. + +R\'{e}f\'{e}renc\'{e} par calcul\_\-price(). \ No newline at end of file diff --git a/doc/dev/php/latex/ldap_8lib_8php.aux b/doc/dev/php/latex/ldap_8lib_8php.aux new file mode 100644 index 00000000000..5112e606ad5 --- /dev/null +++ b/doc/dev/php/latex/ldap_8lib_8php.aux @@ -0,0 +1,40 @@ +\relax +\@writefile{toc}{\contentsline {section}{\numberline {4.3}R\'{e}f\'{e}rence du fichier htdocs/lib/ldap.lib.php}{30}{section.4.3}} +\newlabel{ldap_8lib_8php}{{4.3}{30}{R\'{e}f\'{e}rence du fichier htdocs/lib/ldap.lib.php\relax }{section.4.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {4.3.1}Description d\'{e}taill\'{e}e}{30}{subsection.4.3.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {4.3.2}Documentation des fonctions}{30}{subsection.4.3.2}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.2.1}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}bind}{30}{subsubsection.4.3.2.1}} +\newlabel{ldap_8lib_8php_a1}{{4.3.2.1}{30}{dolibarr\_\-ldap\_\-bind\relax }{subsubsection.4.3.2.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.2.2}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}connect}{31}{subsubsection.4.3.2.2}} +\newlabel{ldap_8lib_8php_a0}{{4.3.2.2}{31}{dolibarr\_\-ldap\_\-connect\relax }{subsubsection.4.3.2.2}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.2.3}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}getversion}{31}{subsubsection.4.3.2.3}} +\newlabel{ldap_8lib_8php_a3}{{4.3.2.3}{31}{dolibarr\_\-ldap\_\-getversion\relax }{subsubsection.4.3.2.3}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.2.4}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}setversion}{31}{subsubsection.4.3.2.4}} +\newlabel{ldap_8lib_8php_a4}{{4.3.2.4}{31}{dolibarr\_\-ldap\_\-setversion\relax }{subsubsection.4.3.2.4}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.2.5}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unacc}{31}{subsubsection.4.3.2.5}} +\newlabel{ldap_8lib_8php_a5}{{4.3.2.5}{31}{dolibarr\_\-ldap\_\-unacc\relax }{subsubsection.4.3.2.5}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {4.3.2.6}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unbind}{32}{subsubsection.4.3.2.6}} +\newlabel{ldap_8lib_8php_a2}{{4.3.2.6}{32}{dolibarr\_\-ldap\_\-unbind\relax }{subsubsection.4.3.2.6}{}} +\@setckpt{ldap_8lib_8php}{ +\setcounter{page}{33} +\setcounter{equation}{0} +\setcounter{enumi}{0} +\setcounter{enumii}{0} +\setcounter{enumiii}{0} +\setcounter{enumiv}{0} +\setcounter{footnote}{0} +\setcounter{mpfootnote}{0} +\setcounter{part}{0} +\setcounter{chapter}{4} +\setcounter{section}{3} +\setcounter{subsection}{2} +\setcounter{subsubsection}{6} +\setcounter{paragraph}{0} +\setcounter{subparagraph}{0} +\setcounter{figure}{0} +\setcounter{table}{0} +\setcounter{float@type}{4} +\setcounter{Item}{0} +\setcounter{Hfootnote}{0} +\setcounter{section@level}{3} +}