mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2026-01-22 00:33:17 +01:00
Doxygen
This commit is contained in:
@@ -450,8 +450,8 @@ class DoliDBPgsql
|
||||
/**
|
||||
* Validate a database transaction
|
||||
*
|
||||
* @param log Add more log to default log line
|
||||
* @return int 1 if validation is OK or transaction level no started, 0 if ERROR
|
||||
* @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
|
||||
*/
|
||||
function commit($log='')
|
||||
{
|
||||
@@ -474,6 +474,7 @@ class DoliDBPgsql
|
||||
|
||||
/**
|
||||
* 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()
|
||||
@@ -496,10 +497,10 @@ class DoliDBPgsql
|
||||
/**
|
||||
* Convert request to PostgreSQL syntax, execute it and return the resultset
|
||||
*
|
||||
* @param 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 type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
|
||||
* @return resource Resultset of answer
|
||||
* @param string $query SQL query string
|
||||
* @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 string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
|
||||
* @return resource Resultset of answer
|
||||
*/
|
||||
function query($query,$usesavepoint=0,$type='auto')
|
||||
{
|
||||
@@ -554,8 +555,8 @@ class DoliDBPgsql
|
||||
/**
|
||||
* Renvoie la ligne courante (comme un objet) pour le curseur resultset
|
||||
*
|
||||
* @param resultset Curseur de la requete voulue
|
||||
* @return object Object result line or false if KO or end of cursor
|
||||
* @param Resultset $resultset Curseur de la requete voulue
|
||||
* @return Object Object result line or false if KO or end of cursor
|
||||
*/
|
||||
function fetch_object($resultset)
|
||||
{
|
||||
@@ -565,10 +566,10 @@ class DoliDBPgsql
|
||||
}
|
||||
|
||||
/**
|
||||
* Renvoie les donnees dans un tableau
|
||||
*
|
||||
* @param resultset Curseur de la requete voulue
|
||||
* @return array
|
||||
* Return datas as an array
|
||||
*
|
||||
* @param Resultset $resultset Resultset of request
|
||||
* @return array Array
|
||||
*/
|
||||
function fetch_array($resultset)
|
||||
{
|
||||
@@ -578,10 +579,10 @@ class DoliDBPgsql
|
||||
}
|
||||
|
||||
/**
|
||||
* Renvoie les donnees comme un tableau
|
||||
*
|
||||
* @param resultset Curseur de la requete voulue
|
||||
* @return array
|
||||
* Return datas as an array
|
||||
*
|
||||
* @param Resultset $resultset Resultset of request
|
||||
* @return array Array
|
||||
*/
|
||||
function fetch_row($resultset)
|
||||
{
|
||||
@@ -591,11 +592,11 @@ class DoliDBPgsql
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
* Return number of lines for result of a SELECT
|
||||
*
|
||||
* @param Resultset $resultset Resulset of requests
|
||||
* @return int Nb of lines
|
||||
* @see affected_rows
|
||||
*/
|
||||
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
|
||||
*
|
||||
* @see num_rows
|
||||
* @param resultset Curseur de la requete voulue
|
||||
* @return int Nombre de lignes
|
||||
* @param Resultset $resultset Curseur de la requete voulue
|
||||
* @return int Nombre de lignes
|
||||
*/
|
||||
function affected_rows($resultset)
|
||||
{
|
||||
@@ -624,7 +625,8 @@ class DoliDBPgsql
|
||||
/**
|
||||
* 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)
|
||||
{
|
||||
@@ -638,9 +640,9 @@ class DoliDBPgsql
|
||||
/**
|
||||
* Defini les limites de la requete
|
||||
*
|
||||
* @param limit nombre maximum de lignes retournees
|
||||
* @param offset numero de la ligne a partir de laquelle recuperer les lignes
|
||||
* @return string chaine exprimant la syntax sql de la limite
|
||||
* @param int $limit nombre maximum de lignes retournees
|
||||
* @param int $offset numero de la ligne a partir de laquelle recuperer les lignes
|
||||
* @return string chaine exprimant la syntax sql de la limite
|
||||
*/
|
||||
function plimit($limit=0,$offset=0)
|
||||
{
|
||||
@@ -654,10 +656,10 @@ class DoliDBPgsql
|
||||
/**
|
||||
* Define sort criteria of request
|
||||
*
|
||||
* @param sortfield List of sort fields
|
||||
* @param sortorder Sort order
|
||||
* @return string String to provide syntax of a sort sql string
|
||||
* TODO Mutualized this into a mother class
|
||||
* @param string $sortfield List of sort fields
|
||||
* @param string $sortorder Sort order
|
||||
* @return string String to provide syntax of a sort sql string
|
||||
* TODO Mutualized this into a mother class
|
||||
*/
|
||||
function order($sortfield=0,$sortorder=0)
|
||||
{
|
||||
@@ -685,8 +687,8 @@ class DoliDBPgsql
|
||||
/**
|
||||
* Escape a string to insert data
|
||||
*
|
||||
* @param stringtoencode String to escape
|
||||
* @return string String escaped
|
||||
* @param string $stringtoencode String to escape
|
||||
* @return string String escaped
|
||||
*/
|
||||
function escape($stringtoencode)
|
||||
{
|
||||
@@ -723,10 +725,10 @@ class DoliDBPgsql
|
||||
/**
|
||||
* Formate a SQL IF
|
||||
*
|
||||
* @param test chaine test
|
||||
* @param resok resultat si test egal
|
||||
* @param resko resultat si test non egal
|
||||
* @return string chaine formate SQL
|
||||
* @param string $test chaine test
|
||||
* @param string $resok resultat si test egal
|
||||
* @param string $resko resultat si test non egal
|
||||
* @return string chaine formate SQL
|
||||
*/
|
||||
function ifsql($test,$resok,$resko)
|
||||
{
|
||||
@@ -1320,8 +1322,8 @@ class DoliDBPgsql
|
||||
/**
|
||||
* Return value of server parameters
|
||||
*
|
||||
* @param filter Filter list on a particular value
|
||||
* @return string Value for parameter
|
||||
* @param string $filter Filter list on a particular value
|
||||
* @return string Value for parameter
|
||||
*/
|
||||
function getServerParametersValues($filter='')
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user