2
0
forked from Wavyzz/dolibarr

Doc: Mise jour doc doxygen

This commit is contained in:
Laurent Destailleur
2004-10-23 17:27:57 +00:00
parent ceb9a3345c
commit b60115c0d9
2 changed files with 105 additions and 99 deletions

View File

@@ -1119,7 +1119,7 @@ function print_type_paiement_select($db,$nomselect,$value=-1)
$num = $db->num_rows();
while ($i < $num)
{
$obj = $db->fetch_object( $i);
$obj = $db->fetch_object();
print "<option value=\"$obj->code\">$obj->libelle</option>";
$i++;
}
@@ -1423,7 +1423,7 @@ function departement_rowid($db,$code, $pays_id)
$num = $db->num_rows();
if ($num)
{
$obj = $db->fetch_object(0);
$obj = $db->fetch_object();
return $obj->rowid;
}
else

View File

@@ -22,7 +22,7 @@
*
*/
/*! \file htdocs/lib/mysql.lib.php
/*! \file htdocs/lib/mysql.lib.php
\brief Classe permettant de g<>r<EFBFBD>r la database de dolibarr.
\author Fabien Seisen
\author Rodolphe Quiedeville.
@@ -32,7 +32,7 @@
Ensemble des fonctions permettant de g<>rer la database de dolibarr.
*/
/*! \class DoliDb
/*! \class DoliDb
\brief Classe permettant de g<>r<EFBFBD>r la database de dolibarr
Ensemble des fonctions permettant de g<>rer la database de dolibarr
@@ -46,12 +46,12 @@ class DoliDb {
var $ERROR_TABLEEXISTS=1050;
/*!
\brief ouverture d'une connection vers le serveur et/ou une database.
\param type type de base de donn<6E>es (mysql ou pgsql)
\param host addresse de la base de donn<6E>es
\param user nom de l'utilisateur autoris<69>
\param pass mot de passe
\param name nom de la database
\brief Ouverture d'une connection vers le serveur et/ou une database.
\param type type de base de donn<6E>es (mysql ou pgsql)
\param host addresse de la base de donn<6E>es
\param user nom de l'utilisateur autoris<69>
\param pass mot de passe
\param name nom de la database
*/
function DoliDb($type = 'mysql', $host = '', $user = '', $pass = '', $name = '')
@@ -128,9 +128,9 @@ class DoliDb {
}
/*!
\brief selectionne une database.
\param database nom de la database
\return resource
\brief Selectionne une database.
\param database nom de la database
\return resource
*/
function select_db($database)
@@ -139,11 +139,11 @@ class DoliDb {
}
/*!
\brief connection vers une database.
\param host addresse de la base de donn<6E>es
\param login nom de l'utilisateur autoris<69>
\param passwd mot de passe
\return resource
\brief Connection vers le serveur
\param host addresse de la base de donn<6E>es
\param login nom de l'utilisateur autoris<69>
\param passwd mot de passe
\return resource
*/
function connect($host, $login, $passwd)
@@ -154,9 +154,9 @@ class DoliDb {
}
/*!
\brief cr<EFBFBD>ation d'une database.
\param database nom de la database
\return result resultat 1 pour ok, 0 pour non ok
\brief Connexion sur une base de donn<6E>e
\param database nom de la database
\return result resultat 1 pour ok, 0 pour non ok
*/
function create_db($database)
@@ -172,8 +172,8 @@ class DoliDb {
}
/*!
\brief copie d'une database.
\return resource
\brief Copie d'une database.
\return resource
*/
function clone()
@@ -184,11 +184,11 @@ class DoliDb {
}
/*!
\brief ouverture d'une connection vers une database.
\param host addresse de la base de donn<6E>es
\param login nom de l'utilisateur autoris<69>
\param passwd mot de passe
\return resource
\brief Ouverture d'une connection vers une database.
\param host addresse de la base de donn<6E>es
\param login nom de l'utilisateur autoris<69>
\param passwd mot de passe
\return resource
*/
function pconnect($host, $login, $passwd)
@@ -198,8 +198,8 @@ class DoliDb {
}
/*!
\brief fermeture d'une connection vers une database.
\return resource
\brief Fermeture d'une connection vers une database.
\return resource
*/
function close()
@@ -208,9 +208,9 @@ class DoliDb {
}
/*!
\brief debut d'une transaction.
\param do
\return string
\brief Debut d'une transaction.
\param do
\return string
*/
function begin($do=1)
@@ -226,9 +226,9 @@ class DoliDb {
}
/*!
\brief <EFBFBD>criture d'une transaction.
\param do
\return string
\brief Ecriture d'une transaction.
\param do
\return string
*/
function commit($do=1)
@@ -244,9 +244,9 @@ class DoliDb {
}
/*!
\brief <EFBFBD>ffacement d'une transaction et retour au ancienne valeurs.
\param do
\return string
\brief Effacement d'une transaction et retour au ancienne valeurs.
\param do
\return string
*/
function rollback($do=1)
@@ -262,11 +262,11 @@ class DoliDb {
}
/*!
\brief requete vers une database.
\param query contenu de la query
\param limit
\param offset
\return resource
\brief Effectue une requete et renvoi le resultset de r<>ponse de la base
\param query contenu de la query
\param limit
\param offset
\return resource resultset
*/
function query($query, $limit="", $offset="")
@@ -280,9 +280,9 @@ class DoliDb {
}
/*!
\brief liste des tables dans une database.
\param database nom de la database
\return resource
\brief Liste des tables dans une database.
\param database nom de la database
\return resource
*/
function list_tables($database)
@@ -292,10 +292,10 @@ class DoliDb {
}
/*!
\brief renvoie les donn<6E>es de la requete.
\param nb contenu de la query
\param fieldname nom du champ
\return resource
\brief Renvoie les donn<6E>es de la requete.
\param nb contenu de la query
\param fieldname nom du champ
\return resource
*/
function result($nb, $fieldname)
@@ -304,8 +304,8 @@ class DoliDb {
}
/*!
\brief d<EFBFBD>salloue la memoire de la requete.
\return resource
\brief Lib<69>re le dernier resultset utilis<69> sur cette connexion.
\return resource
*/
function free()
@@ -314,41 +314,41 @@ class DoliDb {
}
/*!
\brief Renvoie la ligne courante (comme un objet) pour le curseur statement.
\param statement curseur de la requete voulue
\return resource
\brief Renvoie la ligne courante (comme un objet) pour le curseur resultset.
\param resultset curseur de la requete voulue
\return resource
*/
function fetch_object($statement=0)
function fetch_object($resultset=0)
{
// Si statement n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($statement)) { $statement=$this->results; }
return mysql_fetch_object($statement);
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $statement=$this->results; }
return mysql_fetch_object($resultset);
}
/*!
\brief d<>fini les limites de la requ<71>te.
\param limit
\param offset
\return limit
\brief d<EFBFBD>fini les limites de la requ<71>te.
\param limit
\param offset
\return limit
*/
function plimit($limit=0,$offset=0)
{
if ($offset > 0)
{
return " LIMIT $offset,$limit ";
}
else
{
return " LIMIT $limit ";
}
if ($offset > 0)
{
return " LIMIT $offset,$limit ";
}
else
{
return " LIMIT $limit ";
}
}
/*!
\brief formatage de la date en format unix.
\param fname
\return date
\brief formatage de la date en format unix.
\param fname
\return date
*/
function pdate($fname)
@@ -357,9 +357,9 @@ class DoliDb {
}
/*!
\brief formatage de la date en fonction des locales.
\param fname
\return date
\brief formatage de la date en fonction des locales.
\param fname
\return date
*/
function idate($fname)
@@ -368,8 +368,8 @@ class DoliDb {
}
/*!
\brief renvoie les donn<6E>es dans un tableau.
\return array
\brief Renvoie les donn<6E>es dans un tableau.
\return array
*/
function fetch_array()
@@ -378,8 +378,8 @@ class DoliDb {
}
/*!
\brief renvoie les donn<6E>es comme un tableau.
\return array
\brief Renvoie les donn<6E>es comme un tableau.
\return array
*/
function fetch_row()
@@ -388,7 +388,8 @@ class DoliDb {
}
/*!
\brief obtient les donn<6E>es d'un colonne et renvoie les donn<6E>es sous forme d'objet.
\brief Obtient les donn<6E>es d'un colonne et renvoie les donn<6E>es sous forme d'objet.
\return array
*/
function fetch_field()
@@ -398,8 +399,8 @@ class DoliDb {
/*!
\brief renvoie le nombre de lignes dans le resultat de la requete.
\return int
\brief Renvoie le nombre de lignes dans le resultat de la requete.
\return int
*/
function num_rows()
@@ -408,8 +409,8 @@ class DoliDb {
}
/*!
\brief renvoie le nombre de champs dans le resultat de la requete.
\return int
\brief Renvoie le nombre de champs dans le resultat de la requete.
\return int
*/
function num_fields()
@@ -418,8 +419,8 @@ class DoliDb {
}
/*!
\brief renvoie la derniere requete soumise par la methode query()
\return error_text
\brief renvoie la derniere requete soumise par la methode query()
\return lastquery
*/
function lastquery()
@@ -428,8 +429,8 @@ class DoliDb {
}
/*!
\brief renvoie le texte de l'erreur mysql de l'operation precedente.
\return error_text
\brief renvoie le texte de l'erreur mysql de l'operation precedente.
\return error_text
*/
function error()
@@ -438,8 +439,8 @@ class DoliDb {
}
/*!
\brief renvoie la valeur numerique de l'erreur mysql de l'operation precedente.
\return error_num
\brief renvoie la valeur numerique de l'erreur mysql de l'operation precedente.
\return error_num
*/
function errno()
@@ -451,8 +452,8 @@ class DoliDb {
}
/*!
\brief obtient l'id gen<65>r<EFBFBD> par le pr<70>cedent INSERT.
\return id
\brief Obtient l'id gen<65>r<EFBFBD> par le pr<70>cedent INSERT.
\return id
*/
function last_insert_id()
@@ -461,8 +462,8 @@ class DoliDb {
}
/*!
\brief obtient le nombre de lignes affect<63>es dans la pr<70>c<EFBFBD>dente op<6F>ration.
\return rows
\brief Obtient le nombre de lignes affect<63>es dans la pr<70>c<EFBFBD>dente op<6F>ration.
\return rows
*/
function affected_rows()
@@ -471,7 +472,12 @@ class DoliDb {
}
function getdsn($db_type,$db_user,$db_pass,$db_host,$dbname)
/*!
\brief Retourne le dsn
\return dsn
*/
function getdsn($db_type,$db_user,$db_pass,$db_host,$dbname)
{
$pear = $db_type.'://'.$db_user.':'.$db_pass.'@'.
$db_host.'/'.$db_name;