lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2011-09-20 22:28:31 +00:00
parent 25a3779fcc
commit 1f9f17247f
1 changed files with 93 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

209
htdocs/compta/prelevement/class/bon-prelevement.class.php
View File

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