lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2012-01-04 14:35:41 +01:00
parent 785f5b3c46
commit 2ac5f4e550
5 changed files with 129 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
htdocs/core/db/mssql.class.php
View File

@ -277,8 +277,8 @@ class DoliDBMssql
/** /**
* Validate a database transaction * Validate a database transaction
* *
* @param $log Add more log to default log line * @param string $log Add more log to default log line
* @return int 1 if validation is OK or transaction level no started, 0 if ERROR * @return int 1 if validation is OK or transaction level no started, 0 if ERROR
*/ */
function commit($log='') function commit($log='')
{ {
@ -323,11 +323,11 @@ class DoliDBMssql
/** /**
* Execute a SQL request and return the resultset * Execute a SQL request and return the resultset
* *
* @param query SQL query string * @param string $query SQL query string
* @param usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions). * @param int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions).
* Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints. * Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints.
* @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
* @return resource Resultset of answer * @return resource Resultset of answer
*/ */
function query($query,$usesavepoint=0,$type='auto') function query($query,$usesavepoint=0,$type='auto')
{ {
@ -415,8 +415,8 @@ class DoliDBMssql
/** /**
* Renvoie la ligne courante (comme un objet) pour le curseur resultset * Renvoie la ligne courante (comme un objet) pour le curseur resultset
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Curseur de la requete voulue
* @return object Object result line or false if KO or end of cursor * @return Object Object result line or false if KO or end of cursor
*/ */
function fetch_object($resultset) function fetch_object($resultset)
{ {
@ -426,10 +426,10 @@ class DoliDBMssql
} }
/** /**
* Renvoie les donnees dans un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_array($resultset) function fetch_array($resultset)
{ {
@ -440,9 +440,10 @@ class DoliDBMssql
/** /**
* \brief Renvoie les donnees comme un tableau. * Return datas as an array
* \param resultset Curseur de la requete voulue *
* \return array * @param Resultset $resultset Resultset of request
* @return array Array
*/ */
function fetch_row($resultset) function fetch_row($resultset)
{ {
@ -452,10 +453,11 @@ class DoliDBMssql
} }
/** /**
* \brief Renvoie le nombre de lignes dans le resultat d'une requete SELECT * Return number of lines for result of a SELECT
* \see affected_rows *
* \param resultset Curseur de la requete voulue * @param Resultset $resultset Resulset of requests
* \return int Nombre de lignes * @return int Nb of lines
* @see affected_rows
*/ */
function num_rows($resultset) function num_rows($resultset)
{ {

48
htdocs/core/db/mysql.class.php
View File

@ -304,8 +304,8 @@ class DoliDBMysql
/** /**
* Validate a database transaction * Validate a database transaction
* *
* @param $log Add more log to default log line * @param string $log Add more log to default log line
* @return int 1 if validation is OK or transaction level no started, 0 if ERROR * @return int 1 if validation is OK or transaction level no started, 0 if ERROR
*/ */
function commit($log='') function commit($log='')
{ {
@ -329,8 +329,8 @@ class DoliDBMysql
/** /**
* Annulation d'une transaction et retour aux anciennes valeurs * Annulation d'une transaction et retour aux anciennes valeurs
* *
* @param $log Add more log to default log line * @param string $log Add more log to default log line
* @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur * @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur
*/ */
function rollback($log='') function rollback($log='')
{ {
@ -351,11 +351,11 @@ class DoliDBMysql
/** /**
* Execute a SQL request and return the resultset * Execute a SQL request and return the resultset
* *
* @param query SQL query string * @param string $query SQL query string
* @param usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions). * @param int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions).
* Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints. * Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints.
* @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
* @return resource Resultset of answer * @return resource Resultset of answer
*/ */
function query($query,$usesavepoint=0,$type='auto') function query($query,$usesavepoint=0,$type='auto')
{ {
@ -392,8 +392,8 @@ class DoliDBMysql
/** /**
* Renvoie la ligne courante (comme un objet) pour le curseur resultset * Renvoie la ligne courante (comme un objet) pour le curseur resultset
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Curseur de la requete voulue
* @return object Object result line or false if KO or end of cursor * @return Object Object result line or false if KO or end of cursor
*/ */
function fetch_object($resultset) function fetch_object($resultset)
{ {
@ -403,10 +403,10 @@ class DoliDBMysql
} }
/** /**
* Renvoie les donnees dans un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_array($resultset) function fetch_array($resultset)
{ {
@ -417,10 +417,10 @@ class DoliDBMysql
/** /**
* Renvoie les donnees comme un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_row($resultset) function fetch_row($resultset)
{ {
@ -430,11 +430,11 @@ class DoliDBMysql
} }
/** /**
* Renvoie le nombre de lignes dans le resultat d'une requete SELECT * Return number of lines for result of a SELECT
* *
* @see affected_rows * @param Resultset $resultset Resulset of requests
* @param resultset Curseur de la requete voulue * @return int Nb of lines
* @return int Nombre de lignes * @see affected_rows
*/ */
function num_rows($resultset) function num_rows($resultset)
{ {

42
htdocs/core/db/mysqli.class.php
View File

@ -311,8 +311,8 @@ class DoliDBMysqli
/** /**
* Validate a database transaction * Validate a database transaction
* *
* @param $log Add more log to default log line * @param string $log Add more log to default log line
* @return int 1 if validation is OK or transaction level no started, 0 if ERROR * @return int 1 if validation is OK or transaction level no started, 0 if ERROR
*/ */
function commit($log='') function commit($log='')
{ {
@ -336,8 +336,8 @@ class DoliDBMysqli
/** /**
* Annulation d'une transaction et retour aux anciennes valeurs * Annulation d'une transaction et retour aux anciennes valeurs
* *
* @param $log Add more log to default log line * @param string $log Add more log to default log line
* @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur * @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur
*/ */
function rollback($log='') function rollback($log='')
{ {
@ -358,11 +358,11 @@ class DoliDBMysqli
/** /**
* Execute a SQL request and return the resultset * Execute a SQL request and return the resultset
* *
* @param query SQL query string * @param string $query SQL query string
* @param usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions). * @param int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions).
* Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints. * Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints.
* @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
* @return resource Resultset of answer * @return resource Resultset of answer
*/ */
function query($query,$usesavepoint=0,$type='auto') function query($query,$usesavepoint=0,$type='auto')
{ {
@ -397,8 +397,8 @@ class DoliDBMysqli
/** /**
* Renvoie la ligne courante (comme un objet) pour le curseur resultset * Renvoie la ligne courante (comme un objet) pour le curseur resultset
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Curseur de la requete voulue
* @return object Object result line or false if KO or end of cursor * @return Object Object result line or false if KO or end of cursor
*/ */
function fetch_object($resultset) function fetch_object($resultset)
{ {
@ -409,10 +409,10 @@ class DoliDBMysqli
/** /**
* Renvoie les donnees dans un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_array($resultset) function fetch_array($resultset)
{ {
@ -422,10 +422,10 @@ class DoliDBMysqli
} }
/** /**
* Renvoie les donnees comme un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_row($resultset) function fetch_row($resultset)
{ {
@ -443,11 +443,11 @@ class DoliDBMysqli
} }
/** /**
* Renvoie le nombre de lignes dans le resultat d'une requete SELECT * Return number of lines for result of a SELECT
* *
* @see affected_rows * @param Resultset $resultset Resulset of requests
* @param resultset Curseur de la requete voulue * @return int Nb of lines
* @return int Nombre de lignes * @see affected_rows
*/ */
function num_rows($resultset) function num_rows($resultset)
{ {

80
htdocs/core/db/pgsql.class.php
View File

@ -450,8 +450,8 @@ class DoliDBPgsql
/** /**
* Validate a database transaction * Validate a database transaction
* *
* @param log Add more log to default log line * @param string $log Add more log to default log line
* @return int 1 if validation is OK or transaction level no started, 0 if ERROR * @return int 1 if validation is OK or transaction level no started, 0 if ERROR
*/ */
function commit($log='') function commit($log='')
{ {
@ -474,6 +474,7 @@ class DoliDBPgsql
/** /**
* Annulation d'une transaction et retour aux anciennes valeurs * Annulation d'une transaction et retour aux anciennes valeurs
*
* @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur * @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur
*/ */
function rollback() function rollback()
@ -496,10 +497,10 @@ class DoliDBPgsql
/** /**
* Convert request to PostgreSQL syntax, execute it and return the resultset * Convert request to PostgreSQL syntax, execute it and return the resultset
* *
* @param query SQL query string * @param string $query SQL query string
* @param usesavepoint 0=Default mode, 1=Run a savepoint before and a rollback to savepoint if error (this allow to have some request with errors inside global transactions). * @param int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollback to savepoint if error (this allow to have some request with errors inside global transactions).
* @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
* @return resource Resultset of answer * @return resource Resultset of answer
*/ */
function query($query,$usesavepoint=0,$type='auto') function query($query,$usesavepoint=0,$type='auto')
{ {
@ -554,8 +555,8 @@ class DoliDBPgsql
/** /**
* Renvoie la ligne courante (comme un objet) pour le curseur resultset * Renvoie la ligne courante (comme un objet) pour le curseur resultset
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Curseur de la requete voulue
* @return object Object result line or false if KO or end of cursor * @return Object Object result line or false if KO or end of cursor
*/ */
function fetch_object($resultset) function fetch_object($resultset)
{ {
@ -565,10 +566,10 @@ class DoliDBPgsql
} }
/** /**
* Renvoie les donnees dans un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_array($resultset) function fetch_array($resultset)
{ {
@ -578,10 +579,10 @@ class DoliDBPgsql
} }
/** /**
* Renvoie les donnees comme un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_row($resultset) function fetch_row($resultset)
{ {
@ -591,11 +592,11 @@ class DoliDBPgsql
} }
/** /**
* Renvoie le nombre de lignes dans le resultat d'une requete SELECT * Return number of lines for result of a SELECT
* *
* @see affected_rows * @param Resultset $resultset Resulset of requests
* @param resultset Curseur de la requete voulue * @return int Nb of lines
* @return int Nombre de lignes * @see affected_rows
*/ */
function num_rows($resultset) function num_rows($resultset)
{ {
@ -608,8 +609,8 @@ class DoliDBPgsql
* Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE * Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE
* *
* @see num_rows * @see num_rows
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Curseur de la requete voulue
* @return int Nombre de lignes * @return int Nombre de lignes
*/ */
function affected_rows($resultset) function affected_rows($resultset)
{ {
@ -624,7 +625,8 @@ class DoliDBPgsql
/** /**
* Libere le dernier resultset utilise sur cette connexion * Libere le dernier resultset utilise sur cette connexion
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Curseur de la requete voulue
* @return void
*/ */
function free($resultset=0) function free($resultset=0)
{ {
@ -638,9 +640,9 @@ class DoliDBPgsql
/** /**
* Defini les limites de la requete * Defini les limites de la requete
* *
* @param limit nombre maximum de lignes retournees * @param int $limit nombre maximum de lignes retournees
* @param offset numero de la ligne a partir de laquelle recuperer les lignes * @param int $offset numero de la ligne a partir de laquelle recuperer les lignes
* @return string chaine exprimant la syntax sql de la limite * @return string chaine exprimant la syntax sql de la limite
*/ */
function plimit($limit=0,$offset=0) function plimit($limit=0,$offset=0)
{ {
@ -654,10 +656,10 @@ class DoliDBPgsql
/** /**
* Define sort criteria of request * Define sort criteria of request
* *
* @param sortfield List of sort fields * @param string $sortfield List of sort fields
* @param sortorder Sort order * @param string $sortorder Sort order
* @return string String to provide syntax of a sort sql string * @return string String to provide syntax of a sort sql string
* TODO Mutualized this into a mother class * TODO Mutualized this into a mother class
*/ */
function order($sortfield=0,$sortorder=0) function order($sortfield=0,$sortorder=0)
{ {
@ -685,8 +687,8 @@ class DoliDBPgsql
/** /**
* Escape a string to insert data * Escape a string to insert data
* *
* @param stringtoencode String to escape * @param string $stringtoencode String to escape
* @return string String escaped * @return string String escaped
*/ */
function escape($stringtoencode) function escape($stringtoencode)
{ {
@ -723,10 +725,10 @@ class DoliDBPgsql
/** /**
* Formate a SQL IF * Formate a SQL IF
* *
* @param test chaine test * @param string $test chaine test
* @param resok resultat si test egal * @param string $resok resultat si test egal
* @param resko resultat si test non egal * @param string $resko resultat si test non egal
* @return string chaine formate SQL * @return string chaine formate SQL
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {
@ -1320,8 +1322,8 @@ class DoliDBPgsql
/** /**
* Return value of server parameters * Return value of server parameters
* *
* @param filter Filter list on a particular value * @param string $filter Filter list on a particular value
* @return string Value for parameter * @return string Value for parameter
*/ */
function getServerParametersValues($filter='') function getServerParametersValues($filter='')
{ {

42
htdocs/core/db/sqlite.class.php
View File

@ -429,8 +429,8 @@ class DoliDBSqlite
/** /**
* Validate a database transaction * Validate a database transaction
* *
* @param $log Add more log to default log line * @param string $log Add more log to default log line
* @return int 1 if validation is OK or transaction level no started, 0 if ERROR * @return int 1 if validation is OK or transaction level no started, 0 if ERROR
*/ */
function commit($log='') function commit($log='')
{ {
@ -454,8 +454,8 @@ class DoliDBSqlite
/** /**
* Annulation d'une transaction et retour aux anciennes valeurs * Annulation d'une transaction et retour aux anciennes valeurs
* *
* @param $log Add more log to default log line * @param string $log Add more log to default log line
* @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur * @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur
*/ */
function rollback($log='') function rollback($log='')
{ {
@ -476,11 +476,11 @@ class DoliDBSqlite
/** /**
* Execute a SQL request and return the resultset * Execute a SQL request and return the resultset
* *
* @param query SQL query string * @param string $query SQL query string
* @param usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions). * @param int $usesavepoint 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions).
* Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints. * Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints.
* @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
* @return resource Resultset of answer * @return resource Resultset of answer
*/ */
function query($query,$usesavepoint=0,$type='auto') function query($query,$usesavepoint=0,$type='auto')
{ {
@ -525,8 +525,8 @@ class DoliDBSqlite
/** /**
* Renvoie la ligne courante (comme un objet) pour le curseur resultset * Renvoie la ligne courante (comme un objet) pour le curseur resultset
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Curseur de la requete voulue
* @return object Object result line or false if KO or end of cursor * @return Object Object result line or false if KO or end of cursor
*/ */
function fetch_object($resultset) function fetch_object($resultset)
{ {
@ -537,10 +537,10 @@ class DoliDBSqlite
/** /**
* Renvoie les donnees dans un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_array($resultset) function fetch_array($resultset)
{ {
@ -550,10 +550,10 @@ class DoliDBSqlite
} }
/** /**
* Renvoie les donnees comme un tableau * Return datas as an array
* *
* @param resultset Curseur de la requete voulue * @param Resultset $resultset Resultset of request
* @return array * @return array Array
*/ */
function fetch_row($resultset) function fetch_row($resultset)
{ {
@ -571,11 +571,11 @@ class DoliDBSqlite
} }
/** /**
* Renvoie le nombre de lignes dans le resultat d'une requete SELECT * Return number of lines for result of a SELECT
* *
* @see affected_rows * @param Resultset $resultset Resulset of requests
* @param resultset Curseur de la requete voulue * @return int Nb of lines
* @return int Nombre de lignes * @see affected_rows
*/ */
function num_rows($resultset) function num_rows($resultset)
{ {