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-28 17:22:02 +01:00
parent 429ba54e3e
commit c2c8d1be3e
24 changed files with 347 additions and 288 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
htdocs/core/boxes/box_bookmarks.php
View File

@ -25,7 +25,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show bookmarks * Class to manage the box to show bookmarks
*/ */
class box_bookmarks extends ModeleBoxes { class box_bookmarks extends ModeleBoxes
{
var $boxcode="bookmarks"; var $boxcode="bookmarks";
var $boximg="object_bookmark"; var $boximg="object_bookmark";

3
htdocs/core/boxes/box_clients.php
View File

@ -29,7 +29,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last thirdparties * Class to manage the box to show last thirdparties
*/ */
class box_clients extends ModeleBoxes { class box_clients extends ModeleBoxes
{
var $boxcode="lastcustomers"; var $boxcode="lastcustomers";
var $boximg="object_company"; var $boximg="object_company";

3
htdocs/core/boxes/box_commandes.php
View File

@ -29,7 +29,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last orders * Class to manage the box to show last orders
*/ */
class box_commandes extends ModeleBoxes { class box_commandes extends ModeleBoxes
{
var $boxcode="lastcustomerorders"; var $boxcode="lastcustomerorders";
var $boximg="object_order"; var $boximg="object_order";

3
htdocs/core/boxes/box_comptes.php
View File

@ -29,7 +29,8 @@ include_once(DOL_DOCUMENT_ROOT."/compta/bank/class/account.class.php");
/** /**
* Class to manage the box to show last users * Class to manage the box to show last users
*/ */
class box_comptes extends ModeleBoxes { class box_comptes extends ModeleBoxes
{
var $boxcode="currentaccounts"; var $boxcode="currentaccounts";
var $boximg="object_bill"; var $boximg="object_bill";

3
htdocs/core/boxes/box_contacts.php
View File

@ -30,7 +30,8 @@ include_once(DOL_DOCUMENT_ROOT."/contact/class/contact.class.php");
/** /**
* Class to manage the box to show last contacts * Class to manage the box to show last contacts
*/ */
class box_contacts extends ModeleBoxes { class box_contacts extends ModeleBoxes
{
var $boxcode="lastcontacts"; var $boxcode="lastcontacts";
var $boximg="object_contact"; var $boximg="object_contact";

3
htdocs/core/boxes/box_contracts.php
View File

@ -27,7 +27,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last contracts * Class to manage the box to show last contracts
*/ */
class box_contracts extends ModeleBoxes { class box_contracts extends ModeleBoxes
{
var $boxcode="lastcontracts"; var $boxcode="lastcontracts";
var $boximg="object_contract"; var $boximg="object_contract";

3
htdocs/core/boxes/box_external_rss.php
View File

@ -31,7 +31,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show RSS feeds * Class to manage the box to show RSS feeds
*/ */
class box_external_rss extends ModeleBoxes { class box_external_rss extends ModeleBoxes
{
var $boxcode="lastrssinfos"; var $boxcode="lastrssinfos";
var $boximg="object_rss"; var $boximg="object_rss";

3
htdocs/core/boxes/box_factures.php
View File

@ -28,7 +28,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last invoices * Class to manage the box to show last invoices
*/ */
class box_factures extends ModeleBoxes { class box_factures extends ModeleBoxes
{
var $boxcode="lastcustomerbills"; var $boxcode="lastcustomerbills";
var $boximg="object_bill"; var $boximg="object_bill";

3
htdocs/core/boxes/box_factures_fourn.php
View File

@ -28,7 +28,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last supplier invoices * Class to manage the box to show last supplier invoices
*/ */
class box_factures_fourn extends ModeleBoxes { class box_factures_fourn extends ModeleBoxes
{
var $boxcode="lastsupplierbills"; var $boxcode="lastsupplierbills";
var $boximg="object_bill"; var $boximg="object_bill";

3
htdocs/core/boxes/box_factures_fourn_imp.php
View File

@ -27,7 +27,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show not payed suppliers invoices * Class to manage the box to show not payed suppliers invoices
*/ */
class box_factures_fourn_imp extends ModeleBoxes { class box_factures_fourn_imp extends ModeleBoxes
{
var $boxcode="oldestunpaidsupplierbills"; var $boxcode="oldestunpaidsupplierbills";
var $boximg="object_bill"; var $boximg="object_bill";

3
htdocs/core/boxes/box_factures_imp.php
View File

@ -30,7 +30,8 @@ require_once(DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php');
/** /**
* Class to manage the box to show last invoices * Class to manage the box to show last invoices
*/ */
class box_factures_imp extends ModeleBoxes { class box_factures_imp extends ModeleBoxes
{
var $boxcode="oldestunpaidcustomerbills"; var $boxcode="oldestunpaidcustomerbills";
var $boximg="object_bill"; var $boximg="object_bill";

3
htdocs/core/boxes/box_fournisseurs.php
View File

@ -28,7 +28,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last suppliers * Class to manage the box to show last suppliers
*/ */
class box_fournisseurs extends ModeleBoxes { class box_fournisseurs extends ModeleBoxes
{
var $boxcode="lastsuppliers"; var $boxcode="lastsuppliers";
var $boximg="object_company"; var $boximg="object_company";

3
htdocs/core/boxes/box_members.php
View File

@ -29,7 +29,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last members * Class to manage the box to show last members
*/ */
class box_members extends ModeleBoxes { class box_members extends ModeleBoxes
{
var $boxcode="lastmembers"; var $boxcode="lastmembers";
var $boximg="object_user"; var $boximg="object_user";

3
htdocs/core/boxes/box_osc_client.php
View File

@ -28,7 +28,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last customers of shop * Class to manage the box to show last customers of shop
*/ */
class box_osc_clients extends ModeleBoxes { class box_osc_clients extends ModeleBoxes
{
var $boxcode="nbofcustomers"; var $boxcode="nbofcustomers";
var $boximg="object_company"; var $boximg="object_company";

3
htdocs/core/boxes/box_produits.php
View File

@ -30,7 +30,8 @@ include_once(DOL_DOCUMENT_ROOT."/product/class/product.class.php");
/** /**
* Class to manage the box to show last products * Class to manage the box to show last products
*/ */
class box_produits extends ModeleBoxes { class box_produits extends ModeleBoxes
{
var $boxcode="lastproducts"; var $boxcode="lastproducts";
var $boximg="object_product"; var $boximg="object_product";

3
htdocs/core/boxes/box_propales.php
View File

@ -29,7 +29,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last proposals * Class to manage the box to show last proposals
*/ */
class box_propales extends ModeleBoxes { class box_propales extends ModeleBoxes
{
var $boxcode="lastpropals"; var $boxcode="lastpropals";
var $boximg="object_propal"; var $boximg="object_propal";

3
htdocs/core/boxes/box_prospect.php
View File

@ -31,7 +31,8 @@ include_once(DOL_DOCUMENT_ROOT."/comm/prospect/class/prospect.class.php");
/** /**
* Class to manage the box to show last prospects * Class to manage the box to show last prospects
*/ */
class box_prospect extends ModeleBoxes { class box_prospect extends ModeleBoxes
{
var $boxcode="lastprospects"; var $boxcode="lastprospects";
var $boximg="object_company"; var $boximg="object_company";

3
htdocs/core/boxes/box_services_expired.php
View File

@ -27,7 +27,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show expired services * Class to manage the box to show expired services
*/ */
class box_services_expired extends ModeleBoxes { class box_services_expired extends ModeleBoxes
{
var $boxcode="expiredservices"; var $boxcode="expiredservices";
var $boximg="object_contract"; var $boximg="object_contract";

3
htdocs/core/boxes/box_services_vendus.php
View File

@ -29,7 +29,8 @@ include_once(DOL_DOCUMENT_ROOT."/core/boxes/modules_boxes.php");
/** /**
* Class to manage the box to show last services lines * Class to manage the box to show last services lines
*/ */
class box_services_vendus extends ModeleBoxes { class box_services_vendus extends ModeleBoxes
{
var $boxcode="lastproductsincontract"; var $boxcode="lastproductsincontract";
var $boximg="object_product"; var $boximg="object_product";

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

@ -467,10 +467,11 @@ class DoliDBMssql
} }
/** /**
\brief 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 *
\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
* @see num_rows
*/ */
function affected_rows($resultset) function affected_rows($resultset)
{ {
@ -485,8 +486,10 @@ class DoliDBMssql
/** /**
* \brief Libere le dernier resultset utilise sur cette connexion. * Free last resultset used.
* \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)
{ {
@ -498,10 +501,11 @@ class DoliDBMssql
/** /**
* \brief Defini les limites de la requete. * Define limits of request
* \param limit nombre maximum de lignes retournees *
* \param offset numero de la ligne a partir de laquelle recuperer les ligne * @param int $limit nombre maximum de lignes retournees
* \return string chaine exprimant la syntax sql de la limite * @param int $offset numero de la ligne a partir de laquelle recuperer les ligne
* @return string chaine exprimant la syntax sql de la limite
*/ */
function plimit($limit=0,$offset=0) function plimit($limit=0,$offset=0)
{ {
@ -514,10 +518,11 @@ class DoliDBMssql
/** /**
* Define sort criteria of request * Define sort criteria of request
* @param sortfield List of sort fields *
* @param sortorder Sort order * @param string $sortfield List of sort fields
* @return string String to provide syntax of a sort sql string * @param string $sortorder Sort order
* TODO Mutualized this into a mother class * @return string String to provide syntax of a sort sql string
* TODO Mutualized this into a mother class
*/ */
function order($sortfield=0,$sortorder=0) function order($sortfield=0,$sortorder=0)
{ {
@ -543,10 +548,10 @@ class DoliDBMssql
/** /**
* 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)
{ {
@ -582,11 +587,12 @@ class DoliDBMssql
} }
/** /**
* Formate a SQL IF * Formate a SQL IF
* @param test chaine test *
* @param resok resultat si test egal * @param string $test chaine test
* @param resko resultat si test non egal * @param string $resok resultat si test egal
* @return string chaine formate SQL * @param string $resko resultat si test non egal
* @return string SQL string
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {
@ -595,8 +601,9 @@ class DoliDBMssql
/** /**
* \brief Renvoie la derniere requete soumise par la methode query() * Return last request executed with query()
* \return lastquery *
* @return string Last query
*/ */
function lastquery() function lastquery()
{ {
@ -604,8 +611,9 @@ class DoliDBMssql
} }
/** /**
\brief Renvoie la derniere requete en erreur * Return last query in error
\return string lastqueryerror *
* @return string lastqueryerror
*/ */
function lastqueryerror() function lastqueryerror()
{ {
@ -613,8 +621,9 @@ class DoliDBMssql
} }
/** /**
\brief Renvoie le libelle derniere erreur * Return last error label
\return string lasterror *
* @return string lasterror
*/ */
function lasterror() function lasterror()
{ {
@ -622,8 +631,9 @@ class DoliDBMssql
} }
/** /**
\brief Renvoie le code derniere erreur * Return last error code
\return string lasterrno *
* @return string lasterrno
*/ */
function lasterrno() function lasterrno()
{ {
@ -631,16 +641,19 @@ class DoliDBMssql
} }
/** /**
\brief Renvoie le code erreur generique de l'operation precedente. * Return generic error code of last operation.
\return error_num (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...) *
* @return string Error code (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)
*/ */
function errno() function errno()
{ {
if (! $this->connected) { if (! $this->connected)
{
// Si il y a eu echec de connexion, $this->db n'est pas valide. // Si il y a eu echec de connexion, $this->db n'est pas valide.
return 'DB_ERROR_FAILED_TO_CONNECT'; return 'DB_ERROR_FAILED_TO_CONNECT';
} }
else { else
{
// Constants to convert a MSSql error code to a generic Dolibarr error code // Constants to convert a MSSql error code to a generic Dolibarr error code
$errorcode_map = array( $errorcode_map = array(
1004 => 'DB_ERROR_CANNOT_CREATE', 1004 => 'DB_ERROR_CANNOT_CREATE',
@ -680,8 +693,9 @@ class DoliDBMssql
} }
/** /**
\brief Renvoie le texte de l'erreur mssql de l'operation precedente. * Return description of last error
\return error_text *
* @return string Error text
*/ */
function error() function error()
{ {
@ -717,9 +731,10 @@ class DoliDBMssql
/** /**
* Encrypt sensitive data in database * Encrypt sensitive data in database
* Warning: This function includes the escape, so it must use direct value * Warning: This function includes the escape, so it must use direct value
* @param fieldorvalue Field name or value to encrypt *
* @param withQuotes Return string with quotes * @param string $fieldorvalue Field name or value to encrypt
* @return return XXX(field) or XXX('value') or field or 'value' * @param int $withQuotes Return string with quotes
* @return return XXX(field) or XXX('value') or field or 'value'
*/ */
function encrypt($fieldorvalue, $withQuotes=0) function encrypt($fieldorvalue, $withQuotes=0)
{ {
@ -736,9 +751,10 @@ class DoliDBMssql
} }
/** /**
* \brief Decrypt sensitive data in database * Decrypt sensitive data in database
* \param value Value to decrypt *
* \return return Decrypted value if used * @param string $value Value to decrypt
* @return string Decrypted value if used
*/ */
function decrypt($value) function decrypt($value)
{ {
@ -755,12 +771,10 @@ class DoliDBMssql
} }
// Next function are not required. Only minor features use them.
//--------------------------------------------------------------
/** /**
* \brief Renvoie l'id de la connexion * Return connexion ID
* \return string Id connexion *
* @return string Id connexion
*/ */
function DDLGetConnectId() function DDLGetConnectId()
{ {
@ -770,15 +784,17 @@ class DoliDBMssql
} }
/** /**
* \brief Create a new database * Create a new database
* \param database Database name to create * Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated
* \param charset Charset used to store data * We force to create database with charset this->forcecharset and collate this->forcecollate
* \param collation Charset used to sort data *
* \return resource resource defined if OK, null if KO * @param string $database Database name to create
* \remarks Ne pas utiliser les fonctions xxx_create_db (xxx=mssql, ...) car elles sont deprecated * @param string $charset Charset used to store data
* We force to create database with charset this->forcecharset and collate this->forcecollate * @param string $collation Charset used to sort data
* @param string $owner Username of database owner
* @return resource resource defined if OK, null if KO
*/ */
function DDLCreateDb($database,$charset='',$collation='') function DDLCreateDb($database,$charset='',$collation='',$owner='')
{ {
// ALTER DATABASE dolibarr_db DEFAULT CHARACTER SET latin DEFAULT COLLATE latin1_swedish_ci // ALTER DATABASE dolibarr_db DEFAULT CHARACTER SET latin DEFAULT COLLATE latin1_swedish_ci
$sql = 'CREATE DATABASE '.$database; $sql = 'CREATE DATABASE '.$database;

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

@ -446,9 +446,9 @@ class DoliDBMysql
/** /**
* 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 * @param resultset $resultset Curseur de la requete voulue
* @param resultset Curseur de la requete voulue * @return int Nombre de lignes
* @return int Nombre de lignes * @see num_rows
*/ */
function affected_rows($resultset) function affected_rows($resultset)
{ {
@ -461,9 +461,10 @@ class DoliDBMysql
/** /**
* Libere le dernier resultset utilise sur cette connexion. * Free last resultset used.
* *
* @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)
{ {
@ -475,11 +476,11 @@ class DoliDBMysql
/** /**
* Defini les limites de la requete * Define limits of request
* *
* @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 ligne * @param int $offset numero de la ligne a partir de laquelle recuperer les ligne
* @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)
{ {
@ -493,10 +494,10 @@ class DoliDBMysql
/** /**
* 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)
{ {
@ -522,10 +523,10 @@ class DoliDBMysql
/** /**
* 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)
{ {
@ -534,11 +535,11 @@ class DoliDBMysql
/** /**
* Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field. * Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field.
* Function to use to build INSERT, UPDATE or WHERE predica * Function to use to build INSERT, UPDATE or WHERE predica
* *
* @param string $param Date TMS to convert * @param string $param Date TMS to convert
* @return string Date in a string YYYYMMDDHHMMSS * @return string Date in a string YYYYMMDDHHMMSS
*/ */
function idate($param) function idate($param)
{ {
@ -563,10 +564,10 @@ class DoliDBMysql
/** /**
* 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 SQL string * @return string SQL string
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {
@ -575,8 +576,9 @@ class DoliDBMysql
/** /**
* \brief Renvoie la derniere requete soumise par la methode query() * Return last request executed with query()
* \return lastquery *
* @return string Last query
*/ */
function lastquery() function lastquery()
{ {
@ -584,8 +586,9 @@ class DoliDBMysql
} }
/** /**
* \brief Renvoie la derniere requete en erreur * Return last query in error
* \return string lastqueryerror *
* @return string lastqueryerror
*/ */
function lastqueryerror() function lastqueryerror()
{ {
@ -593,8 +596,9 @@ class DoliDBMysql
} }
/** /**
* \brief Renvoie le libelle derniere erreur * Return last error label
* \return string lasterror *
* @return string lasterror
*/ */
function lasterror() function lasterror()
{ {
@ -602,8 +606,9 @@ class DoliDBMysql
} }
/** /**
* \brief Renvoie le code derniere erreur * Return last error code
* \return string lasterrno *
* @return string lasterrno
*/ */
function lasterrno() function lasterrno()
{ {
@ -611,16 +616,19 @@ class DoliDBMysql
} }
/** /**
* \brief Renvoie le code erreur generique de l'operation precedente. * Return generic error code of last operation.
* \return error_num (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...) *
* @return string Error code (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)
*/ */
function errno() function errno()
{ {
if (! $this->connected) { if (! $this->connected)
{
// Si il y a eu echec de connexion, $this->db n'est pas valide. // Si il y a eu echec de connexion, $this->db n'est pas valide.
return 'DB_ERROR_FAILED_TO_CONNECT'; return 'DB_ERROR_FAILED_TO_CONNECT';
} }
else { else
{
// Constants to convert a MySql error code to a generic Dolibarr error code // Constants to convert a MySql error code to a generic Dolibarr error code
$errorcode_map = array( $errorcode_map = array(
1004 => 'DB_ERROR_CANNOT_CREATE', 1004 => 'DB_ERROR_CANNOT_CREATE',
@ -661,8 +669,9 @@ class DoliDBMysql
} }
/** /**
\brief Renvoie le texte de l'erreur mysql de l'operation precedente. * Return description of last error
\return error_text *
* @return string Error text
*/ */
function error() function error()
{ {
@ -728,9 +737,10 @@ class DoliDBMysql
} }
/** /**
* \brief Decrypt sensitive data in database * Decrypt sensitive data in database
* \param value Value to decrypt *
* \return return Decrypted value if used * @param string $value Value to decrypt
* @return string Decrypted value if used
*/ */
function decrypt($value) function decrypt($value)
{ {
@ -761,9 +771,9 @@ class DoliDBMysql
/** /**
* Renvoie l'id de la connexion * Return connexion ID
* *
* @return string Id connexion * @return string Id connexion
*/ */
function DDLGetConnectId() function DDLGetConnectId()
{ {
@ -774,14 +784,15 @@ class DoliDBMysql
/** /**
* \brief Create a new database * Create a new database
* \param database Database name to create * Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated
* \param charset Charset used to store data * We force to create database with charset this->forcecharset and collate this->forcecollate
* \param collation Charset used to sort data *
* \param owner Username of database owner * @param string $database Database name to create
* \return resource resource defined if OK, null if KO * @param string $charset Charset used to store data
* \remarks Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated * @param string $collation Charset used to sort data
* We force to create database with charset this->forcecharset and collate this->forcecollate * @param string $owner Username of database owner
* @return resource resource defined if OK, null if KO
*/ */
function DDLCreateDb($database,$charset='',$collation='',$owner='') function DDLCreateDb($database,$charset='',$collation='',$owner='')
{ {
@ -1132,7 +1143,7 @@ class DoliDBMysql
/** /**
* Return list of available collation that can be used for database * Return list of available collation that can be used for database
* *
* @return array Liste of Collation * @return array List of Collation
*/ */
function getListOfCollation() function getListOfCollation()
{ {

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

@ -455,9 +455,10 @@ class DoliDBMysqli
/** /**
* 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 *
* @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
* @see num_rows
*/ */
function affected_rows($resultset) function affected_rows($resultset)
@ -473,7 +474,8 @@ class DoliDBMysqli
/** /**
* 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)
{ {
@ -487,9 +489,9 @@ class DoliDBMysqli
/** /**
* 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 ligne * @param int $offset numero de la ligne a partir de laquelle recuperer les ligne
* @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)
{ {
@ -503,10 +505,10 @@ class DoliDBMysqli
/** /**
* 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)
{ {
@ -534,8 +536,8 @@ class DoliDBMysqli
/** /**
* 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)
{ {
@ -572,10 +574,10 @@ class DoliDBMysqli
/** /**
* 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 SQL string * @return string SQL string
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {
@ -584,8 +586,9 @@ class DoliDBMysqli
/** /**
* \brief Renvoie la derniere requete soumise par la methode query() * Return last request executed with query()
* \return lastquery *
* @return string Last query
*/ */
function lastquery() function lastquery()
{ {
@ -593,8 +596,9 @@ class DoliDBMysqli
} }
/** /**
* \brief Renvoie la derniere requete en erreur * Renvoie la derniere requete en erreur
* \return string lastqueryerror *
* @return string lastqueryerror
*/ */
function lastqueryerror() function lastqueryerror()
{ {
@ -602,8 +606,9 @@ class DoliDBMysqli
} }
/** /**
* \brief Renvoie le libelle derniere erreur * Renvoie le libelle derniere erreur
* \return string lasterror *
* @return string lasterror
*/ */
function lasterror() function lasterror()
{ {
@ -611,8 +616,9 @@ class DoliDBMysqli
} }
/** /**
* \brief Renvoie le code derniere erreur * Renvoie le code derniere erreur
* \return string lasterrno *
* @return string lasterrno
*/ */
function lasterrno() function lasterrno()
{ {
@ -620,8 +626,9 @@ class DoliDBMysqli
} }
/** /**
* \brief Renvoie le code erreur generique de l'operation precedente. * Return generic error code of last operation.
* \return error_num (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...) *
* @return string Error code (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)
*/ */
function errno() function errno()
{ {
@ -670,8 +677,9 @@ class DoliDBMysqli
} }
/** /**
* \brief Renvoie le texte de l'erreur mysql de l'operation precedente. * Return description of last error
* \return error_text *
* @return string Error text
*/ */
function error() function error()
{ {
@ -733,9 +741,10 @@ class DoliDBMysqli
} }
/** /**
* \brief Decrypt sensitive data in database * Decrypt sensitive data in database
* \param value Value to decrypt *
* \return return Decrypted value if used * @param string $value Value to decrypt
* @return string Decrypted value if used
*/ */
function decrypt($value) function decrypt($value)
{ {
@ -766,9 +775,9 @@ class DoliDBMysqli
/** /**
* Renvoie l'id de la connexion * Return connexion ID
* *
* @return string Id connexion * @return string Id connexion
*/ */
function DDLGetConnectId() function DDLGetConnectId()
{ {
@ -778,14 +787,15 @@ class DoliDBMysqli
} }
/** /**
* \brief Create a new database * Create a new database
* \param database Database name to create * Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated
* \param charset Charset used to store data * We force to create database with charset this->forcecharset and collate this->forcecollate
* \param collation Charset used to sort data *
* \param owner Username of database owner * @param string $database Database name to create
* \return resource resource defined if OK, null if KO * @param string $charset Charset used to store data
* \remarks Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated * @param string $collation Charset used to sort data
* We force to create database with charset this->forcecharset and collate this->forcecollate * @param string $owner Username of database owner
* @return resource resource defined if OK, null if KO
*/ */
function DDLCreateDb($database,$charset='',$collation='',$owner='') function DDLCreateDb($database,$charset='',$collation='',$owner='')
{ {

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

@ -940,12 +940,8 @@ class DoliDBPgsql
} }
// Next function are not required. Only minor features use them.
//--------------------------------------------------------------
/** /**
* Renvoie l'id de la connexion * Return connexion ID
* *
* @return string Id connexion * @return string Id connexion
*/ */
@ -958,13 +954,14 @@ class DoliDBPgsql
/** /**
* Create a new database * Create a new database
* Ne pas utiliser les fonctions xxx_create_db (xxx=mysql, ...) car elles sont deprecated * Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated
* We force to create database with charset this->forcecharset and collate this->forcecollate
* *
* @param string $database Database name to create * @param string $database Database name to create
* @param string $charset Charset used to store data * @param string $charset Charset used to store data
* @param string $collation Charset used to sort data * @param string $collation Charset used to sort data
* @param string $owner Username of database owner * @param string $owner Username of database owner
* @return resource Resource defined if OK, null if KO * @return resource resource defined if OK, null if KO
*/ */
function DDLCreateDb($database,$charset='',$collation='',$owner='') function DDLCreateDb($database,$charset='',$collation='',$owner='')
{ {

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

@ -585,13 +585,12 @@ class DoliDBSqlite
} }
/** /**
* Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE * Return number of lines for result of a SELECT
* *
* @see num_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 affected_rows($resultset) function affected_rows($resultset)
{ {
// If resultset not provided, we take the last used by connexion // If resultset not provided, we take the last used by connexion
@ -602,11 +601,12 @@ class DoliDBSqlite
} }
/** /**
* Libere le dernier resultset utilise sur cette connexion * Free last resultset used.
* *
* @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)
{ {
// If resultset not provided, we take the last used by connexion // If resultset not provided, we take the last used by connexion
@ -616,13 +616,13 @@ class DoliDBSqlite
} }
/** /**
* Defini les limites de la requete * Define limits of request
* *
* @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 ligne * @param int $offset numero de la ligne a partir de laquelle recuperer les ligne
* @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)
{ {
global $conf; global $conf;
@ -632,14 +632,14 @@ class DoliDBSqlite
} }
/** /**
* 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)
{ {
if ($sortfield) if ($sortfield)
@ -663,12 +663,12 @@ class DoliDBSqlite
} }
/** /**
* 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)
{ {
return PDO::quote($stringtoencode); return PDO::quote($stringtoencode);
@ -701,14 +701,14 @@ class DoliDBSqlite
return $date; return $date;
} }
/** /**
* 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 formatee SQL * @return string SQL string
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {
return 'IF('.$test.','.$resok.','.$resko.')'; return 'IF('.$test.','.$resok.','.$resko.')';
@ -725,31 +725,31 @@ class DoliDBSqlite
return $this->lastquery; return $this->lastquery;
} }
/** /**
* Renvoie la derniere requete en erreur * Return last query in error
* *
* @return string lastqueryerror * @return string lastqueryerror
*/ */
function lastqueryerror() function lastqueryerror()
{ {
return $this->lastqueryerror; return $this->lastqueryerror;
} }
/** /**
* Renvoie le libelle derniere erreur * Return last error label
* *
* @return string lasterror * @return string lasterror
*/ */
function lasterror() function lasterror()
{ {
return $this->lasterror; return $this->lasterror;
} }
/** /**
* Renvoie le code derniere erreur * Return last error code
* *
* @return string lasterrno * @return string lasterrno
*/ */
function lasterrno() function lasterrno()
{ {
return $this->lasterrno; return $this->lasterrno;
@ -846,13 +846,12 @@ class DoliDBSqlite
} }
/** /**
* Encrypt sensitive data in database * Encrypt sensitive data in database
* Warning: This function includes the escape, so it must use direct value * Warning: This function includes the escape, so it must use direct value
* *
* @param fieldorvalue Field name or value to encrypt * @param string $fieldorvalue Field name or value to encrypt
* @param withQuotes Return string with quotes * @param int $withQuotes Return string with quotes
* @return return XXX(field) or XXX('value') or field or 'value' * @return return XXX(field) or XXX('value') or field or 'value'
*
*/ */
function encrypt($fieldorvalue, $withQuotes=0) function encrypt($fieldorvalue, $withQuotes=0)
{ {
@ -882,9 +881,10 @@ class DoliDBSqlite
} }
/** /**
* \brief Decrypt sensitive data in database * Decrypt sensitive data in database
* \param value Value to decrypt *
* \return return Decrypted value if used * @param string $value Value to decrypt
* @return string Decrypted value if used
*/ */
function decrypt($value) function decrypt($value)
{ {
@ -914,29 +914,27 @@ class DoliDBSqlite
} }
// Next functions are not required. Only minor features use them.
//---------------------------------------------------------------
/** /**
* \brief Renvoie l'id de la connexion * Return connexion ID
* \return string Id connexion *
* @return string Id connexion
*/ */
function DDLGetConnectId() function DDLGetConnectId()
{ {
$resql=$this->query('SELECT CONNECTION_ID()'); return '?';
$row=$this->fetch_row($resql);
return $row[0];
} }
/** /**
* \brief Create a new database * Create a new database
* \param database Database name to create * Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated
* \param charset Charset used to store data * We force to create database with charset this->forcecharset and collate this->forcecollate
* \param collation Charset used to sort data *
* \param owner Username of database owner * @param string $database Database name to create
* \return resource resource defined if OK, null if KO * @param string $charset Charset used to store data
* \remarks Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated * @param string $collation Charset used to sort data
* We force to create database with charset this->forcecharset and collate this->forcecollate * @param string $owner Username of database owner
* @return resource resource defined if OK, null if KO
*/ */
function DDLCreateDb($database,$charset='',$collation='',$owner='') function DDLCreateDb($database,$charset='',$collation='',$owner='')
{ {
@ -1234,19 +1232,21 @@ class DoliDBSqlite
return 1; return 1;
} }
/** /**
* \brief Return charset used to store data in database * Return charset used to store data in database
* \return string Charset *
*/ * @return string Charset
*/
function getDefaultCharacterSetDatabase() function getDefaultCharacterSetDatabase()
{ {
return 'UTF-8'; return 'UTF-8';
} }
/** /**
* \brief Return list of available charset that can be used to store data in database * Return list of available charset that can be used to store data in database
* \return array List of Charset *
*/ * @return array List of Charset
*/
function getListOfCharacterSet() function getListOfCharacterSet()
{ {
$liste = array(); $liste = array();
@ -1256,19 +1256,21 @@ class DoliDBSqlite
return $liste; return $liste;
} }
/** /**
* \brief Return collation used in database * Return collation used in database
* \return string Collation value *
*/ * @return string Collation value
*/
function getDefaultCollationDatabase() function getDefaultCollationDatabase()
{ {
return 'UTF-8'; return 'UTF-8';
} }
/** /**
* \brief Return list of available collation that can be used for database * Return list of available collation that can be used for database
* \return array Liste of Collation *
*/ * @return array List of Collation
*/
function getListOfCollation() function getListOfCollation()
{ {
$liste = array(); $liste = array();
@ -1278,11 +1280,12 @@ class DoliDBSqlite
return $liste; return $liste;
} }
/** /**
* Return full path of dump program * Return full path of dump program
*
* @return string Full path of dump program * @return string Full path of dump program
*/ */
function getPathOfDump() function getPathOfDump()
{ {
$fullpathofdump='/pathtomysqldump/mysqldump'; $fullpathofdump='/pathtomysqldump/mysqldump';
@ -1296,10 +1299,11 @@ class DoliDBSqlite
return $fullpathofdump; return $fullpathofdump;
} }
/** /**
* Return full path of restore program * Return full path of restore program
* @return string Full path of restore program *
*/ * @return string Full path of restore program
*/
function getPathOfRestore() function getPathOfRestore()
{ {
$fullpathofimport='/pathtomysql/mysql'; $fullpathofimport='/pathtomysql/mysql';
@ -1314,11 +1318,12 @@ class DoliDBSqlite
return $fullpathofimport; return $fullpathofimport;
} }
/** /**
* \brief Return value of server parameters * 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='') function getServerParametersValues($filter='')
{ {
$result=array(); $result=array();
@ -1335,11 +1340,12 @@ class DoliDBSqlite
return $result; return $result;
} }
/** /**
* \brief Return value of server status * Return value of server status
* \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 getServerStatusValues($filter='') function getServerStatusValues($filter='')
{ {
$result=array(); $result=array();