diff --git a/htdocs/compta/prelevement/class/bon-prelevement.class.php b/htdocs/compta/prelevement/class/bon-prelevement.class.php index 7b4c8effc0c..4dc57382854 100644 --- a/htdocs/compta/prelevement/class/bon-prelevement.class.php +++ b/htdocs/compta/prelevement/class/bon-prelevement.class.php @@ -96,15 +96,16 @@ class BonPrelevement extends CommonObject /** * Add facture to withdrawal - * @param facture_id id invoice to add - * @param client_id id invoice customer - * @param client_nom name of cliente - * @param amount amount of invoice - * @param code_banque code of bank withdrawal - * @param code_guichet code of bank's office - * @param number bank account number - * @param number_key number key of account number - * @return int >0 if OK, <0 if KO + * + * @param int $facture_id id invoice to add + * @param int $client_id id invoice customer + * @param string $client_nom name of cliente + * @param int $amount amount of invoice + * @param string $code_banque code of bank withdrawal + * @param string $code_guichet code of bank's office + * @param string $number bank account number + * @param string $number_key number key of account number + * @return int >0 if OK, <0 if KO */ function AddFacture($facture_id, $client_id, $client_nom, $amount, $code_banque, $code_guichet, $number, $number_key) { @@ -153,15 +154,16 @@ class BonPrelevement extends CommonObject /** * Add line to withdrawal - * @param ligne_id id line to add - * @param client_id id invoice customer - * @param client_nom name of cliente - * @param amount amount of invoice - * @param code_banque code of bank withdrawal - * @param code_guichet code of bank's office - * @param number bank account number - * @param number_key number key of account number - * @return int >0 if OK, <0 if KO + * + * @param int &$line_id id line to add + * @param int $client_id id invoice customer + * @param string $client_nom name of cliente + * @param int $amount amount of invoice + * @param string $code_banque code of bank withdrawal + * @param string $code_guichet code of bank's office + * @param string $number bank account number + * @param string $number_key number key of account number + * @return int >0 if OK, <0 if KO */ function addline(&$line_id, $client_id, $client_nom, $amount, $code_banque, $code_guichet, $number, $number_key) { @@ -234,8 +236,9 @@ class BonPrelevement extends CommonObject /** * Read errors - * @param error id of error - * @return array of errors + * + * @param int $error id of error + * @return array Array of errors */ function ReadError($error) { @@ -248,8 +251,9 @@ class BonPrelevement extends CommonObject /** * Get object and lines from database - * @param rowid id of object to load - * @return int >0 if OK, <0 if KO + * + * @param int $rowid id of object to load + * @return int >0 if OK, <0 if KO */ function fetch($rowid) { @@ -308,7 +312,10 @@ class BonPrelevement extends CommonObject } /** - * @deprecated + * Set credite + * + * @deprecated + * @return int <0 if KO, >0 if OK */ function set_credite() { @@ -334,7 +341,7 @@ class BonPrelevement extends CommonObject { $facs = array(); $facs = $this->_get_list_factures(); - + $num=count($facs); for ($i = 0; $i < $num; $i++) { @@ -386,9 +393,10 @@ class BonPrelevement extends CommonObject /** * Set withdrawal to creditet status - * @param user id of user - * @param date date of action - * @return int >0 if OK, <0 if KO + * + * @param User $user id of user + * @param timestamp $date date of action + * @return int >0 if OK, <0 if KO */ function set_infocredit($user, $date) { @@ -508,10 +516,11 @@ class BonPrelevement extends CommonObject /** * Set withdrawal to transmited status - * @param user id of user - * @param date date of action - * @param method method of transmision to bank - * @return int >0 if OK, <0 if KO + * + * @param User $user id of user + * @param timestamp $date date of action + * @param string $method method of transmision to bank + * @return int >0 if OK, <0 if KO */ function set_infotrans($user, $date, $method) { @@ -575,6 +584,7 @@ class BonPrelevement extends CommonObject /** * Get invoice list + * * @return array id of invoices */ function _get_list_factures() @@ -623,7 +633,8 @@ class BonPrelevement extends CommonObject /** * Returns amount of withdrawal - * @return double total amount + * + * @return double Total amount */ function SommeAPrelever() { @@ -659,9 +670,10 @@ class BonPrelevement extends CommonObject /** * Get number of invoices to withdrawal - * @param banque bank - * @param agence agence - * @return int AddFacture($fac[0], $fac[2], $fac[8], $fac[7], - $fac[3], $fac[4], $fac[5], $fac[6]); + $ri = $bonprev->AddFacture($fac[0], $fac[2], $fac[8], $fac[7], $fac[3], $fac[4], $fac[5], $fac[6]); if ($ri <> 0) { $error++; @@ -1005,7 +1015,6 @@ class BonPrelevement extends CommonObject /* * Update total - * */ $sql = "UPDATE ".MAIN_DB_PREFIX."prelevement_bons"; @@ -1023,7 +1032,6 @@ class BonPrelevement extends CommonObject /* * Rollback or Commit - * */ if (!$error) { @@ -1046,9 +1054,10 @@ class BonPrelevement extends CommonObject /** * Returns clickable name (with picto) - * @param withpicto link with picto - * @param option link target - * @return string URL of target + * + * @param int $withpicto link with picto + * @param string $option link target + * @return string URL of target */ function getNomUrl($withpicto=0,$option='') { @@ -1073,8 +1082,9 @@ class BonPrelevement extends CommonObject /** * Delete a notification def by id - * @param rowid id of notification - * @return int 0 if OK, <0 if KO + * + * @param int $rowid id of notification + * @return int 0 if OK, <0 if KO */ function DeleteNotificationById($rowid) { @@ -1095,9 +1105,10 @@ class BonPrelevement extends CommonObject /** * Delete a notification - * @param user notification user - * @param action notification action - * @return int >0 if OK, <0 if KO + * + * @param User $user notification user + * @param string $action notification action + * @return int >0 if OK, <0 if KO */ function DeleteNotification($user, $action) { @@ -1118,9 +1129,11 @@ class BonPrelevement extends CommonObject /** * Add a notification - * @param user notification user - * @param action notification action - * @return int 0 if OK, <0 if KO + * + * @param DoliDB $db database handler + * @param User $user notification user + * @param string $action notification action + * @return int 0 if OK, <0 if KO */ function AddNotification($db, $user, $action) { @@ -1148,13 +1161,13 @@ class BonPrelevement extends CommonObject /** - * Generate a withdrawal file - * Generation Formats: - * France: CFONB - * Spain: AEB19 (if external module EsAEB is enabled) - * Others: Warning message + * Generate a withdrawal file. Generation Formats: + * France: CFONB + * Spain: AEB19 (if external module EsAEB is enabled) + * Others: Warning message * File is generated with name this->filename - * @return int 0 if OK, <0 if KO + * + * @return int 0 if OK, <0 if KO */ //TODO: Optimize code to read lines in a single function function Generate() @@ -1198,15 +1211,17 @@ class BonPrelevement extends CommonObject { $obj = $this->db->fetch_object($resql); - $esaeb19->agregaRecibo($idOrdenante, - "idcliente".$i+1, - $obj->client_nom, - $obj->code_banque, - $obj->code_guichet, - $obj->cle_rib, - $obj->number, - $obj->amount, - "Fra.".$obj->facnumber." ".$obj->amount); + $esaeb19->agregaRecibo( + $idOrdenante, + "idcliente".$i+1, + $obj->client_nom, + $obj->code_banque, + $obj->code_guichet, + $obj->cle_rib, + $obj->number, + $obj->amount, + "Fra.".$obj->facnumber." ".$obj->amount + ); $this->total = $this->total + $obj->amount; @@ -1291,14 +1306,16 @@ class BonPrelevement extends CommonObject { $row = $this->db->fetch_row($resql); - $this->EnregDestinataire($row[0], - $row[1], - $row[2], - $row[3], - $row[4], - $row[5], - $row[6], - $row[7]); + $this->EnregDestinataire( + $row[0], + $row[1], + $row[2], + $row[3], + $row[4], + $row[5], + $row[6], + $row[7] + ); $this->total = $this->total + $row[5]; @@ -1362,14 +1379,16 @@ class BonPrelevement extends CommonObject /** * Write recipient of request (customer) - * @param rowid id of line - * @param client_nom name of customer - * @param rib_banque code of bank - * @param rib_guichet code of bank office - * @param rib_number bank account - * @param amount amount - * @param facnumber ref of invoice - * @param facid id of invoice + * + * @param int $rowid id of line + * @param string $client_nom name of customer + * @param string $rib_banque code of bank + * @param string $rib_guichet code of bank office + * @param string $rib_number bank account + * @param float $amount amount + * @param string $facnumber ref of invoice + * @param int $facid id of invoice + * @return void */ function EnregDestinataire($rowid, $client_nom, $rib_banque, $rib_guichet, $rib_number, $amount, $facnumber, $facid) { @@ -1431,6 +1450,8 @@ class BonPrelevement extends CommonObject /** * Write sender of request (me) + * + * @return void */ function EnregEmetteur() { @@ -1495,7 +1516,9 @@ class BonPrelevement extends CommonObject /** * Write end - * @param total total amount + * + * @param int $total total amount + * @return void */ function EnregTotal($total) { @@ -1554,8 +1577,9 @@ class BonPrelevement extends CommonObject /** * Return status label of object - * @param mode 0=Label, 1=Picto + label, 2=Picto, 3=Label + Picto - * @return string Label + * + * @param int $mode 0=Label, 1=Picto + label, 2=Picto, 3=Label + Picto + * @return string Label */ function getLibStatut($mode=0) { @@ -1564,9 +1588,10 @@ class BonPrelevement extends CommonObject /** * Return status label for a status - * @param statut id statut - * @param mode 0=Label, 1=Picto + label, 2=Picto, 3=Label + Picto - * @return string Label + * + * @param int $statut id statut + * @param int $mode 0=Label, 1=Picto + label, 2=Picto, 3=Label + Picto + * @return string Label */ function LibStatut($statut,$mode=0) {