2
0
forked from Wavyzz/dolibarr

Amlioration des gestionnaires de bases: Meilleur commentaire et les fonctions qui ncessitent un resultset peuvent le recevoir en paramtre.

This commit is contained in:
Laurent Destailleur
2005-01-23 01:47:51 +00:00
parent 644e0c7039
commit 830137f270
2 changed files with 857 additions and 838 deletions

View File

@@ -1,7 +1,7 @@
<?php
/* Copyright (C) 2001 Fabien Seisen <seisen@linuxfr.org>
* Copyright (C) 2002-2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2004-2005 Laurent Destailleur <eldy@users.sourceforge.net>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -23,29 +23,34 @@
*/
/** \file htdocs/lib/mysql.lib.php
\brief Classe permettant de g<>r<EFBFBD>r la database de dolibarr.
\brief Fichier de la classe permettant de g<>r<EFBFBD>r la database de dolibarr.
\author Fabien Seisen
\author Rodolphe Quiedeville.
\author Laurent Destailleur.
\version $Revision$
Ensemble des fonctions permettant de g<>rer la database de dolibarr.
*/
/** \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
*/
class DoliDb
{
var $db, $results, $ok, $connected, $database_selected;
var $db; // Handler de base
var $results; // Resultset de la derni<6E>re requete
var $connected; // 1 si connect<63>, 0 sinon
var $database_selected; // 1 si base s<>lectionn<6E>, 0 sinon
var $transaction_opened; // 1 si une transaction est en cours, 0 sinon
var $ok;
// Constantes pour code erreurs
var $ERROR_DUPLICATE=1062;
var $ERROR_TABLEEXISTS=1050;
/**
\brief Ouverture d'une connection vers le serveur et <20>ventuellement une database.
\param type type de base de donn<6E>es (mysql ou pgsql)
@@ -55,30 +60,15 @@ class DoliDb
\param name nom de la database
\return int 1 en cas de succ<63>s, 0 sinon
*/
function DoliDb($type = 'mysql', $host = '', $user = '', $pass = '', $name = '')
{
global $conf;
$this->transaction_opened=0;
if ($host == '')
{
$host = $conf->db->host;
}
if ($user == '')
{
$user = $conf->db->user;
}
if ($pass == '')
{
$pass = $conf->db->pass;
}
if ($name == '')
{
$name = $conf->db->name;
}
if ($host == '') $host = $conf->db->host;
if ($user == '') $user = $conf->db->user;
if ($pass == '') $pass = $conf->db->pass;
if ($name == '') $name = $conf->db->name;
//print "Name DB: $host,$user,$pass,$name<br>";
@@ -135,7 +125,7 @@ class DoliDb
/**
\brief Connection vers le serveur
\param host addresse de la base de donn<6E>es
\param login nom de l'utilisateur autoris<EFBFBD>
\param login nom de l'utilisateur autoris
\param passwd mot de passe
\return resource handler d'acc<63>s <20> la base
*/
@@ -166,7 +156,7 @@ class DoliDb
}
/**
\brief Copie d'une database.
\brief Copie d'un handler de database.
\return resource
*/
@@ -179,9 +169,9 @@ 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
\param host Adresse de la base de donn<6E>es
\param login Nom de l'utilisateur autoris<69>
\param passwd Mot de passe
\return resource handler d'acc<63>s <20> la base
*/
@@ -201,53 +191,59 @@ class DoliDb
return mysql_close($this->db);
}
/**
\brief Debut d'une transaction.
\param do
\return string
\return int 1 si ouverture transaction ok ou deja ouverte, 0 en cas d'erreur
*/
function begin($do=1)
function begin()
{
if ($do)
if (! $this->transaction_opened)
{
return $this->query("BEGIN");
$ret=$this->query("BEGIN");
if ($ret) $this->transaction_opened++;
return $ret;
}
else
{
$this->transaction_opened++;
return 1;
}
}
/**
\brief Ecriture d'une transaction.
\param do
\return string
\brief Validation d'une transaction
\return int 1 si validation ok ou niveau de transaction non ouverte, 0 en cas d'erreur
*/
function commit($do=1)
function commit()
{
if ($do)
if ($this->transaction_opened==1)
{
return $this->query("COMMIT");
$ret=$this->query("COMMIT");
if ($ret) $this->transaction_opened=0;
return $ret;
}
else
{
$this->transaction_opened--;
return 1;
}
}
/**
\brief Effacement d'une transaction et retour au ancienne valeurs.
\param do
\return string
\brief Annulation d'une transaction et retour aux anciennes valeurs
\return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur
*/
function rollback($do=1)
function rollback()
{
if ($do)
if ($this->transaction_opened)
{
return $this->query("ROLLBACK");
$ret=$this->query("ROLLBACK");
$this->transaction_opened=0;
return $ret;
}
else
{
@@ -257,13 +253,11 @@ class DoliDb
/**
\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
\param query Contenu de la query
\return resource Resultset de la reponse
*/
function query($query, $limit="", $offset="")
function query($query)
{
$query = trim($query);
$this->lastquery=$query;
@@ -273,22 +267,10 @@ class DoliDb
return $this->results;
}
/**
\brief Liste des tables dans une database.
\param database nom de la database
\return resource
*/
function list_tables($database)
{
$this->results = mysql_list_tables($database, $this->db);
return $this->results;
}
/**
\brief Renvoie les donn<6E>es de la requete.
\param nb contenu de la query
\param fieldname nom du champ
\param nb Contenu de la query
\param fieldname Nom du champ
\return resource
*/
@@ -297,19 +279,9 @@ class DoliDb
return mysql_result($this->results, $nb, $fieldname);
}
/**
\brief Lib<69>re le dernier resultset utilis<69> sur cette connexion.
\return resource
*/
function free()
{
return mysql_free_result($this->results);
}
/**
\brief Renvoie la ligne courante (comme un objet) pour le curseur resultset.
\param resultset curseur de la requete voulue
\param resultset Curseur de la requete voulue
\return resource
*/
@@ -321,10 +293,106 @@ class DoliDb
}
/**
\brief d<EFBFBD>fini les limites de la requ<71>te.
\brief Renvoie les donn<6E>es dans un tableau.
\param resultset Curseur de la requete voulue
\return array
*/
function fetch_array($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return mysql_fetch_array($resultset);
}
/**
\brief Renvoie les donn<6E>es comme un tableau.
\param resultset Curseur de la requete voulue
\return array
*/
function fetch_row($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return mysql_fetch_row($resultset);
}
/**
\brief Obtient les donn<6E>es d'un colonne et renvoie les donn<6E>es sous forme d'objet.
\param resultset Curseur de la requete voulue
\return array
*/
function fetch_field($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return mysql_fetch_field($resultset);
}
/**
\brief Renvoie le nombre de lignes dans le resultat d'une requete SELECT
\see affected_rows
\param resultset Curseur de la requete voulue
\return int Nombre de lignes
*/
function num_rows($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return mysql_num_rows($resultset);
}
/**
\brief Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE
\see num_rows
\param resultset Curseur de la requete voulue
\return int Nombre de lignes
*/
function affected_rows($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
// mysql necessite un link de base pour cette fonction contrairement
// a pqsql qui prend un resultset
return mysql_affected_rows($this->db);
}
/**
\brief Renvoie le nombre de champs dans le resultat de la requete.
\param resultset Curseur de la requete voulue
\return int
*/
function num_fields($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return mysql_num_fields($resultset);
}
/**
\brief Lib<69>re le dernier resultset utilis<69> sur cette connexion.
\param resultset Curseur de la requete voulue
\return resource
*/
function free($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return mysql_free_result($resultset);
}
/**
\brief D<>fini les limites de la requ<71>te.
\param limit
\param offset
\return int limite
\return int Limite
*/
function plimit($limit=0,$offset=0)
@@ -361,75 +429,6 @@ class DoliDb
return strftime("%Y%m%d%H%M%S",$fname);
}
/**
\brief Renvoie les donn<6E>es dans un tableau.
\return array
*/
function fetch_array()
{
return mysql_fetch_array($this->results);
}
/**
\brief Renvoie les donn<6E>es comme un tableau.
\return array
*/
function fetch_row()
{
return mysql_fetch_row($this->results);
}
/**
\brief Obtient les donn<6E>es d'un colonne et renvoie les donn<6E>es sous forme d'objet.
\return array
*/
function fetch_field()
{
return mysql_fetch_field($this->results);
}
/**
\brief Renvoie le nombre de lignes dans le
resultat d'une requete SELECT
\see affected_rows
\return int nombre de lignes
*/
function num_rows()
{
return mysql_num_rows($this->results);
}
/**
\brief Renvoie le nombre de lignes dans le
resultat d'une requete INSERT, DELETE ou UPDATE
\see num_rows
\return int nombre de lignes
*/
function affected_rows()
{
// mysql necessite un link de base pour cette fonction contrairement
// a pqsql qui prend un resultset
return mysql_affected_rows($this->db);
}
/**
\brief Renvoie le nombre de champs dans le resultat de la requete.
\return int
*/
function num_fields()
{
return mysql_num_fields($this->results);
}
/**
\brief Renvoie la derniere requete soumise par la methode query()
\return lastquery
@@ -461,12 +460,11 @@ class DoliDb
{
// $ERROR_DUPLICATE=1062;
// $ERROR_TABLEEXISTS=1050;
return mysql_errno($this->db);
}
/**
\brief Obtient l'id gen<65>r<EFBFBD> par le pr<EFBFBD>cedent INSERT.
\brief Obtient l'id gen<65>r<EFBFBD> par le dernier INSERT.
\return id
*/
@@ -488,6 +486,18 @@ class DoliDb
return $pear;
}
/**
\brief Liste des tables dans une database.
\param database Nom de la database
\return resource
*/
function list_tables($database)
{
$this->results = mysql_list_tables($database, $this->db);
return $this->results;
}
}
?>

View File

@@ -25,26 +25,29 @@
*/
/** \file htdocs/lib/pgsql.lib.php
\brief Classe permettant de g<>r<EFBFBD>r la database de dolibarr.
\brief Fichier de la classe permettant de g<>r<EFBFBD>r la database de dolibarr.
\author Fabien Seisen
\author Rodolphe Quiedeville.
\author Laurent Destailleur.
\author S<>bastien Di Cintio
\author Benoit Mortier
\version $Revision$
Ensemble des fonctions permettant de g<>rer la database de dolibarr.
*/
/** \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
*/
class DoliDb
{
var $db, $results, $ok, $connected, $database_selected;
var $db; // Handler de base
var $results; // Resultset de la derni<6E>re requete
var $connected; // 1 si connect<63>, 0 sinon
var $database_selected; // 1 si base s<>lectionn<6E>, 0 sinon
var $transaction_opened; // 1 si une transaction est en cours, 0 sinon
var $ok;
// Constantes pour code erreurs
var $ERROR_DUPLICATE="23505";
@@ -59,30 +62,15 @@ class DoliDb
\param name nom de la database
\return int 1 en cas de succ<63>s, 0 sinon
*/
function DoliDb($type = 'pgsql', $host = '', $user = '', $pass = '', $name = '')
{
global $conf;
$this->transaction_opened=0;
if ($host == '')
{
$host = $conf->db->host;
}
if ($user == '')
{
$user = $conf->db->user;
}
if ($pass == '')
{
$pass = $conf->db->pass;
}
if ($name == '')
{
$name = $conf->db->name;
}
if ($host == '') $host = $conf->db->host;
if ($user == '') $user = $conf->db->user;
if ($pass == '') $pass = $conf->db->pass;
if ($name == '') $name = $conf->db->name;
//print "Name DB: $host,$user,$pass,$name<br>";
@@ -145,7 +133,7 @@ class DoliDb
/**
\brief Connection vers le serveur
\param host addresse de la base de donn<6E>es
\param login nom de l'utilisateur autoris<EFBFBD>
\param login nom de l'utilisateur autoris
\param passwd mot de passe
\param name nom de la database
\return resource handler d'acc<63>s <20> la base
@@ -167,14 +155,18 @@ class DoliDb
function create_db($database)
{
if(createdb($database, $this->db))
{
return 1;
}
else
{
return 0;
}
}
/**
\brief Copie d'une database.
\brief Copie d'un handler de database.
\return resource
*/
@@ -187,10 +179,10 @@ 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
\param name nom de la database
\param host Adresse de la base de donn<6E>es
\param login Nom de l'utilisateur autoris<69>
\param passwd Mot de passe
\param name Nom de la database
\return resource handler d'acc<63>s <20> la base
*/
@@ -213,52 +205,56 @@ class DoliDb
/**
\brief Debut d'une transaction.
\param do
\return string
\return int 1 si ouverture transaction ok ou deja ouverte, 0 en cas d'erreur
*/
function begin($do=1)
function begin()
{
if ($do)
if (! $this->transaction_opened)
{
return $this->query("BEGIN");
$ret=$this->query("BEGIN;");
if ($ret) $this->transaction_opened++;
return $ret;
}
else
{
$this->transaction_opened++;
return 1;
}
}
/**
\brief Ecriture d'une transaction.
\param do
\return string
\brief Validation d'une transaction
\return int 1 si validation ok ou niveau de transaction non ouverte, 0 en cas d'erreur
*/
function commit($do=1)
function commit()
{
if ($do)
if ($this->transaction_opened==1)
{
return $this->query("COMMIT;");
$ret=$this->query("COMMIT;");
if ($ret) $this->transaction_opened=0;
return $ret;
}
else
{
$this->transaction_opened--;
return 1;
}
}
/**
\brief Effacement d'une transaction et retour au ancienne valeurs.
\param do
\return string
\brief Annulation d'une transaction et retour aux anciennes valeurs
\return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur
*/
function rollback($do=1)
function rollback()
{
if ($do)
if ($this->transaction_opened)
{
return $this->query("ROLLBACK;");
$ret=$this->query("ROLLBACK;");
$this->transaction_opened=0;
return $ret;
}
else
{
@@ -268,16 +264,13 @@ class DoliDb
/**
\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
\param query Contenu de la query
\return resource Resultset de la reponse
*/
function query($query, $limit="", $offset="")
function query($query)
{
$query = trim($query);
$this->lastquery=$query;
$this->results = pg_query($this->db, $query);
@@ -285,23 +278,10 @@ class DoliDb
return $this->results;
}
/**
\brief Liste des tables dans une database.
\param database nom de la database
\return resource
*/
function list_tables($database)
{
$this->results = pg_query($this->db, "SHOW TABLES;");
return $this->results;
}
/**
\brief Renvoie les donn<6E>es de la requete.
\param nb contenu de la query
\param fieldname nom du champ
\param nb Contenu de la query
\param fieldname Nom du champ
\return resource
*/
@@ -310,20 +290,9 @@ class DoliDb
return pg_fetch_result($this->results, $nb, $fieldname);
}
/**
\brief Lib<69>re le dernier resultset utilis<69> sur cette connexion.
\return resource
*/
function free()
{
return pg_free_result($this->results);
}
/**
\brief Renvoie la ligne courante (comme un objet) pour le curseur resultset.
\param resultset curseur de la requete voulue
\param resultset Curseur de la requete voulue
\return resource
*/
@@ -335,10 +304,107 @@ class DoliDb
}
/**
\brief d<>fini les limites de la requ<71>te.
\brief Renvoie les donn<6E>es dans un tableau.
\param resultset Curseur de la requete voulue
\return array
*/
function fetch_array($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return pg_fetch_array($resultset);
}
/**
\brief Renvoie les donn<6E>es comme un tableau.
\param resultset Curseur de la requete voulue
\return array
*/
function fetch_row($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return pg_fetch_row($resultset);
}
/**
\brief Obtient les donn<6E>es d'un colonne et renvoie les donn<6E>es sous forme d'objet.
\param resultset Curseur de la requete voulue
\return array
*/
function fetch_field($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return pg_field_name($resultset);
}
/**
\brief Renvoie le nombre de lignes dans le resultat d'une requete SELECT
\see affected_rows
\param resultset Curseur de la requete voulue
\return int Nombre de lignes
*/
function num_rows($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return pg_num_rows($resultset);
}
/**
\brief Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE
\see num_rows
\param resultset Curseur de la requete voulue
\return int Nombre de lignes
*/
function affected_rows($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
// pgsql necessite un resultset pour cette fonction contrairement
// a mysql qui prend un link de base
return pg_affected_rows($resultset);
}
/**
\brief Renvoie le nombre de champs dans le resultat de la requete.
\param resultset Curseur de la requete voulue
\return int
*/
function num_fields($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return pg_num_fields($resultset);
}
/**
\brief Lib<69>re le dernier resultset utilis<69> sur cette connexion.
\param resultset Curseur de la requete voulue
\return resource
*/
function free($resultset=0)
{
// Si le resultset n'est pas fourni, on prend le dernier utilis<69> sur cette connexion
if (! is_resource($resultset)) { $resultset=$this->results; }
return pg_free_result($resultset);
}
/**
\brief D<>fini les limites de la requ<71>te.
\param limit
\param offset
\return int limite
\return int Limite
*/
function plimit($limit=0,$offset=0)
@@ -365,9 +431,8 @@ class DoliDb
return "unix_timestamp($fname)";
}
/**
\brief formatage de la date en fonction des locales.
\brief Formatage de la date en fonction des locales.
\param fname
\return date
*/
@@ -377,73 +442,6 @@ class DoliDb
}
/**
\brief Renvoie les donn<6E>es dans un tableau.
\return array
*/
function fetch_array()
{
return pg_fetch_array($this->results);
}
/**
\brief Renvoie les donn<6E>es comme un tableau.
\return array
*/
function fetch_row()
{
return pg_fetch_row($this->results);
}
/**
\brief Obtient les donn<6E>es d'un colonne et renvoie les donn<6E>es sous forme d'objet.
\return array
*/
function fetch_field()
{
return pg_field_name($this->results);
}
/**
\brief Renvoie le nombre de lignes dans le
resultat d'une requete SELECT
\see affected_rows
\return int nombre de lignes
*/
function num_rows()
{
return pg_num_rows($this->results);
}
/**
\brief Renvoie le nombre de lignes dans le
resultat d'une requete INSERT, DELETE ou UPDATE
\see num_rows
\return int nombre de lignes
*/
function affected_rows()
{
// pgsql necessite un resultset pour cette fonction contrairement
// a mysql qui prend un link de base
return pg_affected_rows($this->results);
}
/**
\brief Renvoie le nombre de champs dans le resultat de la requete.
\return int
*/
function num_fields()
{
return pg_num_fields($this->results);
}
/**
\brief Renvoie la derniere requete soumise par la methode query()
\return lastquery
@@ -479,7 +477,7 @@ class DoliDb
}
/**
\brief Obtient l'id gen<65>r<EFBFBD> par le pr<EFBFBD>cedent INSERT.
\brief Obtient l'id gen<65>r<EFBFBD> par le dernier INSERT.
\return id
*/
@@ -491,7 +489,6 @@ class DoliDb
return $row;
}
/**
\brief Retourne le dsn pear
\return dsn
@@ -505,6 +502,18 @@ class DoliDb
return $pear;
}
/**
\brief Liste des tables dans une database.
\param database Nom de la database
\return resource
*/
function list_tables($database)
{
$this->results = pg_query($this->db, "SHOW TABLES;");
return $this->results;
}
}
?>