* Copyright (C) 2007-2011 Laurent Destailleur * Copyright (C) 2005-2009 Regis Houssin * Copyright (C) 2011-2015 Juanjo Menent * Copyright (C) 2015 Marcos GarcĂ­a * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /** * \file htdocs/compta/paiement/cheque/class/remisecheque.class.php * \ingroup compta * \brief File with class to manage cheque delivery receipts */ require_once DOL_DOCUMENT_ROOT .'/core/class/commonobject.class.php'; require_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php'; /** * Class to manage cheque delivery receipts */ class RemiseCheque extends CommonObject { public $element='chequereceipt'; public $table_element='bordereau_cheque'; var $id; var $num; var $intitule; var $ref_ext; //! Numero d'erreur Plage 1024-1279 var $errno; public $statut; /** * Constructor * * @param DoliDB $db Database handler */ function __construct($db) { $this->db = $db; $this->next_id = 0; $this->previous_id = 0; } /** * Load record * * @param int $id Id record * @param string $ref Ref record * @return int <0 if KO, > 0 if OK */ function fetch($id,$ref='') { global $conf; $sql = "SELECT bc.rowid, bc.datec, bc.fk_user_author, bc.fk_bank_account, bc.amount, bc.number, bc.statut, bc.nbcheque, bc.ref_ext"; $sql.= ", bc.date_bordereau as date_bordereau"; $sql.= ", ba.label as account_label"; $sql.= " FROM ".MAIN_DB_PREFIX."bordereau_cheque as bc"; $sql.= " LEFT JOIN ".MAIN_DB_PREFIX."bank_account as ba ON bc.fk_bank_account = ba.rowid"; $sql.= " WHERE bc.entity = ".$conf->entity; if ($id) $sql.= " AND bc.rowid = ".$id; if ($ref) $sql.= " AND bc.number = '".$this->db->escape($ref)."'"; dol_syslog("RemiseCheque::fetch", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { if ($obj = $this->db->fetch_object($resql) ) { $this->id = $obj->rowid; $this->amount = $obj->amount; $this->date_bordereau = $this->db->jdate($obj->date_bordereau); $this->account_id = $obj->fk_bank_account; $this->account_label = $obj->account_label; $this->author_id = $obj->fk_user_author; $this->nbcheque = $obj->nbcheque; $this->statut = $obj->statut; $this->ref_ext = $obj->ref_ext; if ($this->statut == 0) { $this->number = "(PROV".$this->id.")"; } else { $this->number = $obj->number; } $this->ref = $this->number; } $this->db->free($resql); return 1; } else { $this->error=$this->db->lasterror(); return -1; } } /** * Create a receipt to send cheques * * @param User $user User making creation * @param int $account_id Bank account for cheque receipt * @param int $limit Limit number of cheque to this * @param array $toRemise array with cheques to remise * @return int <0 if KO, >0 if OK */ function create($user, $account_id, $limit, $toRemise) { global $conf; $this->errno = 0; $this->id = 0; $now=dol_now(); $this->db->begin(); $sql = "INSERT INTO ".MAIN_DB_PREFIX."bordereau_cheque ("; $sql.= "datec"; $sql.= ", date_bordereau"; $sql.= ", fk_user_author"; $sql.= ", fk_bank_account"; $sql.= ", statut"; $sql.= ", amount"; $sql.= ", number"; $sql.= ", entity"; $sql.= ", nbcheque"; $sql.= ", ref_ext"; $sql.= ") VALUES ("; $sql.= "'".$this->db->idate($now)."'"; $sql.= ", '".$this->db->idate($now)."'"; $sql.= ", ".$user->id; $sql.= ", ".$account_id; $sql.= ", 0"; $sql.= ", 0"; $sql.= ", 0"; $sql.= ", ".$conf->entity; $sql.= ", 0"; $sql.= ", ''"; $sql.= ")"; dol_syslog("RemiseCheque::Create", LOG_DEBUG); $resql = $this->db->query($sql); if ( $resql ) { $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."bordereau_cheque"); if ($this->id == 0) { $this->errno = -1024; dol_syslog("Remisecheque::Create Error read id ".$this->errno, LOG_ERR); } if ($this->id > 0 && $this->errno == 0) { $sql = "UPDATE ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " SET number='(PROV".$this->id.")'"; $sql.= " WHERE rowid='".$this->id."';"; dol_syslog("RemiseCheque::Create", LOG_DEBUG); $resql = $this->db->query($sql); if (! $resql) { $this->errno = -1025; dol_syslog("RemiseCheque::Create Error update ".$this->errno, LOG_ERR); } } if ($this->id > 0 && $this->errno == 0) { $lines = array(); $sql = "SELECT b.rowid"; $sql.= " FROM ".MAIN_DB_PREFIX."bank as b"; $sql.= " WHERE b.fk_type = 'CHQ'"; $sql.= " AND b.amount > 0"; $sql.= " AND b.fk_bordereau = 0"; $sql.= " AND b.fk_account='".$account_id."'"; if ($limit) $sql.= $this->db->plimit($limit); dol_syslog("RemiseCheque::Create", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { while ($row = $this->db->fetch_row($resql) ) { array_push($lines, $row[0]); } $this->db->free($resql); } else { $this->errno = -1026; dol_syslog("RemiseCheque::Create Error ".$this->errno, LOG_ERR); } } if ($this->id > 0 && $this->errno == 0) { foreach ($lines as $lineid) { $checkremise=false; foreach ($toRemise as $linetoremise) { if($linetoremise==$lineid) $checkremise=true; } if($checkremise==true) { $sql = "UPDATE ".MAIN_DB_PREFIX."bank"; $sql.= " SET fk_bordereau = ".$this->id; $sql.= " WHERE rowid = ".$lineid; dol_syslog("RemiseCheque::Create", LOG_DEBUG); $resql = $this->db->query($sql); if (!$resql) { $this->errno = -18; dol_syslog("RemiseCheque::Create Error update bank ".$this->errno, LOG_ERR); } } } } if ($this->id > 0 && $this->errno == 0) { if ($this->updateAmount() <> 0) { $this->errno = -1027; dol_syslog("RemiseCheque::Create Error update amount ".$this->errno, LOG_ERR); } } } else { $this->errno = -1; $this->error=$this->db->lasterror(); $this->errno=$this->db->lasterrno(); } if (! $this->errno && ! empty($conf->global->MAIN_DISABLEDRAFTSTATUS)) { $res=$this->validate($user); //if ($res < 0) $error++; } if (! $this->errno) { $this->db->commit(); return $this->id; } else { $this->db->rollback(); return $this->errno; } } /** * Supprime la remise en base * * @param User $user Utilisateur qui effectue l'operation * @return int */ function delete($user='') { global $conf; $this->errno = 0; $this->db->begin(); $sql = "DELETE FROM ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " WHERE rowid = ".$this->id; $sql.= " AND entity = ".$conf->entity; $resql = $this->db->query($sql); if ( $resql ) { $num = $this->db->affected_rows($resql); if ($num <> 1) { $this->errno = -2; dol_syslog("Remisecheque::Delete Erreur Lecture ID ($this->errno)"); } if ( $this->errno === 0) { $sql = "UPDATE ".MAIN_DB_PREFIX."bank"; $sql.= " SET fk_bordereau = 0"; $sql.= " WHERE fk_bordereau = '".$this->id."'"; $resql = $this->db->query($sql); if (!$resql) { $this->errno = -1028; dol_syslog("RemiseCheque::Delete ERREUR UPDATE ($this->errno)"); } } } if ($this->errno === 0) { $this->db->commit(); } else { $this->db->rollback(); dol_syslog("RemiseCheque::Delete ROLLBACK ($this->errno)"); } return $this->errno; } /** * Validate a receipt * * @param User $user User * @return int <0 if KO, >0 if OK */ function validate($user) { global $langs,$conf; $this->errno = 0; $this->db->begin(); $numref=$this->getNextNumber(); if ($this->errno == 0 && $numref) { $sql = "UPDATE ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " SET statut = 1, number = '".$numref."'"; $sql.= " WHERE rowid = ".$this->id; $sql.= " AND entity = ".$conf->entity; $sql.= " AND statut = 0"; dol_syslog("RemiseCheque::Validate", LOG_DEBUG); $resql = $this->db->query($sql); if ( $resql ) { $num = $this->db->affected_rows($resql); if ($num == 1) { $this->number = $numref; $this->statut = 1; } else { $this->errno = -1029; dol_syslog("Remisecheque::Validate Error ".$this->errno, LOG_ERR); } } else { $this->errno = -1033; dol_syslog("Remisecheque::Validate Error ".$this->errno, LOG_ERR); } } // Commit/Rollback if ($this->errno == 0) { $this->db->commit(); return 1; } else { $this->db->rollback(); dol_syslog("RemiseCheque::Validate ".$this->errno, LOG_ERR); return $this->errno; } } /** * Old module for cheque receipt numbering * * @return int Next number of cheque */ function getNextNumber() { global $conf; $num=0; // We use +0 to convert varchar to number for mysql, use ::integer for postgres. // We must found a generic solution (Use a $db->toint function ?) $sql = "SELECT "; if ($this->db->type == 'pgsql') $sql.="MAX(number::integer)"; else $sql.="MAX(number+0)"; $sql.= " FROM ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " WHERE entity = ".$conf->entity; $sql.= " AND number not like '(%'"; dol_syslog("Remisecheque::getNextNumber", LOG_DEBUG); $resql = $this->db->query($sql); if ($resql) { $row = $this->db->fetch_row($resql); $num = $row[0]; $this->db->free($resql); } else { $this->errno = -1034; dol_syslog("Remisecheque::Validate Erreur SELECT ($this->errno)", LOG_ERR); } $num++; return $num; } /** * Load indicators for dashboard (this->nbtodo and this->nbtodolate) * * @param User $user Objet user * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK */ function load_board($user) { global $conf, $langs; if ($user->societe_id) return -1; // protection pour eviter appel par utilisateur externe $sql = "SELECT b.rowid, b.datev as datefin"; $sql.= " FROM ".MAIN_DB_PREFIX."bank as b"; $sql.= ", ".MAIN_DB_PREFIX."bank_account as ba"; $sql.= " WHERE b.fk_account = ba.rowid"; $sql.= " AND ba.entity IN (".getEntity('bank_account', 1).")"; $sql.= " AND b.fk_type = 'CHQ'"; $sql.= " AND b.fk_bordereau = 0"; $sql.= " AND b.amount > 0"; $resql=$this->db->query($sql); if ($resql) { $langs->load("banks"); $now=dol_now(); $response = new WorkboardResponse(); $response->warning_delay=$conf->bank->cheque->warning_delay/60/60/24; $response->label=$langs->trans("BankChecksToReceipt"); $response->url=DOL_URL_ROOT.'/compta/paiement/cheque/index.php?leftmenu=checks&mainmenu=bank'; $response->img=img_object($langs->trans("BankChecksToReceipt"),"payment"); while ($obj=$this->db->fetch_object($resql)) { $response->nbtodo++; if ($this->db->jdate($obj->datefin) < ($now - $conf->bank->cheque->warning_delay)) { $response->nbtodolate++; } } return $response; } else { dol_print_error($this->db); $this->error=$this->db->error(); return -1; } } /** * Build document * * @param string $model Model name * @param Translate $outputlangs Object langs * @return int <0 if KO, >0 if OK */ function generatePdf($model, $outputlangs) { global $langs,$conf; if (empty($model)) $model='blochet'; dol_syslog("RemiseCheque::generatePdf model=".$model." id=".$this->id, LOG_DEBUG); $dir=DOL_DOCUMENT_ROOT ."/core/modules/cheque/pdf/"; // Charge le modele $file = "pdf_".$model.".class.php"; if (file_exists($dir.$file)) { require_once DOL_DOCUMENT_ROOT .'/compta/bank/class/account.class.php'; require_once $dir.$file; $classname='BordereauCheque'.ucfirst($model); $docmodel = new $classname($this->db); $sql = "SELECT b.banque, b.emetteur, b.amount, b.num_chq"; $sql.= " FROM ".MAIN_DB_PREFIX."bank as b"; $sql.= ", ".MAIN_DB_PREFIX."bank_account as ba"; $sql.= ", ".MAIN_DB_PREFIX."bordereau_cheque as bc"; $sql.= " WHERE b.fk_account = ba.rowid"; $sql.= " AND b.fk_bordereau = bc.rowid"; $sql.= " AND bc.rowid = ".$this->id; $sql.= " AND bc.entity = ".$conf->entity; $sql.= " ORDER BY b.dateo ASC, b.rowid ASC"; dol_syslog("RemiseCheque::generatePdf", LOG_DEBUG); $result = $this->db->query($sql); if ($result) { $i = 0; while ($objp = $this->db->fetch_object($result)) { $docmodel->lines[$i] = new stdClass(); $docmodel->lines[$i]->bank_chq = $objp->banque; $docmodel->lines[$i]->emetteur_chq = $objp->emetteur; $docmodel->lines[$i]->amount_chq = $objp->amount; $docmodel->lines[$i]->num_chq = $objp->num_chq; $i++; } } $docmodel->nbcheque = $this->nbcheque; $docmodel->number = $this->number; $docmodel->amount = $this->amount; $docmodel->date = $this->date_bordereau; $account = new Account($this->db); $account->fetch($this->account_id); $docmodel->account = &$account; // We save charset_output to restore it because write_file can change it if needed for // output format that does not support UTF8. $sav_charseSupprimert_output=$outputlangs->charset_output; $result=$docmodel->write_file($this, $conf->banque->dir_output.'/bordereau', $this->number, $outputlangs); if ($result > 0) { //$outputlangs->charset_output=$sav_charset_output; return 1; } else { //$outputlangs->charset_output=$sav_charset_output; dol_syslog("Error"); dol_print_error($this->db,$docmodel->error); return 0; } } else { $this->error=$langs->trans("ErrorFileDoesNotExists",$dir.$file); return -1; } } /** * Mets a jour le montant total * * @return int 0 en cas de succes */ function updateAmount() { global $conf; $this->errno = 0; $this->db->begin(); $total = 0; $nb = 0; $sql = "SELECT amount "; $sql.= " FROM ".MAIN_DB_PREFIX."bank"; $sql.= " WHERE fk_bordereau = ".$this->id; $resql = $this->db->query($sql); if ( $resql ) { while ( $row = $this->db->fetch_row($resql) ) { $total += $row[0]; $nb++; } $this->db->free($resql); $sql = "UPDATE ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " SET amount = '".price2num($total)."'"; $sql.= ", nbcheque = ".$nb; $sql.= " WHERE rowid = ".$this->id; $sql.= " AND entity = ".$conf->entity; $resql = $this->db->query($sql); if (!$resql) { $this->errno = -1030; dol_syslog("RemiseCheque::updateAmount ERREUR UPDATE ($this->errno)"); } } else { $this->errno = -1031; dol_syslog("RemiseCheque::updateAmount ERREUR SELECT ($this->errno)"); } if ($this->errno === 0) { $this->db->commit(); } else { $this->db->rollback(); dol_syslog("RemiseCheque::updateAmount ROLLBACK ($this->errno)"); } return $this->errno; } /** * Insere la remise en base * * @param int $account_id Compte bancaire concerne * @return int */ function removeCheck($account_id) { $this->errno = 0; if ($this->id > 0) { $sql = "UPDATE ".MAIN_DB_PREFIX."bank"; $sql.= " SET fk_bordereau = 0"; $sql.= " WHERE rowid = '".$account_id."'"; $sql.= " AND fk_bordereau = ".$this->id; $resql = $this->db->query($sql); if ($resql) { $this->updateAmount(); } else { $this->errno = -1032; dol_syslog("RemiseCheque::removeCheck ERREUR UPDATE ($this->errno)"); } } return 0; } /** * Check return management * Reopen linked invoices and create a new negative payment. * * @param int $bank_id Id of bank transaction line concerned * @param date $rejection_date Date to use on the negative payment * @return int Id of negative payment line created */ function rejectCheck($bank_id, $rejection_date) { global $db, $user; $payment = new Paiement($db); $payment->fetch(0,0,$bank_id); $bankline = new AccountLine($db); $bankline->fetch($bank_id); /* Conciliation is allowed because when check is returned, a new line is created onto bank transaction log. if ($bankline->rappro) { $this->error='ActionRefusedLineAlreadyConciliated'; return -1; }*/ $this->db->begin(); // Not conciliated, we can delete it //$bankline->delete($user); // We delete $bankaccount = $payment->fk_account; // Get invoices list to reopen them $sql = 'SELECT pf.fk_facture, pf.amount'; $sql.= ' FROM '.MAIN_DB_PREFIX.'paiement_facture as pf'; $sql.= ' WHERE pf.fk_paiement = '.$payment->id; $resql=$db->query($sql); if ($resql) { $rejectedPayment = new Paiement($db); $rejectedPayment->amounts = array(); $rejectedPayment->datepaye = $rejection_date; $rejectedPayment->paiementid = dol_getIdFromCode($this->db, 'CHQ', 'c_paiement'); $rejectedPayment->num_paiement = $payment->numero; while($obj = $db->fetch_object($resql)) { $invoice = new Facture($db); $invoice->fetch($obj->fk_facture); $invoice->set_unpaid($user); $rejectedPayment->amounts[$obj->fk_facture] = price2num($obj->amount) * -1; } $result = $rejectedPayment->create($user); if ($result > 0) { // We created a negative payment, we also add the line as bank transaction $result=$rejectedPayment->addPaymentToBank($user,'payment','(CheckRejected)',$bankaccount,'',''); if ($result > 0) { $result = $payment->reject(); if ($result > 0) { $this->db->commit(); return $rejectedPayment->id; } else { $this->db->rollback(); return -1; } } else { $this->error = $rejectedPayment->error; $this->errors = $rejectedPayment->errors; $this->db->rollback(); return -1; } } else { $this->error = $rejectedPayment->error; $this->errors = $rejectedPayment->errors; $this->db->rollback(); return -1; } } else { $this->error=$this->db->lasterror(); $this->db->rollback(); return -1; } } /** * Charge les proprietes ref_previous et ref_next * * @return int <0 if KO, 0 if OK */ function load_previous_next_id() { global $conf; $this->errno = 0; $sql = "SELECT MAX(rowid)"; $sql.= " FROM ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " WHERE rowid < ".$this->id; $sql.= " AND entity = ".$conf->entity; $result = $this->db->query($sql); if (! $result) { $this->errno = -1035; } $row = $this->db->fetch_row($result); $this->previous_id = $row[0]; $sql = "SELECT MIN(rowid)"; $sql.= " FROM ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " WHERE rowid > ".$this->id; $sql.= " AND entity = ".$conf->entity; $result = $this->db->query($sql); if (! $result) { $this->errno = -1035; } $row = $this->db->fetch_row($result); $this->next_id = $row[0]; return $this->errno; } /** * Set the creation date * * @param User $user Object user * @param int $date Date creation * @return int <0 if KO, >0 if OK */ function set_date($user, $date) { if ($user->rights->banque->cheque) { $sql = "UPDATE ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " SET date_bordereau = ".($date ? $this->db->idate($date) : 'null'); $sql.= " WHERE rowid = ".$this->id; dol_syslog("RemiseCheque::set_date", LOG_DEBUG); $resql=$this->db->query($sql); if ($resql) { $this->date_bordereau = $date; return 1; } else { $this->error=$this->db->error(); return -1; } } else { return -2; } } /** * Set the number of bordereau * * @param User $user Object user * @param int $number number of bordereau * @return int <0 if KO, >0 if OK */ function set_number($user, $number) { if ($user->rights->banque->cheque) { $sql = "UPDATE ".MAIN_DB_PREFIX."bordereau_cheque"; $sql.= " SET number = '".$number."'" ; $sql.= " WHERE rowid = ".$this->id; dol_syslog("RemiseCheque::set_number", LOG_DEBUG); $resql=$this->db->query($sql); if ($resql) { return 1; } else { $this->error=$this->db->error(); return -1; } } else { return -2; } } /** * Return clicable name (with picto eventually) * * @param int $withpicto 0=No picto, 1=Include picto into link, 2=Only picto * @param string $option Sur quoi pointe le lien * @return string Chaine avec URL */ function getNomUrl($withpicto=0,$option='') { global $langs; $result=''; $label = $langs->trans("ShowCheckReceipt").': '.$this->ref; $link = ''; $linkend=''; if ($withpicto) $result.=($link.img_object($label, 'payment', 'class="classfortooltip"').$linkend); if ($withpicto && $withpicto != 2) $result.=' '; if ($withpicto != 2) $result.=$link.$this->ref.$linkend; return $result; } /** * Retourne le libelle du statut d'une facture (brouillon, validee, abandonnee, payee) * * @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto * @return string Libelle */ function getLibStatut($mode=0) { return $this->LibStatut($this->statut,$mode); } /** * Return label of a status * * @param int $status Statut * @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto * @return string Libelle du statut */ function LibStatut($status,$mode=0) { global $langs; // TODO Renvoyer le libelle anglais et faire traduction a affichage $langs->load('compta'); if ($mode == 0) { if ($status == 0) return $langs->trans('ToValidate'); if ($status == 1) return $langs->trans('Validated'); } if ($mode == 1) { if ($status == 0) return $langs->trans('ToValidate'); if ($status == 1) return $langs->trans('Validated'); } if ($mode == 2) { if ($status == 0) return img_picto($langs->trans('ToValidate'),'statut0').' '.$langs->trans('ToValidate'); if ($status == 1) return img_picto($langs->trans('Validated'),'statut4').' '.$langs->trans('Validated'); } if ($mode == 3) { if ($status == 0) return img_picto($langs->trans('ToValidate'),'statut0'); if ($status == 1) return img_picto($langs->trans('Validated'),'statut4'); } if ($mode == 4) { if ($status == 0) return img_picto($langs->trans('ToValidate'),'statut0').' '.$langs->trans('ToValidate'); if ($status == 1) return img_picto($langs->trans('Validated'),'statut4').' '.$langs->trans('Validated'); } if ($mode == 5) { if ($status == 0) return $langs->trans('ToValidate').' '.img_picto($langs->trans('ToValidate'),'statut0'); if ($status == 1) return $langs->trans('Validated').' '.img_picto($langs->trans('Validated'),'statut4'); } return $langs->trans('Unknown'); } }