/htdocs/core/class/discount.class.php
PHP | 483 lines | 320 code | 49 blank | 114 comment | 40 complexity | e88635c14008e6787ba9b618df4d01a6 MD5 | raw file
Possible License(s): LGPL-2.0
- <?php
- /* Copyright (C) 2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
- * Copyright (C) 2004-2009 Laurent Destailleur <eldy@users.sourceforge.net>
- *
- * 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 2 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 <http://www.gnu.org/licenses/>.
- */
- /**
- * \file htdocs/core/class/discount.class.php
- * \ingroup core propal facture commande
- * \brief File of class to manage absolute discounts
- */
- /**
- * \class DiscountAbsolute
- * \brief Class to manage absolute discounts
- */
- class DiscountAbsolute
- {
- var $db;
- var $error;
- var $id; // Id discount
- var $fk_soc;
- var $amount_ht; //
- var $amount_tva; //
- var $amount_ttc; //
- var $tva_tx; // Vat rate
- var $fk_user; // Id utilisateur qui accorde la remise
- var $description; // Description libre
- var $datec; // Date creation
- var $fk_facture_line; // Id invoice line when a discount linked to invoice line (for absolute discounts)
- var $fk_facture; // Id invoice when a discoutn linked to invoice (for credit note)
- var $fk_facture_source; // Id facture avoir a l'origine de la remise
- var $ref_facture_source; // Ref facture avoir a l'origine de la remise
- /**
- * Constructor
- *
- * @param DoliDB $DB Database handler
- */
- function DiscountAbsolute($DB)
- {
- $this->db = $DB;
- }
- /**
- * Load object from database into memory
- *
- * @param int $rowid id discount to load
- * @param int $fk_facture_source fk_facture_source
- * @return int <0 if KO, =0 if not found, >0 if OK
- */
- function fetch($rowid,$fk_facture_source=0)
- {
- // Check parameters
- if (! $rowid && ! $fk_facture_source)
- {
- $this->error='ErrorBadParameters';
- return -1;
- }
- $sql = "SELECT sr.rowid, sr.fk_soc,";
- $sql.= " sr.fk_user,";
- $sql.= " sr.amount_ht, sr.amount_tva, sr.amount_ttc, sr.tva_tx,";
- $sql.= " sr.fk_facture_line, sr.fk_facture, sr.fk_facture_source, sr.description,";
- $sql.= " sr.datec,";
- $sql.= " f.facnumber as ref_facture_source";
- $sql.= " FROM ".MAIN_DB_PREFIX."societe_remise_except as sr";
- $sql.= " LEFT JOIN ".MAIN_DB_PREFIX."facture as f ON sr.fk_facture_source = f.rowid";
- $sql.= " WHERE";
- if ($rowid) $sql.= " sr.rowid=".$rowid;
- if ($fk_facture_source) $sql.= " sr.fk_facture_source=".$fk_facture_source;
- dol_syslog(get_class($this)."::fetch sql=".$sql);
- $resql = $this->db->query($sql);
- if ($resql)
- {
- if ($this->db->num_rows($resql))
- {
- $obj = $this->db->fetch_object($resql);
- $this->id = $obj->rowid;
- $this->fk_soc = $obj->fk_soc;
- $this->amount_ht = $obj->amount_ht;
- $this->amount_tva = $obj->amount_tva;
- $this->amount_ttc = $obj->amount_ttc;
- $this->tva_tx = $obj->tva_tx;
- $this->fk_user = $obj->fk_user;
- $this->fk_facture_line = $obj->fk_facture_line;
- $this->fk_facture = $obj->fk_facture;
- $this->fk_facture_source = $obj->fk_facture_source; // Id avoir source
- $this->ref_facture_source = $obj->ref_facture_source; // Ref avoir source
- $this->description = $obj->description;
- $this->datec = $this->db->jdate($obj->datec);
- $this->db->free($resql);
- return 1;
- }
- else
- {
- $this->db->free($resql);
- return 0;
- }
- }
- else
- {
- $this->error=$this->db->error();
- return -1;
- }
- }
- /**
- * Create a discount into database
- *
- * @param User $user User that create
- * @return int <0 if KO, >0 if OK
- */
- function create($user)
- {
- global $conf, $langs;
- // Clean parameters
- $this->amount_ht=price2num($this->amount_ht);
- $this->amount_tva=price2num($this->amount_tva);
- $this->amount_ttc=price2num($this->amount_ttc);
- $this->tva_tx=price2num($this->tva_tx);
- // Check parameters
- if (empty($this->description))
- {
- $this->error='BadValueForPropertyDescription';
- dol_syslog(get_class($this)."::create ".$this->error, LOG_ERR);
- return -1;
- }
- // Insert request
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."societe_remise_except";
- $sql.= " (datec, fk_soc, fk_user, description,";
- $sql.= " amount_ht, amount_tva, amount_ttc, tva_tx,";
- $sql.= " fk_facture_source";
- $sql.= ")";
- $sql.= " VALUES (".$this->db->idate($this->datec!=''?$this->datec:dol_now()).", ".$this->fk_soc.", ".$user->id.", '".$this->db->escape($this->description)."',";
- $sql.= " ".$this->amount_ht.", ".$this->amount_tva.", ".$this->amount_ttc.", ".$this->tva_tx.",";
- $sql.= " ".($this->fk_facture_source?"'".$this->fk_facture_source."'":"null");
- $sql.= ")";
- dol_syslog(get_class($this)."::create sql=".$sql);
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $this->id=$this->db->last_insert_id(MAIN_DB_PREFIX."societe_remise_except");
- return $this->id;
- }
- else
- {
- $this->error=$this->db->lasterror().' - sql='.$sql;
- dol_syslog(get_class($this)."::create ".$this->error, LOG_ERR);
- return -1;
- }
- }
- /**
- * Delete object in database. If fk_facture_source is defined, we delete all familiy with same fk_facture_source. If not, only with id is removed
- *
- * @param User $user Object of user asking to delete
- * @return int <0 if KO, >0 if OK
- */
- function delete($user)
- {
- global $conf, $langs;
- // Check if we can remove the discount
- if ($this->fk_facture_source)
- {
- $sql.="SELECT COUNT(rowid) as nb";
- $sql.=" FROM ".MAIN_DB_PREFIX."societe_remise_except";
- $sql.=" WHERE (fk_facture_line IS NOT NULL"; // Not used as absolute simple discount
- $sql.=" OR fk_facture IS NOT NULL)"; // Not used as credit note and not used as deposit
- $sql.=" AND fk_facture_source = ".$this->fk_facture_source;
- //$sql.=" AND rowid != ".$this->id;
- dol_syslog(get_class($this)."::delete Check if we can remove discount sql=".$sql);
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $obj = $this->db->fetch_object($resql);
- if ($obj->nb > 0)
- {
- $this->error='ErrorThisPartOrAnotherIsAlreadyUsedSoDiscountSerieCantBeRemoved';
- return -2;
- }
- }
- else
- {
- dol_print_error($db);
- return -1;
- }
- }
- $this->db->begin();
- // Delete but only if not used
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."societe_remise_except ";
- if ($this->fk_facture_source) $sql.= " WHERE fk_facture_source = ".$this->fk_facture_source; // Delete all lines of same serie
- else $sql.= " WHERE rowid = ".$this->id; // Delete only line
- $sql.= " AND (fk_facture_line IS NULL"; // Not used as absolute simple discount
- $sql.= " AND fk_facture IS NULL)"; // Not used as credit note and not used as deposit
- dol_syslog(get_class($this)."::delete Delete discount sql=".$sql);
- $result=$this->db->query($sql);
- if ($result)
- {
- // If source of discount was a credit note or deposit, we change source statut.
- if ($this->fk_facture_source)
- {
- $sql = "UPDATE ".MAIN_DB_PREFIX."facture";
- $sql.=" set paye=0, fk_statut=1";
- $sql.=" WHERE (type = 2 or type = 3) AND rowid=".$this->fk_facture_source;
- dol_syslog(get_class($this)."::delete Update credit note or deposit invoice statut sql=".$sql);
- $result=$this->db->query($sql);
- if ($result)
- {
- $this->db->commit();
- return 1;
- }
- else
- {
- $this->error=$this->db->lasterror();
- $this->db->rollback();
- return -1;
- }
- }
- else
- {
- $this->db->commit();
- return 1;
- }
- }
- else
- {
- $this->error=$this->db->lasterror();
- $this->db->rollback();
- return -1;
- }
- }
- /**
- * Link the discount to a particular invoice line or a particular invoice.
- * When discount is a global discount used as an invoice line, we link using rowidline.
- * When discount is from a credit note used to reduce payment of an invoice, we link using rowidinvoice
- *
- * @param int $rowidline Invoice line id (To use discount into invoice lines)
- * @param int $rowidinvoice Invoice id (To use discount as a credit note to reduc payment of invoice)
- * @return int <0 if KO, >0 if OK
- */
- function link_to_invoice($rowidline,$rowidinvoice)
- {
- // Check parameters
- if (! $rowidline && ! $rowidinvoice)
- {
- $this->error='ErrorBadParameters';
- return -1;
- }
- if ($rowidline && $rowidinvoice)
- {
- $this->error='ErrorBadParameters';
- return -2;
- }
- $sql ="UPDATE ".MAIN_DB_PREFIX."societe_remise_except";
- if ($rowidline) $sql.=" SET fk_facture_line = ".$rowidline;
- if ($rowidinvoice) $sql.=" SET fk_facture = ".$rowidinvoice;
- $sql.=" WHERE rowid = ".$this->id;
- dol_syslog(get_class($this)."::link_to_invoice sql=".$sql,LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql)
- {
- $this->fk_facture_source=$rowidline;
- $this->fk_facture=$rowidinvoice;
- return 1;
- }
- else
- {
- $this->error=$this->db->error();
- dol_syslog(get_class($this)."::link_to_invoice ".$this->error,LOG_ERR);
- return -3;
- }
- }
- /**
- * Link the discount to a particular invoice line or a particular invoice.
- * Do not call this if discount is linked to a reconcialiated invoice
- *
- * @return int <0 if KO, >0 if OK
- */
- function unlink_invoice()
- {
- $sql ="UPDATE ".MAIN_DB_PREFIX."societe_remise_except";
- $sql.=" SET fk_facture_line = NULL, fk_facture = NULL";
- $sql.=" WHERE rowid = ".$this->id;
- dol_syslog(get_class($this)."::unlink_invoice sql=".$sql,LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql)
- {
- return 1;
- }
- else
- {
- $this->error=$this->db->error();
- dol_syslog(get_class($this)."::unlink_invoice ".$this->error,LOG_ERR);
- return -3;
- }
- }
- /**
- * Renvoie montant TTC des reductions/avoirs en cours disponibles pour une sociĂŠtĂŠ, un user ou autre
- *
- * @param Societe $company Object third party for filter
- * @param User $user Filtre sur un user auteur des remises
- * @param string $filter Filtre autre
- * @param int $maxvalue Filter on max value for discount
- * @return int <0 if KO, amount otherwise
- */
- function getAvailableDiscounts($company='', $user='',$filter='', $maxvalue=0)
- {
- $sql = "SELECT SUM(rc.amount_ttc) as amount";
- // $sql = "SELECT rc.amount_ttc as amount";
- $sql.= " FROM ".MAIN_DB_PREFIX."societe_remise_except as rc";
- $sql.= " WHERE (rc.fk_facture IS NULL AND rc.fk_facture_line IS NULL)"; // Available
- if (is_object($company)) $sql.= " AND rc.fk_soc = ".$company->id;
- if (is_object($user)) $sql.= " AND rc.fk_user = ".$user->id;
- if ($filter) $sql.=' AND ('.$filter.')';
- if ($maxvalue) $sql.=' AND rc.amount_ttc <= '.price2num($maxvalue);
- dol_syslog(get_class($this)."::getAvailableDiscounts sql=".$sql,LOG_DEBUG);
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $obj = $this->db->fetch_object($resql);
- //while ($obj)
- //{
- //print 'zz'.$obj->amount;
- //$obj = $this->db->fetch_object($resql);
- //}
- return $obj->amount;
- }
- return -1;
- }
- /**
- * Return amount (with tax) of all credit notes and deposits invoices used by invoice
- *
- * @param Facture $invoice Object invoice
- * @return int <0 if KO, Sum of credit notes and deposits amount otherwise
- */
- function getSumCreditNotesUsed($invoice)
- {
- $sql = 'SELECT sum(rc.amount_ttc) as amount';
- $sql.= ' FROM '.MAIN_DB_PREFIX.'societe_remise_except as rc, '.MAIN_DB_PREFIX.'facture as f';
- $sql.= ' WHERE rc.fk_facture_source=f.rowid AND rc.fk_facture = '.$invoice->id;
- $sql.= ' AND f.type = 2';
- dol_syslog(get_class($this)."::getSumCreditNotesUsed sql=".$sql,LOG_DEBUG);
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $obj = $this->db->fetch_object($resql);
- return $obj->amount;
- }
- else
- {
- return -1;
- }
- }
- /**
- * Return amount (with tax) of all deposits invoices used by invoice
- *
- * @param Facture $invoice Object invoice
- * @return int <0 if KO, Sum of credit notes and deposits amount otherwise
- */
- function getSumDepositsUsed($invoice)
- {
- $sql = 'SELECT sum(rc.amount_ttc) as amount';
- $sql.= ' FROM '.MAIN_DB_PREFIX.'societe_remise_except as rc, '.MAIN_DB_PREFIX.'facture as f';
- $sql.= ' WHERE rc.fk_facture_source=f.rowid AND rc.fk_facture = '.$invoice->id;
- $sql.= ' AND f.type = 3';
- dol_syslog(get_class($this)."::getSumDepositsUsed sql=".$sql,LOG_DEBUG);
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $obj = $this->db->fetch_object($resql);
- return $obj->amount;
- }
- else
- {
- return -1;
- }
- }
- /**
- * Return clickable ref of object (with picto or not)
- *
- * @param int $withpicto 0=No picto, 1=Include picto into link, 2=Picto only
- * @param string $option Where to link to ('invoice' or 'discount')
- * @return string String with URL
- */
- function getNomUrl($withpicto,$option='invoice')
- {
- global $langs;
- $result='';
- if ($option == 'invoice')
- {
- $lien = '<a href="'.DOL_URL_ROOT.'/compta/facture.php?facid='.$this->fk_facture_source.'">';
- $lienfin='</a>';
- $label=$langs->trans("ShowDiscount").': '.$this->ref_facture_source;
- $ref=$this->ref_facture_source;
- $picto='bill';
- }
- if ($option == 'discount')
- {
- $lien = '<a href="'.DOL_URL_ROOT.'/comm/remx.php?id='.$this->fk_soc.'">';
- $lienfin='</a>';
- $label=$langs->trans("Discount");
- $ref=$langs->trans("Discount");
- $picto='generic';
- }
- if ($withpicto) $result.=($lien.img_object($label,$picto).$lienfin);
- if ($withpicto && $withpicto != 2) $result.=' ';
- $result.=$lien.$ref.$lienfin;
- return $result;
- }
- /**
- * Initialise an instance with random values.
- * Used to build previews or test instances.
- * id must be 0 if object instance is a specimen.
- *
- * @return void
- */
- function initAsSpecimen()
- {
- global $user,$langs,$conf;
- $this->fk_soc = 1;
- $this->amount_ht = 10;
- $this->amount_tva = 1.96;
- $this->amount_ttc = 11.96;
- $this->tva_tx = 19.6;
- $this->description = 'Specimen discount';
- }
- }
- ?>