diff --git a/htdocs/admin/menus/edit.php b/htdocs/admin/menus/edit.php index d9487e658de..df5d7c740f3 100644 --- a/htdocs/admin/menus/edit.php +++ b/htdocs/admin/menus/edit.php @@ -261,7 +261,7 @@ if ($action == 'create') if ($res) { - while ($menu = $db->fetch_array ($res)) + while ($menu = $db->fetch_array($res)) { $parent_rowid = $menu['rowid']; $parent_mainmenu = $menu['mainmenu']; diff --git a/htdocs/admin/menus/index.php b/htdocs/admin/menus/index.php index 9a72df931d8..c21503b15d2 100644 --- a/htdocs/admin/menus/index.php +++ b/htdocs/admin/menus/index.php @@ -300,7 +300,7 @@ if ($conf->use_javascript_ajax) $num = $db->num_rows($res); $i = 1; - while ($menu = $db->fetch_array ($res)) + while ($menu = $db->fetch_array($res)) { if (! empty($menu['langs'])) $langs->load($menu['langs']); $titre = $langs->trans($menu['titre']); diff --git a/htdocs/admin/menus/menu.js.php b/htdocs/admin/menus/menu.js.php index 89a04a11dee..8526569f1fc 100644 --- a/htdocs/admin/menus/menu.js.php +++ b/htdocs/admin/menus/menu.js.php @@ -32,7 +32,7 @@ if (! defined('NOREQUIREMENU')) define('NOREQUIREMENU',1); if (! defined('NOREQUIREHTML')) define('NOREQUIREHTML',1); if (! defined('NOREQUIREAJAX')) define('NOREQUIREAJAX','1'); -session_cache_limiter( FALSE ); +session_cache_limiter(FALSE); require_once("../../master.inc.php"); require_once(DOL_DOCUMENT_ROOT."/lib/functions.lib.php"); diff --git a/htdocs/admin/prelevement.php b/htdocs/admin/prelevement.php index 89ff251f65e..85b5ee9b08e 100644 --- a/htdocs/admin/prelevement.php +++ b/htdocs/admin/prelevement.php @@ -40,9 +40,11 @@ $action = GETPOST("action"); if ($action == "set") { + $db->begin(); for ($i = 0 ; $i < 2 ; $i++) { $res = dolibarr_set_const($db, $_POST["nom$i"], $_POST["value$i"],'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; } $id=$_POST["PRELEVEMENT_ID_BANKACCOUNT"]; @@ -51,23 +53,32 @@ if ($action == "set") if($account->fetch($id)>0) { $res = dolibarr_set_const($db, "PRELEVEMENT_ID_BANKACCOUNT", $id,'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; $res = dolibarr_set_const($db, "PRELEVEMENT_CODE_BANQUE", $account->code_banque,'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; $res = dolibarr_set_const($db, "PRELEVEMENT_CODE_GUICHET", $account->code_guichet,'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; $res = dolibarr_set_const($db, "PRELEVEMENT_NUMERO_COMPTE", $account->number,'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; $res = dolibarr_set_const($db, "PRELEVEMENT_NUMBER_KEY", $account->cle_rib,'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; $res = dolibarr_set_const($db, "PRELEVEMENT_IBAN", $account->iban,'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; $res = dolibarr_set_const($db, "PRELEVEMENT_BIC", $account->bic,'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; $res = dolibarr_set_const($db, "PRELEVEMENT_RAISON_SOCIALE", $account->proprio,'chaine',0,'',$conf->entity); + if (! $res > 0) $error++; } + else $error++; - if (! $res > 0) $error++; - if (! $error) { + $db->commit(); $mesg = "".$langs->trans("SetupSaved").""; } else { + $db->rollback(); $mesg = "".$langs->trans("Error").""; } } diff --git a/htdocs/lib/databases/mssql.lib.php b/htdocs/lib/databases/mssql.lib.php index 4f6a512cb35..7b8cc68f989 100644 --- a/htdocs/lib/databases/mssql.lib.php +++ b/htdocs/lib/databases/mssql.lib.php @@ -72,16 +72,18 @@ class DoliDb var $error; - /** - * Ouverture d'une connexion vers le serveur et eventuellement une database. - * @param type Type de base de donnees (mysql ou pgsql) - * @param host Addresse de la base de donnees - * @param user Nom de l'utilisateur autorise - * @param pass Mot de passe - * @param name Nom de la database - * @param port Port of database server - * @return int 1 en cas de succes, 0 sinon - */ + /** + * Constructor. + * This create an opened connexion to a database server and eventually to a database + * + * @param string $type Type of database (mysql, pgsql...) + * @param string $host Address of database server + * @param string $user Nom de l'utilisateur autorise + * @param string $pass Mot de passe + * @param string $name Nom de la database + * @param int $port Port of database server + * @return int 1 if OK, 0 if not + */ function DoliDb($type='mssql', $host, $user, $pass, $name='', $port=0) { global $conf,$langs; @@ -153,10 +155,11 @@ class DoliDb } /** - * Convert a SQL request in Mysql syntax to PostgreSQL syntax - * @param line SQL request line to convert - * @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) - * @return string SQL request line converted + * Convert a SQL request in Mysql syntax to native syntax + * + * @param string $line SQL request line to convert + * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) + * @return string SQL request line converted */ function convertSQLFromMysql($line,$type='ddl') { @@ -164,9 +167,10 @@ class DoliDb } /** - * Selectionne une database. - * @param database Nom de la database - * @return boolean true si ok, false si ko + * Select a database + * + * @param string $database Name of database + * @return boolean true if OK, false if KO */ function select_db($database) { @@ -174,14 +178,15 @@ class DoliDb } /** - * Connection vers le serveur - * @param host addresse de la base de donnees - * @param login nom de l'utilisateur autoris - * @param passwd mot de passe - * @param name nom de la database (ne sert pas sous mysql, sert sous pgsql) - * @param port Port of database server - * @return resource handler d'acces a la base - * @see close + * Connexion to server + * + * @param string $host database server host + * @param string $login login + * @param string $passwd password + * @param string $name name of database (not used for mysql, used for pgsql) + * @param string $port Port of database server + * @return resource Database access handler + * @see close */ function connect($host, $login, $passwd, $name, $port=0) { @@ -198,8 +203,9 @@ class DoliDb } /** - * \brief Return label of manager - * \return string Label + * Return label of manager + * + * @return string Label */ function getLabel() { @@ -207,8 +213,9 @@ class DoliDb } /** - * \brief Renvoie la version du serveur - * \return string Chaine version + * Return version of database server + * + * @return string Version string */ function getVersion() { @@ -219,8 +226,9 @@ class DoliDb /** - * \brief Renvoie la version du serveur dans un tableau - * \return array Tableau de chaque niveau de version + * Return version of database server into an array + * + * @return array Version array */ function getVersionArray() { @@ -230,6 +238,7 @@ class DoliDb /** * Close database connexion + * * @return boolean True if disconnect successfull, false otherwise * @see connect */ @@ -246,8 +255,9 @@ class DoliDb /** - * \brief Debut d'une transaction. - * \return int 1 si ouverture transaction ok ou deja ouverte, 0 en cas d'erreur + * Start transaction + * + * @return int 1 if transaction successfuly opened or already opened, 0 if error */ function begin() { @@ -270,10 +280,11 @@ class DoliDb /** * Validate a database transaction - * @param log Add more log to default log line + * + * @param $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() + function commit($log='') { if ($this->transaction_opened <= 1) { @@ -293,8 +304,9 @@ class DoliDb } /** - * \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 + * 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() { @@ -314,6 +326,7 @@ class DoliDb /** * Execute a SQL request and return the resultset + * * @param 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). * 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. @@ -404,9 +417,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function fetch_object($resultset) { @@ -416,9 +430,10 @@ class DoliDb } /** - * \brief Renvoie les donnees dans un tableau. - * \param resultset Curseur de la requete voulue - * \return array + * Renvoie les donnees dans un tableau + * + * @param resultset Curseur de la requete voulue + * @return array */ function fetch_array($resultset) { diff --git a/htdocs/lib/databases/mysql.lib.php b/htdocs/lib/databases/mysql.lib.php index 1b159d03ee5..3afd7d21782 100644 --- a/htdocs/lib/databases/mysql.lib.php +++ b/htdocs/lib/databases/mysql.lib.php @@ -72,14 +72,16 @@ class DoliDb /** - * Ouverture d'une connexion vers le serveur et eventuellement une database. - * @param type Type de base de donnees (mysql ou pgsql) - * @param host Addresse de la base de donnees - * @param user Nom de l'utilisateur autorise - * @param pass Mot de passe - * @param name Nom de la database - * @param port Port of database server - * @return int 1 en cas de succes, 0 sinon + * Constructor. + * This create an opened connexion to a database server and eventually to a database + * + * @param string $type Type of database (mysql, pgsql...) + * @param string $host Address of database server + * @param string $user Nom de l'utilisateur autorise + * @param string $pass Mot de passe + * @param string $name Nom de la database + * @param int $port Port of database server + * @return int 1 if OK, 0 if not */ function DoliDb($type='mysql', $host, $user, $pass, $name='', $port=0) { @@ -180,10 +182,11 @@ class DoliDb /** - * Convert a SQL request in Mysql syntax to PostgreSQL syntax - * @param line SQL request line to convert - * @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) - * @return string SQL request line converted + * Convert a SQL request in Mysql syntax to native syntax + * + * @param string $line SQL request line to convert + * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) + * @return string SQL request line converted */ function convertSQLFromMysql($line,$type='ddl') { @@ -191,9 +194,10 @@ class DoliDb } /** - * \brief Selectionne une database. - * \param database Nom de la database - * \return boolean true si ok, false si ko + * Select a database + * + * @param string $database Name of database + * @return boolean true if OK, false if KO */ function select_db($database) { @@ -202,14 +206,15 @@ class DoliDb } /** - * \brief Connexion to server - * \param host database server host - * \param login login - * \param passwd password - * \param name nom de la database (ne sert pas sous mysql, sert sous pgsql) - * \param port Port of database server - * \return resource Database access handler - * \seealso close + * Connexion to server + * + * @param string $host database server host + * @param string $login login + * @param string $passwd password + * @param string $name name of database (not used for mysql, used for pgsql) + * @param string $port Port of database server + * @return resource Database access handler + * @see close */ function connect($host, $login, $passwd, $name, $port=0) { @@ -227,8 +232,9 @@ class DoliDb } /** - * \brief Return label of manager - * \return string Label + * Return label of manager + * + * @return string Label */ function getLabel() { @@ -236,8 +242,9 @@ class DoliDb } /** - * \brief Renvoie la version du serveur - * \return string Chaine version + * Return version of database server + * + * @return string Version string */ function getVersion() { @@ -245,26 +252,9 @@ class DoliDb } /** - * \brief Renvoie la version du serveur sous forme de nombre - * \return string Chaine version - */ - function getIntVersion() - { - $version= $this->getVersion(); - $vlist=preg_split('/[.-]/',$version); - if (dol_strlen($vlist[1])==1){ - $vlist[1]="0".$vlist[1]; - } - if (dol_strlen($vlist[2])==1){ - $vlist[2]="0".$vlist[2]; - } - return $vlist[0].$vlist[1].$vlist[2]; - } - - - /** - * \brief Renvoie la version du serveur dans un tableau - * \return array Tableau de chaque niveau de version + * Return version of database server into an array + * + * @return array Version array */ function getVersionArray() { @@ -274,6 +264,7 @@ class DoliDb /** * Close database connexion + * * @return boolean True if disconnect successfull, false otherwise * @see connect */ @@ -290,8 +281,9 @@ class DoliDb /** - * \brief Debut d'une transaction. - * \return int 1 si ouverture transaction ok ou deja ouverte, 0 en cas d'erreur + * Start transaction + * + * @return int 1 if transaction successfuly opened or already opened, 0 if error */ function begin() { @@ -314,7 +306,8 @@ class DoliDb /** * Validate a database transaction - * @param log Add more log to default log line + * + * @param $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='') @@ -337,9 +330,10 @@ class DoliDb } /** - * \brief Annulation d'une transaction et retour aux anciennes valeurs - * \param log Add more log to default log line - * \return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur + * Annulation d'une transaction et retour aux anciennes valeurs + * + * @param $log Add more log to default log line + * @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur */ function rollback($log='') { @@ -359,6 +353,7 @@ class DoliDb /** * Execute a SQL request and return the resultset + * * @param 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). * 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. @@ -398,9 +393,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function fetch_object($resultset) { @@ -410,9 +406,10 @@ class DoliDb } /** - * \brief Renvoie les donnees dans un tableau. - * \param resultset Curseur de la requete voulue - * \return array + * Renvoie les donnees dans un tableau + * + * @param resultset Curseur de la requete voulue + * @return array */ function fetch_array($resultset) { @@ -423,9 +420,10 @@ class DoliDb /** - * \brief Renvoie les donnees comme un tableau. - * \param resultset Curseur de la requete voulue - * \return array + * Renvoie les donnees comme un tableau + * + * @param resultset Curseur de la requete voulue + * @return array */ function fetch_row($resultset) { @@ -435,10 +433,11 @@ class DoliDb } /** - * \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 + * 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) { @@ -448,10 +447,11 @@ class DoliDb } /** - * \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 + * 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) { @@ -464,8 +464,9 @@ class DoliDb /** - * \brief Libere le dernier resultset utilise sur cette connexion. - * \param resultset Curseur de la requete voulue + * Libere le dernier resultset utilise sur cette connexion. + * + * @param resultset Curseur de la requete voulue */ function free($resultset=0) { @@ -477,10 +478,11 @@ class DoliDb /** - * \brief 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 ligne - * \return string chaine exprimant la syntax sql de la limite + * 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 ligne + * @return string chaine exprimant la syntax sql de la limite */ function plimit($limit=0,$offset=0) { @@ -493,6 +495,7 @@ class DoliDb /** * 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 @@ -522,7 +525,8 @@ class DoliDb /** - * Escape a string to insert data. + * Escape a string to insert data + * * @param stringtoencode String to escape * @return string String escaped */ @@ -535,6 +539,7 @@ class DoliDb /** * 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 + * * @param param Date TMS to convert * @return string Date in a string YYYYMMDDHHMMSS */ @@ -546,6 +551,7 @@ class DoliDb /** * Convert (by PHP) a PHP server TZ string date into a GM Timestamps date * 19700101020000 -> 3600 with TZ+1 + * * @param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS) * @return date Date TMS */ @@ -559,6 +565,7 @@ class DoliDb /** * Formate a SQL IF + * * @param test chaine test * @param resok resultat si test egal * @param resko resultat si test non egal diff --git a/htdocs/lib/databases/mysqli.lib.php b/htdocs/lib/databases/mysqli.lib.php index fb33ea71c77..8af16e47efe 100644 --- a/htdocs/lib/databases/mysqli.lib.php +++ b/htdocs/lib/databases/mysqli.lib.php @@ -73,14 +73,16 @@ class DoliDb /** - * Ouverture d'une connexion vers le serveur et eventuellement une database. - * @param type Type de base de donnees (mysql ou pgsql) - * @param host Addresse de la base de donnees - * @param user Nom de l'utilisateur autorise - * @param pass Mot de passe - * @param name Nom de la database - * @param port Port of database server - * @return int 1 en cas de succes, 0 sinon + * Constructor. + * This create an opened connexion to a database server and eventually to a database + * + * @param string $type Type of database (mysql, pgsql...) + * @param string $host Address of database server + * @param string $user Nom de l'utilisateur autorise + * @param string $pass Mot de passe + * @param string $name Nom de la database + * @param int $port Port of database server + * @return int 1 if OK, 0 if not */ function DoliDb($type='mysqli', $host, $user, $pass, $name='', $port=0) { @@ -183,21 +185,23 @@ class DoliDb /** - * Convert a SQL request in Mysql syntax to PostgreSQL syntax - * @param line SQL request line to convert - * @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) - * @return string SQL request line converted + * Convert a SQL request in Mysql syntax to native syntax + * + * @param string $line SQL request line to convert + * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) + * @return string SQL request line converted */ function convertSQLFromMysql($line,$type='ddl') { return $line; } - /** - * \brief Selectionne une database. - * \param database Nom de la database - * \return boolean true si ok, false si ko - */ + /** + * Select a database + * + * @param string $database Name of database + * @return boolean true if OK, false if KO + */ function select_db($database) { dol_syslog("DoliDB::select_db database=".$database, LOG_DEBUG); @@ -206,14 +210,15 @@ class DoliDb /** - * \brief Connexion to server - * \param host database server host - * \param login login - * \param passwd password - * \param name nom de la database (ne sert pas sous mysql, sert sous pgsql) - * \param port Port of database server - * \return resource Database access handler - * \seealso close + * Connexion to server + * + * @param string $host database server host + * @param string $login login + * @param string $passwd password + * @param string $name name of database (not used for mysql, used for pgsql) + * @param string $port Port of database server + * @return resource Database access handler + * @see close */ function connect($host, $login, $passwd, $name, $port=0) { @@ -232,8 +237,9 @@ class DoliDb } /** - * \brief Return label of manager - * \return string Label + * Return label of manager + * + * @return string Label */ function getLabel() { @@ -241,8 +247,9 @@ class DoliDb } /** - * \brief Renvoie la version du serveur - * \return string Chaine version + * Return version of database server + * + * @return string Version string */ function getVersion() { @@ -252,27 +259,11 @@ class DoliDb return mysqli_get_server_info($this->db); } - /** - * \brief Renvoie la version du serveur sous forme de nombre - * \return string Chaine version - */ - function getIntVersion() - { - $version= $this->getVersion(); - $vlist=preg_split('/[.-]/',$version); - if (dol_strlen($vlist[1])==1){ - $vlist[1]="0".$vlist[1]; - } - if (dol_strlen($vlist[2])==1){ - $vlist[2]="0".$vlist[2]; - } - return $vlist[0].$vlist[1].$vlist[2]; - } - - /** - * \brief Renvoie la version du serveur dans un tableau - * \return array Tableau de chaque niveau de version - */ + /** + * Return version of database server into an array + * + * @return array Version array + */ function getVersionArray() { return explode('.',$this->getVersion()); @@ -280,9 +271,10 @@ class DoliDb /** - * Close database connexion - * @return boolean True if disconnect successfull, false otherwise - * @see connect + * Close database connexion + * + * @return boolean True if disconnect successfull, false otherwise + * @see connect */ function close() { @@ -297,8 +289,9 @@ class DoliDb /** - * \brief Debut d'une transaction. - * \return int 1 si ouverture transaction ok ou deja ouverte, 0 en cas d'erreur + * Start transaction + * + * @return int 1 if transaction successfuly opened or already opened, 0 if error */ function begin() { @@ -321,7 +314,8 @@ class DoliDb /** * Validate a database transaction - * @param log Add more log to default log line + * + * @param $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='') @@ -344,9 +338,10 @@ class DoliDb } /** - * \brief Annulation d'une transaction et retour aux anciennes valeurs - * \param log Add more log to default log line - * \return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur + * Annulation d'une transaction et retour aux anciennes valeurs + * + * @param $log Add more log to default log line + * @return int 1 si annulation ok ou transaction non ouverte, 0 en cas d'erreur */ function rollback($log='') { @@ -366,6 +361,7 @@ class DoliDb /** * Execute a SQL request and return the resultset + * * @param 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). * 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. @@ -403,9 +399,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function fetch_object($resultset) { @@ -416,9 +413,10 @@ class DoliDb /** - * \brief Renvoie les donnees dans un tableau. - * \param resultset Curseur de la requete voulue - * \return array + * Renvoie les donnees dans un tableau + * + * @param resultset Curseur de la requete voulue + * @return array */ function fetch_array($resultset) { @@ -428,9 +426,10 @@ class DoliDb } /** - * \brief Renvoie les donnees comme un tableau. - * \param resultset Curseur de la requete voulue - * \return array + * Renvoie les donnees comme un tableau + * + * @param resultset Curseur de la requete voulue + * @return array */ function fetch_row($resultset) { @@ -448,10 +447,11 @@ class DoliDb } /** - * \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 + * 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) { @@ -461,10 +461,10 @@ class DoliDb } /** - * \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 + * 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) @@ -478,8 +478,9 @@ class DoliDb /** - * \brief Libere le dernier resultset utilise sur cette connexion. - * \param resultset Curseur de la requete voulue + * Libere le dernier resultset utilise sur cette connexion + * + * @param resultset Curseur de la requete voulue */ function free($resultset=0) { @@ -491,10 +492,11 @@ class DoliDb /** - * \brief 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 ligne - * \return string chaine exprimant la syntax sql de la limite + * 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 ligne + * @return string chaine exprimant la syntax sql de la limite */ function plimit($limit=0,$offset=0) { @@ -507,6 +509,7 @@ class DoliDb /** * 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 @@ -536,7 +539,8 @@ class DoliDb /** - * Escape a string to insert data. + * Escape a string to insert data + * * @param stringtoencode String to escape * @return string String escaped */ @@ -548,6 +552,7 @@ class DoliDb /** * Convert (by PHP) a GM Timestamp date into a PHP server TZ to insert into a date field. * Function to use to build INSERT, UPDATE or WHERE predica + * * @param param Date TMS to convert * @return string Date in a string YYYYMMDDHHMMSS */ @@ -559,6 +564,7 @@ class DoliDb /** * Convert (by PHP) a PHP server TZ string date into a GM Timestamps date * 19700101020000 -> 3600 with TZ+1 + * * @param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS) * @return date Date TMS */ @@ -572,6 +578,7 @@ class DoliDb /** * Formate a SQL IF + * * @param test chaine test * @param resok resultat si test egal * @param resko resultat si test non egal diff --git a/htdocs/lib/databases/pgsql.lib.php b/htdocs/lib/databases/pgsql.lib.php index f0f2a0b4268..98723a7f989 100644 --- a/htdocs/lib/databases/pgsql.lib.php +++ b/htdocs/lib/databases/pgsql.lib.php @@ -62,14 +62,16 @@ class DoliDb /** - * \brief Ouverture d'une connexion vers le serveur et une database. - * \param type type de base de donnees (mysql ou pgsql) - * \param host addresse de la base de donnees - * \param user nom de l'utilisateur autorise - * \param pass mot de passe - * \param name nom de la database - * \param port Port of database server - * \return int 1 en cas de succes, 0 sinon + * Constructor. + * This create an opened connexion to a database server and eventually to a database + * + * @param string $type Type of database (mysql, pgsql...) + * @param string $host Address of database server + * @param string $user Nom de l'utilisateur autorise + * @param string $pass Mot de passe + * @param string $name Nom de la database + * @param int $port Port of database server + * @return int 1 if OK, 0 if not */ function DoliDb($type='pgsql', $host, $user, $pass, $name='', $port=0) { @@ -146,12 +148,13 @@ class DoliDb } - /** - * Convert a SQL request in Mysql syntax to PostgreSQL syntax - * @param line SQL request line to convert - * @param type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) - * @return string SQL request line converted - */ + /** + * Convert a SQL request in Mysql syntax to native syntax + * + * @param string $line SQL request line to convert + * @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) + * @return string SQL request line converted + */ function convertSQLFromMysql($line,$type='auto') { # Removed empty line if this is a comment line for SVN tagging @@ -321,11 +324,12 @@ class DoliDb } /** - * Select a database. - * Ici postgresql n'a aucune fonction equivalente de mysql_select_db - * On compare juste manuellement si la database choisie est bien celle activee par la connexion - * @param database nom de la database - * @return boolean true si ok, false si ko + * Select a database + * Ici postgresql n'a aucune fonction equivalente de mysql_select_db + * On compare juste manuellement si la database choisie est bien celle activee par la connexion + * + * @param string $database Name of database + * @return boolean true if OK, false if KO */ function select_db($database) { @@ -334,13 +338,15 @@ class DoliDb } /** - * Connection vers le serveur - * @param host addresse de la base de donnees - * @param login nom de l'utilisateur autorise - * @param passwd mot de passe - * @param name nom de la database (ne sert pas sous mysql, sert sous pgsql) - * @param port Port of database server - * @return resource handler d'acces a la base + * Connexion to server + * + * @param string $host database server host + * @param string $login login + * @param string $passwd password + * @param string $name name of database (not used for mysql, used for pgsql) + * @param string $port Port of database server + * @return resource Database access handler + * @see close */ function connect($host, $login, $passwd, $name, $port=0) { @@ -364,8 +370,9 @@ class DoliDb } /** - * \brief Return label of manager - * \return string Label + * Return label of manager + * + * @return string Label */ function getLabel() { @@ -373,8 +380,9 @@ class DoliDb } /** - * \brief Return version of server - * \return string String with version + * Return version of database server + * + * @return string Version string */ function getVersion() { @@ -388,25 +396,9 @@ class DoliDb } /** - * \brief Renvoie la version du serveur sous forme de nombre - * \return string Chaine version - */ - function getIntVersion() - { - $version = $this->getVersion(); - $vlist = preg_split('/[.-]/',$version); - if (dol_strlen($vlist[1])==1){ - $vlist[1]="0".$vlist[1]; - } - if (dol_strlen($vlist[2])==1){ - $vlist[2]="0".$vlist[2]; - } - return $vlist[0].$vlist[1].$vlist[2]; - } - - /** - * \brief Renvoie la version du serveur dans un tableau - * \return array Tableau de chaque niveau de version + * Return version of database server into an array + * + * @return array Version array */ function getVersionArray() { @@ -415,6 +407,7 @@ class DoliDb /** * Close database connexion + * * @return boolean True if disconnect successfull, false otherwise * @see connect */ @@ -430,8 +423,9 @@ class DoliDb } /** - * \brief Debut d'une transaction. - * \return int 1 si ouverture transaction ok ou deja ouverte, 0 en cas d'erreur + * Start transaction + * + * @return int 1 if transaction successfuly opened or already opened, 0 if error */ function begin() { @@ -454,6 +448,7 @@ class DoliDb /** * 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 */ @@ -477,8 +472,8 @@ class DoliDb } /** - * \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 + * 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() { @@ -498,7 +493,8 @@ class DoliDb /** - * 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 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...) @@ -555,9 +551,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function fetch_object($resultset) { @@ -567,9 +564,10 @@ class DoliDb } /** - * \brief Renvoie les donnees dans un tableau. - * \param resultset Curseur de la requete voulue - * \return array + * Renvoie les donnees dans un tableau + * + * @param resultset Curseur de la requete voulue + * @return array */ function fetch_array($resultset) { @@ -579,9 +577,10 @@ class DoliDb } /** - * \brief Renvoie les donnees comme un tableau. - * \param resultset Curseur de la requete voulue - * \return array + * Renvoie les donnees comme un tableau + * + * @param resultset Curseur de la requete voulue + * @return array */ function fetch_row($resultset) { @@ -591,10 +590,11 @@ class DoliDb } /** - * \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 + * 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) { @@ -604,10 +604,11 @@ class DoliDb } /** - * \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 + * 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) { @@ -620,8 +621,9 @@ class DoliDb /** - * \brief Libere le dernier resultset utilise sur cette connexion. - * \param resultset Curseur de la requete voulue + * Libere le dernier resultset utilise sur cette connexion + * + * @param resultset Curseur de la requete voulue */ function free($resultset=0) { @@ -633,10 +635,11 @@ class DoliDb /** - * \brief 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 + * 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 */ function plimit($limit=0,$offset=0) { @@ -649,6 +652,7 @@ class DoliDb /** * 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 @@ -678,7 +682,8 @@ class DoliDb /** - * Escape a string to insert data. + * Escape a string to insert data + * * @param stringtoencode String to escape * @return string String escaped */ @@ -690,6 +695,7 @@ class DoliDb /** * Convert (by PHP) a GM Timestamp date into a GM string date to insert into a date field. * Function to use to build INSERT, UPDATE or WHERE predica + * * @param param Date TMS to convert * @return string Date in a string YYYYMMDDHHMMSS */ @@ -701,6 +707,7 @@ class DoliDb /** * Convert (by PHP) a PHP server TZ string date into a GM Timestamps date * 19700101020000 -> 3600 with TZ+1 + * * @param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS) * @return date Date TMS */ @@ -714,6 +721,7 @@ class DoliDb /** * Formate a SQL IF + * * @param test chaine test * @param resok resultat si test egal * @param resko resultat si test non egal @@ -726,8 +734,9 @@ class DoliDb /** - * \brief Renvoie la derniere requete soumise par la methode query() - * \return lastquery + * Renvoie la derniere requete soumise par la methode query() + * + * @return lastquery */ function lastquery() { @@ -735,8 +744,9 @@ class DoliDb } /** - * \brief Renvoie la derniere requete en erreur - * \return string lastqueryerror + * Renvoie la derniere requete en erreur + * + * @return string lastqueryerror */ function lastqueryerror() { @@ -744,8 +754,9 @@ class DoliDb } /** - * \brief Renvoie le libelle derniere erreur - * \return string lasterror + * Renvoie le libelle derniere erreur + * + * @return string lasterror */ function lasterror() { @@ -753,8 +764,9 @@ class DoliDb } /** - * \brief Renvoie le code derniere erreur - * \return string lasterrno + * Renvoie le code derniere erreur + * + * @return string lasterrno */ function lasterrno() { @@ -762,8 +774,9 @@ class DoliDb } /** - * \brief Renvoie le code erreur generique de l'operation precedente. - * \return error_num (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...) + * Renvoie le code erreur generique de l'operation precedente. + * + * @return error_num (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...) */ function errno() { @@ -827,8 +840,9 @@ class DoliDb } /** - * \brief Renvoie le texte de l'erreur pgsql de l'operation precedente. - * \return error_text + * Renvoie le texte de l'erreur pgsql de l'operation precedente + * + * @return error_text */ function error() { @@ -836,9 +850,10 @@ class DoliDb } /** - * \brief Get last ID after an insert INSERT. - * \param tab Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql - * \return int id + * Get last ID after an insert INSERT + * + * @param tab Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql + * @return int id */ function last_insert_id($tab,$fieldid='rowid') { @@ -857,6 +872,7 @@ class DoliDb /** * Encrypt sensitive data in database * 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 * @return return XXX(field) or XXX('value') or field or 'value' @@ -877,9 +893,10 @@ class DoliDb /** - * \brief Decrypt sensitive data in database - * \param value Value to decrypt - * \return return Decrypted value if used + * Decrypt sensitive data in database + * + * @param value Value to decrypt + * @return return Decrypted value if used */ function decrypt($value) { @@ -901,8 +918,9 @@ class DoliDb /** - * \brief Renvoie l'id de la connexion - * \return string Id connexion + * Renvoie l'id de la connexion + * + * @return string Id connexion */ function DDLGetConnectId() { @@ -912,13 +930,14 @@ class DoliDb /** - * \brief Create a new database - * \param database Database name to create - * \param charset Charset used to store data - * \param collation Charset used to sort data - * \param owner Username of database owner - * \return resource resource defined if OK, null if KO - * \remarks Ne pas utiliser les fonctions xxx_create_db (xxx=mysql, ...) car elles sont deprecated + * Create a new database + * Ne pas utiliser les fonctions xxx_create_db (xxx=mysql, ...) car elles sont deprecated + * + * @param database Database name to create + * @param charset Charset used to store data + * @param collation Charset used to sort data + * @param owner Username of database owner + * @return resource resource defined if OK, null if KO */ function DDLCreateDb($database,$charset='',$collation='',$owner='') { @@ -930,9 +949,9 @@ class DoliDb } /** - * \brief Liste des tables dans une database. - * \param database Nom de la database - * \return resource + * Liste des tables dans une database. + * @param database Nom de la database + * @return resource */ function DDLListTables($database, $table='') { @@ -949,9 +968,9 @@ class DoliDb } /** - * \brief Liste les informations des champs d'une table. - * \param table Nom de la table - * \return array Tableau des informations des champs de la table + * Liste les informations des champs d'une table. + * @param table Nom de la table + * @return array Tableau des informations des champs de la table * TODO modifier pour postgresql */ function DDLInfoTable($table) @@ -973,15 +992,16 @@ class DoliDb /** - * \brief Cree une table - * \param table Nom de la table - * \param fields Tableau associatif [nom champ][tableau des descriptions] - * \param primary_key Nom du champ qui sera la clef primaire - * \param unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur - * \param fulltext Tableau des Nom de champs qui seront indexes en fulltext - * \param key Tableau des champs cles noms => valeur - * \param type Type de la table - * \return int <0 si KO, >=0 si OK + * Cree une table + * + * @param table Nom de la table + * @param fields Tableau associatif [nom champ][tableau des descriptions] + * @param primary_key Nom du champ qui sera la clef primaire + * @param unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur + * @param fulltext Tableau des Nom de champs qui seront indexes en fulltext + * @param key Tableau des champs cles noms => valeur + * @param type Type de la table + * @return int <0 si KO, >=0 si OK * TODO */ function DDLCreateTable($table,$fields,$primary_key,$type,$unique_keys="",$fulltext_keys="",$keys="") @@ -1050,12 +1070,13 @@ class DoliDb } /** - * \brief Create a user - * \param dolibarr_main_db_host Ip serveur - * \param dolibarr_main_db_user Nom user a creer - * \param dolibarr_main_db_pass Mot de passe user a creer - * \param dolibarr_main_db_name Database name where user must be granted - * \return int <0 si KO, >=0 si OK + * Create a user + * + * @param dolibarr_main_db_host Ip serveur + * @param dolibarr_main_db_user Nom user a creer + * @param dolibarr_main_db_pass Mot de passe user a creer + * @param dolibarr_main_db_name Database name where user must be granted + * @return int <0 si KO, >=0 si OK */ function DDLCreateUser($dolibarr_main_db_host,$dolibarr_main_db_user,$dolibarr_main_db_pass,$dolibarr_main_db_name) { @@ -1072,10 +1093,11 @@ class DoliDb } /** - * \brief decrit une table dans une database. - * \param table Nom de la table - * \param field Optionnel : Nom du champ si l'on veut la desc d'un champ - * \return resource + * Decrit une table dans une database + * + * @param table Nom de la table + * @param field Optionnel : Nom du champ si l'on veut la desc d'un champ + * @return resource */ function DDLDescTable($table,$field="") { @@ -1089,12 +1111,13 @@ class DoliDb } /** - * \brief Insert a new field in table - * \param table Nom de la table - * \param field_name Nom du champ a inserer - * \param field_desc Tableau associatif de description du champ a inserer[nom du parametre][valeur du parametre] - * \param field_position Optionnel ex.: "after champtruc" - * \return int <0 si KO, >0 si OK + * Insert a new field in table + * + * @param table Nom de la table + * @param field_name Nom du champ a inserer + * @param field_desc Tableau associatif de description du champ a inserer[nom du parametre][valeur du parametre] + * @param field_position Optionnel ex.: "after champtruc" + * @return int <0 si KO, >0 si OK */ function DDLAddField($table,$field_name,$field_desc,$field_position="") { @@ -1126,6 +1149,7 @@ class DoliDb /** * Update format of a field into a table + * * @param table Name of table * @param field_name Name of field to modify * @param field_desc Array with description of field format @@ -1145,10 +1169,11 @@ class DoliDb } /** - * \brief Drop a field in table - * \param table Nom de la table - * \param field_name Nom du champ a inserer - * \return int <0 si KO, >0 si OK + * Drop a field in table + * + * @param table Nom de la table + * @param field_name Nom du champ a inserer + * @return int <0 si KO, >0 si OK */ function DDLDropField($table,$field_name) { @@ -1163,8 +1188,9 @@ class DoliDb } /** - * \brief Return charset used to store data in database - * \return string Charset + * Return charset used to store data in database + * + * @return string Charset */ function getDefaultCharacterSetDatabase() { @@ -1174,8 +1200,9 @@ class DoliDb } /** - * \brief Return list of available charset that can be used to store data in database - * \return array List of Charset + * Return list of available charset that can be used to store data in database + * + * @return array List of Charset */ function getListOfCharacterSet() { @@ -1198,8 +1225,9 @@ class DoliDb } /** - * \brief Return collation used in database - * \return string Collation value + * Return collation used in database + * + * @return string Collation value */ function getDefaultCollationDatabase() { @@ -1209,8 +1237,9 @@ class DoliDb } /** - * \brief Return list of available collation that can be used for database - * \return array Liste of Collation + * Return list of available collation that can be used for database + * + * @return array Liste of Collation */ function getListOfCollation() { @@ -1233,6 +1262,7 @@ class DoliDb /** * Return full path of dump program + * * @return string Full path of dump program */ function getPathOfDump() @@ -1260,6 +1290,7 @@ class DoliDb /** * Return full path of restore program + * * @return string Full path of restore program */ function getPathOfRestore() @@ -1286,9 +1317,10 @@ class DoliDb } /** - * \brief Return value of server parameters - * \param filter Filter list on a particular value - * \return string Value for parameter + * Return value of server parameters + * + * @param filter Filter list on a particular value + * @return string Value for parameter */ function getServerParametersValues($filter='') { diff --git a/htdocs/lib/functions.lib.php b/htdocs/lib/functions.lib.php index dc6d61a208e..afb4aea298c 100644 --- a/htdocs/lib/functions.lib.php +++ b/htdocs/lib/functions.lib.php @@ -58,10 +58,10 @@ function dol_shutdown() /** * Return value of a param into GET or POST supervariable * - * @param paramname Name of parameter to found - * @param check Type of check (''=no check, 'int'=check it's numeric, 'alpha'=check it's alpha only) - * @param method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get) - * @return string Value found or '' if check fails + * @param string $paramname Name of parameter to found + * @param string $check Type of check (''=no check, 'int'=check it's numeric, 'alpha'=check it's alpha only) + * @param int $method Type of method (0 = get then post, 1 = only get, 2 = only post, 3 = post then get) + * @return string Value found or '' if check fails */ function GETPOST($paramname,$check='',$method=0) { @@ -88,7 +88,7 @@ function GETPOST($paramname,$check='',$method=0) * This prefix is unique for instance and avoid conflict between multi-instances, * even when having two instances with one root dir or two instances in virtual servers * - * @return string A calculated prefix + * @return string A calculated prefix */ function dol_getprefix() { @@ -102,8 +102,8 @@ function dol_getprefix() * To link to a module file from a module file, use include('./mymodulefile'); * To link to a module file from a core file, then this function can be used * - * @param relpath Relative path to file (Ie: mydir/myfile, ../myfile, ...) - * @return int false if include fails. + * @param string $relpath Relative path to file (Ie: mydir/myfile, ../myfile, ...) + * @return int false if include fails. */ function dol_include_once($relpath) { @@ -115,9 +115,9 @@ function dol_include_once($relpath) /** * Return path of url or filesystem. Return default_root or alternate root if file_exist fails * - * @param path Relative path to file (if mode=0, ie: mydir/myfile, ../myfile, ...) or relative url (if mode=1). - * @param type 0=Used for a Filesystem path, 1=Used for an URL path (output relative), 2=Used for an URL path (output full path) - * @return string Full filsystem path (if mode=0), Full url path (if mode=1) + * @param string $path Relative path to file (if mode=0, ie: mydir/myfile, ../myfile, ...) or relative url (if mode=1). + * @param int $type 0=Used for a Filesystem path, 1=Used for an URL path (output relative), 2=Used for an URL path (output full path) + * @return string Full filsystem path (if mode=0), Full url path (if mode=1) */ function dol_buildpath($path,$type=0) { @@ -168,8 +168,8 @@ function dol_buildpath($path,$type=0) * Create a clone of instance of object (new instance with same properties) * This function works for both PHP4 and PHP5 * - * @param object Object to clone - * @return date Timestamp + * @param object $object Object to clone + * @return object Object clone */ function dol_clone($object) { @@ -187,11 +187,11 @@ function dol_clone($object) /** * Optimize a size for some browsers (phone, smarphone, ...) * - * @param size Size we want - * @param type Type of optimizing: - * '' = function used to define a size for truncation - * 'width' = function is used to define a width - * @return int New size after optimizing + * @param int $size Size we want + * @param string $type Type of optimizing: + * '' = function used to define a size for truncation + * 'width' = function is used to define a width + * @return int New size after optimizing */ function dol_size($size,$type='') { @@ -318,8 +318,8 @@ function dol_string_nospecial($str,$newstr='_',$badchars='') /** * Returns text escaped for inclusion into javascript code * - * @param $stringtoescape String to escape - * @return string Escaped string + * @param string $stringtoescape String to escape + * @return string Escaped string */ function dol_escape_js($stringtoescape) { @@ -332,9 +332,9 @@ function dol_escape_js($stringtoescape) /** * Returns text escaped for inclusion in HTML alt or title tags * - * @param $stringtoescape String to escape - * @param $keepb Do not clean b tags - * @return string Escaped string + * @param string $stringtoescape String to escape + * @param int $keepb Do not clean b tags + * @return string Escaped string */ function dol_escape_htmltag($stringtoescape,$keepb=0) { @@ -358,8 +358,8 @@ function dol_escape_htmltag($stringtoescape,$keepb=0) * On Windows LOG_ERR=4, LOG_WARNING=5, LOG_NOTICE=LOG_INFO=6, LOG_DEBUG=6 si define_syslog_variables ou PHP 5.3+, 7 si dolibarr * On Linux LOG_ERR=3, LOG_WARNING=4, LOG_INFO=6, LOG_DEBUG=7 * - * @param string message Line to log. Ne doit pas etre traduit si level = LOG_ERR - * @param int level Log level + * @param string $message Line to log. Ne doit pas etre traduit si level = LOG_ERR + * @param int $level Log level */ function dol_syslog($message, $level=LOG_INFO) { @@ -469,6 +469,7 @@ function dol_syslog($message, $level=LOG_INFO) /** * Show tab header of a card + * * @param links Array of tabs * @param active Active tab name * @param title Title @@ -482,6 +483,7 @@ function dol_fiche_head($links=array(), $active='0', $title='', $notab=0, $picto /** * Show tab header of a card + * * @param links Array of tabs * @param active Active tab name * @param title Title @@ -548,7 +550,8 @@ function dol_get_fiche_head($links=array(), $active='0', $title='', $notab=0, $p /** * Show tab footer of a card - * @param notab 0=Add tab footer, 1=no tab footer + * + * @param int $notab 0=Add tab footer, 1=no tab footer */ function dol_fiche_end($notab=0) { @@ -557,7 +560,8 @@ function dol_fiche_end($notab=0) /** * Return tab footer of a card - * @param notab 0=Add tab footer, 1=no tab footer + * + * @param int $notab 0=Add tab footer, 1=no tab footer */ function dol_get_fiche_end($notab=0) { @@ -574,7 +578,8 @@ function dolibarr_print_date($time,$format='',$to_gmt=false,$outputlangs='',$enc /** * Output date in a string format according to outputlangs (or langs if not defined). - * Return charset is always UTF-8, except if encodetoouput is defined. In this cas charset is output charset. + * Return charset is always UTF-8, except if encodetoouput is defined. In this cas charset is output charset + * * @param time GM Timestamps date (or deprecated strings 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS') * @param format Output date format * "%d %b %Y", @@ -721,6 +726,7 @@ function dol_print_date($time,$format='',$tzoutput='tzserver',$outputlangs='',$e /** * Convert a string date into a GM Timestamps date + * * @param string Date in a string * YYYYMMDD * YYYYMMDDHHMMSS @@ -771,7 +777,8 @@ function dol_stringtotime($string, $gm=1) /** * Return an array with date info - * PHP getdate is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows. + * PHP getdate is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows + * * @param timestamp Timestamp * @param fast Fast mode * @return array Array of informations @@ -825,6 +832,7 @@ function dolibarr_mktime($hour,$minute,$second,$month,$day,$year,$gm=false,$chec * Return a timestamp date built from detailed informations (by default a local PHP server timestamp) * Replace function mktime not available under Windows if year < 1970 * PHP mktime is restricted to the years 1901-2038 on Unix and 1970-2038 on Windows + * * @param hour Hour (can be -1 for undefined) * @param minute Minute (can be -1 for undefined) * @param second Second (can be -1 for undefined) @@ -890,6 +898,7 @@ function dolibarr_date($fmt, $timestamp, $gm=false) /** * Returns formated date + * * @param fmt Format (Exemple: 'Y-m-d H:i:s') * @param timestamp Date. Example: If timestamp=0 and gm=1, return 01/01/1970 00:00:00 * @param gm 1 if timestamp was built with gmmktime, 0 if timestamp was build with mktime @@ -917,6 +926,7 @@ function dol_date($fmt, $timestamp, $gm=false) /** * Return string with formated size + * * @param size Size to print * @param shortvalue Tell if we want long value to use another unit (Ex: 1.5Kb instead of 1500b) * @param shortunit Use short value of size unit @@ -949,6 +959,7 @@ function dol_print_size($size,$shortvalue=0,$shortunit=0) /** * Show Url link + * * @param url Url to show * @param target Target for link * @param max Max number of characters to show @@ -970,6 +981,7 @@ function dol_print_url($url,$target='_blank',$max=32) /** * Show EMail link + * * @param email EMail to show (only email, without 'Name of recipient' before) * @param cid Id of contact if known * @param socid Id of third party if known @@ -1026,6 +1038,7 @@ function dolibarr_print_phone($phone,$country="FR",$cid=0,$socid=0,$addlink=0,$s /** * Format phone numbers according to country + * * @param phone Phone number to format * @param country Country to use for formatting * @param cid Id of contact if known @@ -1104,6 +1117,7 @@ function dol_print_phone($phone,$country="FR",$cid=0,$socid=0,$addlink=0,$separ= /** * Return an IP formated to be shown on screen + * * @param ip IP * @param mode 1=return only country/flag,2=return only IP * @return string Formated IP, with country if GeoIP module is enabled @@ -1143,6 +1157,7 @@ function dol_print_ip($ip,$mode=0) /** * Return country code for current user. * If software is used inside a local network, detection may fails (we need a public ip) + * * @return string country code (fr, es, it, us, ...) */ function dol_user_country() @@ -1167,6 +1182,7 @@ function dol_user_country() /** * Format address string + * * @param address Address * @param htmlid Html ID * @param mode thirdparty|contact|member|other @@ -1212,9 +1228,10 @@ function dol_print_address($address, $htmlid='gmap', $mode, $id) /** - * Return true if email syntax is ok. - * @param address email (Ex: "toto@titi.com", "John Do ") - * @return boolean true if email syntax is OK, false if KO or empty string + * Return true if email syntax is ok + * + * @param string $address email (Ex: "toto@titi.com", "John Do ") + * @return boolean true if email syntax is OK, false if KO or empty string */ function isValidEmail($address) { @@ -1234,9 +1251,10 @@ function isValidEmail($address) } /** - * Return true if phone number syntax is ok. - * @param address phone (Ex: "0601010101") - * @return boolean true if phone syntax is OK, false if KO or empty string + * Return true if phone number syntax is ok + * + * @param string $address phone (Ex: "0601010101") + * @return boolean true if phone syntax is OK, false if KO or empty string */ function isValidPhone($address) { @@ -1245,10 +1263,11 @@ function isValidPhone($address) /** - * Make a strlen call. Works even if mbstring module not enabled. - * @param $string - * @param $stringencoding - * @return int + * Make a strlen call. Works even if mbstring module not enabled + * + * @param string $string String to calculate length + * @param string $stringencoding Encoding of string + * @return int Length of string */ function dol_strlen($string,$stringencoding='UTF-8') { @@ -1260,6 +1279,7 @@ function dol_strlen($string,$stringencoding='UTF-8') /** * Make a substring. Works even in mbstring module not enabled + * * @param $string * @param $start * @param $length @@ -2566,9 +2586,9 @@ function getTitleFieldOfList($name, $thead=0, $file="", $field="", $begin="", $m { global $conf; //print "$name, $file, $field, $begin, $options, $td, $sortfield, $sortorder
\n"; - + $out=''; - + if ($thead) { $out.= ''.$name.''; @@ -2586,7 +2606,7 @@ function getTitleFieldOfList($name, $thead=0, $file="", $field="", $begin="", $m $out.= ''; } $out.= $name; - + // If this is a sort field if ($field) { @@ -2594,7 +2614,7 @@ function getTitleFieldOfList($name, $thead=0, $file="", $field="", $begin="", $m $options=preg_replace('/sortorder=([a-zA-Z0-9,\s\.]+)/i','',$options); $options=preg_replace('/&+/i','&',$options); if (! preg_match('/^&/',$options)) $options='&'.$options; - + //print " "; $out.= ''; if (! $sortorder) @@ -2624,7 +2644,7 @@ function getTitleFieldOfList($name, $thead=0, $file="", $field="", $begin="", $m } $out.= ""; } - + return $out; }