Doxygen and removed deprecated code

This commit is contained in:
Laurent Destailleur 2011-04-17 13:26:12 +00:00
parent efd4dedfc9
commit b78900c613
4 changed files with 70 additions and 97 deletions

View File

@ -474,8 +474,8 @@ class DoliDb
/** /**
\brief Libere le dernier resultset utilise sur cette connexion. * \brief Libere le dernier resultset utilise sur cette connexion.
\param resultset Curseur de la requete voulue * \param resultset Curseur de la requete voulue
*/ */
function free($resultset=0) function free($resultset=0)
{ {
@ -487,10 +487,10 @@ class DoliDb
/** /**
\brief Defini les limites de la requete. * \brief Defini les limites de la requete.
\param limit nombre maximum de lignes retournees * \param limit nombre maximum de lignes retournees
\param offset numero de la ligne a partir de laquelle recuperer les ligne * \param 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)
{ {
@ -532,9 +532,9 @@ class DoliDb
/** /**
\brief Escape a string to insert data. * Escape a string to insert data.
\param stringtoencode String to escape * @param stringtoencode String to escape
\return string String escaped * @return string String escaped
*/ */
function escape($stringtoencode) 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. * 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 * Function to use to build INSERT, UPDATE or WHERE predica
* \param param Date TMS to convert * @param 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)
{ {
@ -554,10 +554,10 @@ class DoliDb
} }
/** /**
* \brief Convert (by PHP) a PHP server TZ string date into a GM Timestamps date * Convert (by PHP) a PHP server TZ string date into a GM Timestamps date
* 19700101020000 -> 3600 with TZ+1 * 19700101020000 -> 3600 with TZ+1
* \param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS) * @param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS)
* \return date Date TMS * @return date Date TMS
*/ */
function jdate($string) function jdate($string)
{ {
@ -568,11 +568,11 @@ class DoliDb
} }
/** /**
* \brief Formatage d'un if SQL * Formate a SQL IF
* \param test chaine test * @param test chaine test
* \param resok resultat si test egal * @param resok resultat si test egal
* \param resko resultat si test non egal * @param resko resultat si test non egal
* \return string chaine formate SQL * @return string chaine formate SQL
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {

View File

@ -524,9 +524,9 @@ class DoliDb
/** /**
* \brief Escape a string to insert data. * Escape a string to insert data.
* \param stringtoencode String to escape * @param stringtoencode String to escape
* \return string String escaped * @return string String escaped
*/ */
function escape($stringtoencode) 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) * Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field.
* afin de retourner une donnee toujours au format universel date TMS unix. * Function to use to build INSERT, UPDATE or WHERE predica
* Fonction a utiliser pour generer les SELECT. * @param param Date TMS to convert
* @param param Nom champ base de type date ou chaine 'YYYY-MM-DD HH:MM:SS' * @return string Date in a string YYYYMMDDHHMMSS
* @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
*/ */
function idate($param) function idate($param)
{ {
@ -559,10 +546,10 @@ class DoliDb
} }
/** /**
* \brief Convert (by PHP) a PHP server TZ string date into a GM Timestamps date * Convert (by PHP) a PHP server TZ string date into a GM Timestamps date
* 19700101020000 -> 3600 with TZ+1 * 19700101020000 -> 3600 with TZ+1
* \param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS) * @param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS)
* \return date Date TMS * @return date Date TMS
*/ */
function jdate($string) function jdate($string)
{ {
@ -573,11 +560,11 @@ class DoliDb
} }
/** /**
* \brief Formatage d'un if SQL * Formate a SQL IF
* \param test chaine test * @param test chaine test
* \param resok resultat si test egal * @param resok resultat si test egal
* \param resko resultat si test non egal * @param resko resultat si test non egal
* \return string chaine formate SQL * @return string chaine formate SQL
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {

View File

@ -538,34 +538,20 @@ class DoliDb
/** /**
* \brief Escape a string to insert data. * Escape a string to insert data.
* \param stringtoencode String to escape * @param stringtoencode String to escape
* \return string String escaped * @return string String escaped
*/ */
function escape($stringtoencode) function escape($stringtoencode)
{ {
return addslashes($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) * Convert (by PHP) a GM Timestamp date into a PHP server TZ to insert into a date field.
* afin de retourner une donnee toujours au format universel date TMS unix. * Function to use to build INSERT, UPDATE or WHERE predica
* Fonction a utiliser pour generer les SELECT. * @param param Date TMS to convert
* @param param Nom champ base de type date ou chaine 'YYYY-MM-DD HH:MM:SS' * @return string Date in a string YYYYMMDDHHMMSS
* @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
*/ */
function idate($param) function idate($param)
{ {
@ -573,10 +559,10 @@ class DoliDb
} }
/** /**
* \brief Convert (by PHP) a PHP server TZ string date into a GM Timestamps date * Convert (by PHP) a PHP server TZ string date into a GM Timestamps date
* 19700101020000 -> 3600 with TZ+1 * 19700101020000 -> 3600 with TZ+1
* \param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS) * @param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS)
* \return date Date TMS * @return date Date TMS
*/ */
function jdate($string) function jdate($string)
{ {
@ -587,11 +573,11 @@ class DoliDb
} }
/** /**
* \brief Formatage d'un if SQL * Formate a SQL IF
* \param test chaine test * @param test chaine test
* \param resok resultat si test egal * @param resok resultat si test egal
* \param resko resultat si test non egal * @param resko resultat si test non egal
* \return string chaine formatee SQL * @return string chaine formatee SQL
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {

View File

@ -680,9 +680,9 @@ class DoliDb
/** /**
* \brief Escape a string to insert data. * Escape a string to insert data.
* \param stringtoencode String to escape * @param stringtoencode String to escape
* \return string String escaped * @return string String escaped
*/ */
function escape($stringtoencode) 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. * 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 * Function to use to build INSERT, UPDATE or WHERE predica
* \param param Date TMS to convert * @param 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)
{ {
@ -701,10 +701,10 @@ class DoliDb
} }
/** /**
* \brief Convert (by PHP) a PHP server TZ string date into a GM Timestamps date * Convert (by PHP) a PHP server TZ string date into a GM Timestamps date
* 19700101020000 -> 3600 with TZ+1 * 19700101020000 -> 3600 with TZ+1
* \param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS) * @param string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS)
* \return date Date TMS * @return date Date TMS
*/ */
function jdate($string) function jdate($string)
{ {
@ -715,11 +715,11 @@ class DoliDb
} }
/** /**
* \brief Formatage d'un if SQL * Formate a SQL IF
* \param test chaine test * @param test chaine test
* \param resok resultat si test egal * @param resok resultat si test egal
* \param resko resultat si test non egal * @param resko resultat si test non egal
* \return string chaine formate SQL * @return string chaine formate SQL
*/ */
function ifsql($test,$resok,$resko) function ifsql($test,$resok,$resko)
{ {