From b78900c613537ebe5a61660f624498eaf1f8499b Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sun, 17 Apr 2011 13:26:12 +0000 Subject: [PATCH] Doxygen and removed deprecated code --- htdocs/lib/databases/mssql.lib.php | 44 +++++++++++++-------------- htdocs/lib/databases/mysql.lib.php | 45 ++++++++++------------------ htdocs/lib/databases/mysqli.lib.php | 46 ++++++++++------------------- htdocs/lib/databases/pgsql.lib.php | 32 ++++++++++---------- 4 files changed, 70 insertions(+), 97 deletions(-) diff --git a/htdocs/lib/databases/mssql.lib.php b/htdocs/lib/databases/mssql.lib.php index 9be427cdc0c..3bc42a1fa4a 100644 --- a/htdocs/lib/databases/mssql.lib.php +++ b/htdocs/lib/databases/mssql.lib.php @@ -474,8 +474,8 @@ class DoliDb /** - \brief Libere le dernier resultset utilise sur cette connexion. - \param resultset Curseur de la requete voulue + * \brief Libere le dernier resultset utilise sur cette connexion. + * \param resultset Curseur de la requete voulue */ function free($resultset=0) { @@ -487,10 +487,10 @@ 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 + * \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 */ function plimit($limit=0,$offset=0) { @@ -532,9 +532,9 @@ class DoliDb /** - \brief Escape a string to insert data. - \param stringtoencode String to escape - \return string String escaped + * Escape a string to insert data. + * @param stringtoencode String to escape + * @return string String escaped */ function escape($stringtoencode) { @@ -543,10 +543,10 @@ class DoliDb /** - * \brief 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 + * 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 */ function idate($param) { @@ -554,10 +554,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function jdate($string) { @@ -568,11 +568,11 @@ class DoliDb } /** - * \brief Formatage d'un if SQL - * \param test chaine test - * \param resok resultat si test egal - * \param resko resultat si test non egal - * \return string chaine formate SQL + * Formate a SQL IF + * @param test chaine test + * @param resok resultat si test egal + * @param resko resultat si test non egal + * @return string chaine formate SQL */ function ifsql($test,$resok,$resko) { diff --git a/htdocs/lib/databases/mysql.lib.php b/htdocs/lib/databases/mysql.lib.php index 31449e3de88..c3e38186c9d 100644 --- a/htdocs/lib/databases/mysql.lib.php +++ b/htdocs/lib/databases/mysql.lib.php @@ -524,9 +524,9 @@ class DoliDb /** - * \brief Escape a string to insert data. - * \param stringtoencode String to escape - * \return string String escaped + * Escape a string to insert data. + * @param stringtoencode String to escape + * @return string String escaped */ function escape($stringtoencode) { @@ -535,23 +535,10 @@ class DoliDb /** - * Formatage (par la base de donnees) d'un champ de la base au format TMS ou Date (YYYY-MM-DD HH:MM:SS) - * afin de retourner une donnee toujours au format universel date TMS unix. - * Fonction a utiliser pour generer les SELECT. - * @param param Nom champ base de type date ou chaine 'YYYY-MM-DD HH:MM:SS' - * @return date Date au format TMS. - * @deprecated Remove unix_timestamp functions so use jdate instead - */ - function pdate($param) - { - return "unix_timestamp(".$param.")"; - } - - /** - * \brief 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 + * 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 */ function idate($param) { @@ -559,10 +546,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function jdate($string) { @@ -573,11 +560,11 @@ class DoliDb } /** - * \brief Formatage d'un if SQL - * \param test chaine test - * \param resok resultat si test egal - * \param resko resultat si test non egal - * \return string chaine formate SQL + * Formate a SQL IF + * @param test chaine test + * @param resok resultat si test egal + * @param resko resultat si test non egal + * @return string chaine formate SQL */ function ifsql($test,$resok,$resko) { diff --git a/htdocs/lib/databases/mysqli.lib.php b/htdocs/lib/databases/mysqli.lib.php index 552d8226795..75d8cfc6557 100644 --- a/htdocs/lib/databases/mysqli.lib.php +++ b/htdocs/lib/databases/mysqli.lib.php @@ -538,34 +538,20 @@ class DoliDb /** - * \brief Escape a string to insert data. - * \param stringtoencode String to escape - * \return string String escaped + * Escape a string to insert data. + * @param stringtoencode String to escape + * @return string String escaped */ function escape($stringtoencode) { return addslashes($stringtoencode); } - /** - * Formatage (par la base de donnees) d'un champ de la base au format TMS ou Date (YYYY-MM-DD HH:MM:SS) - * afin de retourner une donnee toujours au format universel date TMS unix. - * Fonction a utiliser pour generer les SELECT. - * @param param Nom champ base de type date ou chaine 'YYYY-MM-DD HH:MM:SS' - * @return date Date au format TMS. - * @deprecated Remove unix_timestamp functions so use jdate instead - */ - function pdate($param) - { - return "unix_timestamp(".$param.")"; - } - - /** - * \brief 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 + * 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 */ function idate($param) { @@ -573,10 +559,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function jdate($string) { @@ -587,11 +573,11 @@ class DoliDb } /** - * \brief Formatage d'un if SQL - * \param test chaine test - * \param resok resultat si test egal - * \param resko resultat si test non egal - * \return string chaine formatee SQL + * Formate a SQL IF + * @param test chaine test + * @param resok resultat si test egal + * @param resko resultat si test non egal + * @return string chaine formatee SQL */ function ifsql($test,$resok,$resko) { diff --git a/htdocs/lib/databases/pgsql.lib.php b/htdocs/lib/databases/pgsql.lib.php index 1a58ab07d57..6588faf1e87 100644 --- a/htdocs/lib/databases/pgsql.lib.php +++ b/htdocs/lib/databases/pgsql.lib.php @@ -680,9 +680,9 @@ class DoliDb /** - * \brief Escape a string to insert data. - * \param stringtoencode String to escape - * \return string String escaped + * Escape a string to insert data. + * @param stringtoencode String to escape + * @return string String escaped */ function escape($stringtoencode) { @@ -690,10 +690,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function idate($param) { @@ -701,10 +701,10 @@ class DoliDb } /** - * \brief 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 + * 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 */ function jdate($string) { @@ -715,11 +715,11 @@ class DoliDb } /** - * \brief Formatage d'un if SQL - * \param test chaine test - * \param resok resultat si test egal - * \param resko resultat si test non egal - * \return string chaine formate SQL + * Formate a SQL IF + * @param test chaine test + * @param resok resultat si test egal + * @param resko resultat si test non egal + * @return string chaine formate SQL */ function ifsql($test,$resok,$resko) {