Wavyzz/dolibarr-fork
2
0
Fork 0
forked from Wavyzz/dolibarr
Code Pull Requests Activity

Doc: Mise jour doc doxygen

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

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

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

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