From 0cf89eac08baca1a47b996f988372e945fcdd522 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Sat, 8 Sep 2012 02:17:08 +0200 Subject: [PATCH] Doxygen --- htdocs/admin/tools/export.php | 1 - .../class/bonprelevement.class.php | 8 +++--- .../class/rejetprelevement.class.php | 4 +-- .../class/fournisseur.commande.class.php | 6 +++-- .../fourn/class/fournisseur.facture.class.php | 2 ++ .../mailmanspip/class/mailmanspip.class.php | 22 +++++++++------- htdocs/public/members/new.php | 26 +++++++++---------- 7 files changed, 38 insertions(+), 31 deletions(-) diff --git a/htdocs/admin/tools/export.php b/htdocs/admin/tools/export.php index bdf62f5f65b..ee5edc7ddb9 100644 --- a/htdocs/admin/tools/export.php +++ b/htdocs/admin/tools/export.php @@ -372,7 +372,6 @@ $db->close(); /** Backup the db OR just a table without mysqldump binary (does not require any exec permission) * Author: David Walsh (http://davidwalsh.name/backup-mysql-database-php) * Updated and enhanced by Stephen Larroque (lrq3000) and by the many commentators from the blog - * * Note about foreign keys constraints: for Dolibarr, since there are a lot of constraints and when imported the tables will be inserted in the dumped order, not in constraints order, then we ABSOLUTELY need to use SET FOREIGN_KEY_CHECKS=0; when importing the sql dump. * Note2: db2SQL by Howard Yeend can be an alternative, by using SHOW FIELDS FROM and SHOW KEYS FROM we could generate a more precise dump (eg: by getting the type of the field and then precisely outputting the right formatting - in quotes, numeric or null - instead of trying to guess like we are doing now). * diff --git a/htdocs/compta/prelevement/class/bonprelevement.class.php b/htdocs/compta/prelevement/class/bonprelevement.class.php index f9727792638..0081af46ecf 100644 --- a/htdocs/compta/prelevement/class/bonprelevement.class.php +++ b/htdocs/compta/prelevement/class/bonprelevement.class.php @@ -340,7 +340,7 @@ class BonPrelevement extends CommonObject if ($error == 0) { $facs = array(); - $facs = $this->_get_list_factures(); + $facs = $this->getListInvoices(); $num=count($facs); for ($i = 0; $i < $num; $i++) @@ -429,7 +429,7 @@ class BonPrelevement extends CommonObject $facs = array(); $amounts = array(); - $facs = $this->_get_list_factures(); + $facs = $this->getListInvoices(); $num=count($facs); for ($i = 0; $i < $num; $i++) @@ -587,7 +587,7 @@ class BonPrelevement extends CommonObject * * @return array id of invoices */ - private function _get_list_factures() + private function getListInvoices() { global $conf; @@ -625,7 +625,7 @@ class BonPrelevement extends CommonObject } else { - dol_syslog(get_class($this)."::_get_list_factures Erreur"); + dol_syslog(get_class($this)."::getListInvoices Erreur"); } return $arr; diff --git a/htdocs/compta/prelevement/class/rejetprelevement.class.php b/htdocs/compta/prelevement/class/rejetprelevement.class.php index dfcf992f2b6..df03cf4aa9f 100644 --- a/htdocs/compta/prelevement/class/rejetprelevement.class.php +++ b/htdocs/compta/prelevement/class/rejetprelevement.class.php @@ -87,7 +87,7 @@ class RejetPrelevement dol_syslog("RejetPrelevement::Create id $id"); $bankaccount = $conf->global->PRELEVEMENT_ID_BANKACCOUNT; - $facs = $this->_get_list_factures(); + $facs = $this->getListInvoices(); $this->db->begin(); @@ -272,7 +272,7 @@ class RejetPrelevement * * @return void */ - private function _get_list_factures() + private function getListInvoices() { global $conf; diff --git a/htdocs/fourn/class/fournisseur.commande.class.php b/htdocs/fourn/class/fournisseur.commande.class.php index e4cd29813db..1feea724fa3 100644 --- a/htdocs/fourn/class/fournisseur.commande.class.php +++ b/htdocs/fourn/class/fournisseur.commande.class.php @@ -1010,6 +1010,7 @@ class CommandeFournisseur extends CommonOrder * @param double $pu_ttc Unit price TTC * @param int $type Type of line (0=product, 1=service) * @param int $info_bits More information + * @param int $notrigger Disable triggers * @return int <=0 if KO, >0 if OK */ function addline($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $fk_prod_fourn_price=0, $fourn_ref='', $remise_percent=0, $price_base_type='HT', $pu_ttc=0, $type=0, $info_bits=0, $notrigger=false) @@ -1596,6 +1597,7 @@ class CommandeFournisseur extends CommonOrder * @param double $price_base_type Type of price base * @param int $info_bits Miscellanous informations * @param int $type Type of line (0=product, 1=service) + * @param int $notrigger Disable triggers * @return int < 0 if error, > 0 if ok */ function updateline($rowid, $desc, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0, $txlocaltax2=0, $price_base_type='HT', $info_bits=0, $type=0, $notrigger=false) @@ -1844,7 +1846,7 @@ class CommandeFournisseur extends CommonOrder /** * Returns the translated input method - * + * * @return string */ function getInputMethod() @@ -1872,7 +1874,7 @@ class CommandeFournisseur extends CommonOrder return $string; } - + dol_print_error($db); } diff --git a/htdocs/fourn/class/fournisseur.facture.class.php b/htdocs/fourn/class/fournisseur.facture.class.php index 0f6fc7ceff6..85120705ade 100644 --- a/htdocs/fourn/class/fournisseur.facture.class.php +++ b/htdocs/fourn/class/fournisseur.facture.class.php @@ -974,6 +974,7 @@ class FactureFournisseur extends CommonInvoice * @param string $price_base_type HT ou TTC * @param int $type Type of line (0=product, 1=service) * @param int $rang Position of line + * @param int $notrigger Disable triggers * @return int >0 if OK, <0 if KO */ function addline($desc, $pu, $txtva, $txlocaltax1, $txlocaltax2, $qty, $fk_product=0, $remise_percent=0, $date_start='', $date_end='', $ventil=0, $info_bits='', $price_base_type='HT', $type=0, $rang=-1, $notrigger=false) @@ -1062,6 +1063,7 @@ class FactureFournisseur extends CommonInvoice * @param int $info_bits Miscellanous informations of line * @param int $type Type of line (0=product, 1=service) * @param double $remise_percent Pourcentage de remise de la ligne + * @param int $notrigger Disable triggers * @return int <0 if KO, >0 if OK */ function updateline($id, $label, $pu, $vatrate, $txlocaltax1=0, $txlocaltax2=0, $qty=1, $idproduct=0, $price_base_type='HT', $info_bits=0, $type=0, $remise_percent=0, $notrigger=false) diff --git a/htdocs/mailmanspip/class/mailmanspip.class.php b/htdocs/mailmanspip/class/mailmanspip.class.php index 03f0fbff4b5..5032edca416 100644 --- a/htdocs/mailmanspip/class/mailmanspip.class.php +++ b/htdocs/mailmanspip/class/mailmanspip.class.php @@ -53,6 +53,7 @@ class MailmanSpip /** * Function used to check if SPIP is enabled on the system + * * @return boolean */ function isSpipEnabled() @@ -67,6 +68,7 @@ class MailmanSpip /** * Function used to check if the SPIP config is correct + * * @return boolean */ function checkSpipConfig() @@ -84,7 +86,8 @@ class MailmanSpip /** * Function used to connect to SPIP - * @return boolean|DoliDB + * + * @return boolean|DoliDB Boolean of DoliDB */ function connectSpip() { @@ -94,7 +97,7 @@ class MailmanSpip { return $resource; } - + dol_syslog('Error when connecting to SPIP '.ADHERENT_SPIP_SERVEUR.' '.ADHERENT_SPIP_USER.' '.ADHERENT_SPIP_PASS.' '.ADHERENT_SPIP_DB, LOG_ERR); return false; @@ -102,9 +105,10 @@ class MailmanSpip /** * Function used to connect to Mailman - * @param object $object Object with the data - * @param string $url Mailman URL to be called with patterns - * @return boolean|string + * + * @param object $object Object with the data + * @param string $url Mailman URL to be called with patterns + * @return mixed Boolean or string */ function callMailman($object, $url) { @@ -133,11 +137,11 @@ class MailmanSpip curl_setopt($ch, CURLOPT_FAILONERROR, true); @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1); curl_setopt($ch, CURLOPT_TIMEOUT, 5); - + $result = curl_exec($ch); dol_syslog('result curl_exec='.$result); - //An error was found, we store it in $this->error for later + //An error was found, we store it in $this->error for later if ($result === false || curl_errno($ch) > 0) { $this->error = curl_errno($ch).' '.curl_error($ch); @@ -187,7 +191,7 @@ class MailmanSpip else $this->error = 'BadSPIPConfiguration'; } else $this->error = 'SPIPNotEnabled'; - + return 0; } @@ -226,7 +230,7 @@ class MailmanSpip else $this->error = 'BadSPIPConfiguration'; } else $this->error = 'SPIPNotEnabled'; - + return 0; } diff --git a/htdocs/public/members/new.php b/htdocs/public/members/new.php index f265c9b7ca5..5ad4c62bf93 100644 --- a/htdocs/public/members/new.php +++ b/htdocs/public/members/new.php @@ -268,19 +268,19 @@ if ($action == 'add') { $to=$adh->makeSubstitution($conf->global->MAIN_INFO_SOCIETE_MAIL); $from=$conf->global->ADHERENT_MAIL_FROM; - $mailfile = new CMailFile( - $conf->global->ADHERENT_AUTOREGISTER_NOTIF_MAIL_SUBJECT, - $to, - $from, - $adh->makeSubstitution($conf->global->ADHERENT_AUTOREGISTER_NOTIF_MAIL), - array(), - array(), - array(), - "", - "", - 0, - -1 - ); + $mailfile = new CMailFile( + $conf->global->ADHERENT_AUTOREGISTER_NOTIF_MAIL_SUBJECT, + $to, + $from, + $adh->makeSubstitution($conf->global->ADHERENT_AUTOREGISTER_NOTIF_MAIL), + array(), + array(), + array(), + "", + "", + 0, + -1 + ); if (! $mailfile->sendfile()) {