paiementfourn.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2002-2004 Rodolphe Quiedeville   <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2007 Laurent Destailleur    <eldy@users.sourceforge.net>
 * Copyright (C) 2005      Marc Barilley / Ocebo  <marc@ocebo.com>
 * Copyright (C) 2005-2009 Regis Houssin          <regis.houssin@inodbox.com>
 * Copyright (C) 2010-2011 Juanjo Menent          <jmenent@2byte.es>
 * Copyright (C) 2014      Marcos García          <marcosgdf@gmail.com>
 * Copyright (C) 2018      Nicolas ZABOURI    <info@inovea-conseil.com>
 * Copyright (C) 2018       Frédéric France         <frederic.francenetlogic.fr>
 *
 * 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 <https://www.gnu.org/licenses/>.
 */

require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php';
require_once DOL_DOCUMENT_ROOT.'/compta/paiement/class/paiement.class.php';
require_once DOL_DOCUMENT_ROOT.'/multicurrency/class/multicurrency.class.php';

class PaiementFourn extends Paiement
{
  public $element = 'payment_supplier';

  public $table_element = 'paiementfourn';

  public $picto = 'payment';

  public $statut; //Status of payment. 0 = unvalidated; 1 = validated
  // fk_paiement dans llx_paiement est l'id du type de paiement (7 pour CHQ, ...)
  // fk_paiement dans llx_paiement_facture est le rowid du paiement

  public $type_label;

  public $type_code;



  public function __construct($db)
  {
    $this->db = $db;
  }

  public function fetch($id, $ref = '', $fk_bank = '')
  {
    $error = 0;

    $sql = 'SELECT p.rowid, p.ref, p.entity, p.datep as dp, p.amount, p.statut, p.fk_bank, p.multicurrency_amount,';
    $sql .= ' c.code as payment_code, c.libelle as payment_type,';
    $sql .= ' p.num_paiement as num_payment, p.note, b.fk_account';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'paiementfourn as p';
    $sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_paiement as c ON p.fk_paiement = c.id';
    $sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'bank as b ON p.fk_bank = b.rowid';
    $sql .= ' WHERE p.entity IN ('.getEntity('facture_fourn').')';
    if ($id > 0)
      $sql .= ' AND p.rowid = '.$id;
    elseif ($ref)
      $sql .= ' AND p.rowid = '.$ref;
    elseif ($fk_bank)
      $sql .= ' AND p.fk_bank = '.$fk_bank;
    //print $sql;

    $resql = $this->db->query($sql);
    if ($resql)
    {
      $num = $this->db->num_rows($resql);
      if ($num > 0)
      {
        $obj = $this->db->fetch_object($resql);

        $this->id             = $obj->rowid;
        $this->ref            = $obj->ref;
        $this->entity         = $obj->entity;
        $this->date           = $this->db->jdate($obj->dp);
        $this->datepaye       = $this->db->jdate($obj->dp);
        $this->num_payment    = $obj->num_payment;
        $this->numero         = $obj->num_payment;
        $this->bank_account   = $obj->fk_account;
        $this->fk_account     = $obj->fk_account;
        $this->bank_line      = $obj->fk_bank;
        $this->montant        = $obj->amount; // deprecated
        $this->amount         = $obj->amount;
        $this->multicurrency_amount = $obj->multicurrency_amount;
        $this->note                 = $obj->note;
        $this->note_private         = $obj->note;
        $this->type_code            = $obj->payment_code;
        $this->type_label           = $obj->payment_type;
        $this->statut               = $obj->statut;

        $error = 1;
      } else {
        $error = -2; // TODO Use 0 instead
      }
      $this->db->free($resql);
    } else {
      dol_print_error($this->db);
      $error = -1;
    }
    return $error;
  }

  public function create($user, $closepaidinvoices = 0, $thirdparty = null)
  {
    global $langs, $conf;

    $error = 0;
    $way = $this->getWay();

    // Clean parameters
    $totalamount = 0;
    $totalamount_converted = 0;

    dol_syslog(get_class($this)."::create", LOG_DEBUG);

    if ($way == 'dolibarr')
    {
      $amounts = &$this->amounts;
      $amounts_to_update = &$this->multicurrency_amounts;
    } else {
      $amounts = &$this->multicurrency_amounts;
      $amounts_to_update = &$this->amounts;
    }

    foreach ($amounts as $key => $value)
    {
      $value_converted = Multicurrency::getAmountConversionFromInvoiceRate($key, $value ? $value : 0, $way, 'facture_fourn');
      $totalamount_converted += $value_converted;
      $amounts_to_update[$key] = price2num($value_converted, 'MT');

      $newvalue = price2num($value, 'MT');
      $amounts[$key] = $newvalue;
      $totalamount += $newvalue;
    }
    $totalamount = price2num($totalamount);
    $totalamount_converted = price2num($totalamount_converted);

    $this->db->begin();

    if ($totalamount <> 0) // On accepte les montants negatifs
    {
      $ref = $this->getNextNumRef(is_object($thirdparty) ? $thirdparty : '');
      $now = dol_now();

      if ($way == 'dolibarr')
      {
        $total = $totalamount;
        $mtotal = $totalamount_converted; // Maybe use price2num with MT for the converted value
      } else {
        $total = $totalamount_converted; // Maybe use price2num with MT for the converted value
        $mtotal = $totalamount;
      }

      $sql = 'INSERT INTO '.MAIN_DB_PREFIX.'paiementfourn (';
      $sql .= 'ref, entity, datec, datep, amount, multicurrency_amount, fk_paiement, num_paiement, note, fk_user_author, fk_bank)';
      $sql .= " VALUES ('".$this->db->escape($ref)."', ".$conf->entity.", '".$this->db->idate($now)."',";
      $sql .= " '".$this->db->idate($this->datepaye)."', '".$total."', '".$mtotal."', ".$this->paiementid.", '".$this->db->escape($this->num_payment)."', '".$this->db->escape($this->note_private)."', ".$user->id.", 0)";

      $resql = $this->db->query($sql);
      if ($resql)
      {
        $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX.'paiementfourn');

        // Insere tableau des montants / factures
        foreach ($this->amounts as $key => $amount)
        {
          $facid = $key;
          if (is_numeric($amount) && $amount <> 0)
          {
            $amount = price2num($amount);
            $sql = 'INSERT INTO '.MAIN_DB_PREFIX.'paiementfourn_facturefourn (fk_facturefourn, fk_paiementfourn, amount, multicurrency_amount)';
            $sql .= ' VALUES ('.$facid.','.$this->id.',\''.$amount.'\', \''.$this->multicurrency_amounts[$key].'\')';
            $resql = $this->db->query($sql);
            if ($resql)
            {
              $invoice = new FactureFournisseur($this->db);
              $invoice->fetch($facid);

              // If we want to closed paid invoices
              if ($closepaidinvoices)
              {
                $paiement = $invoice->getSommePaiement();
                //$creditnotes=$invoice->getSumCreditNotesUsed();
                $creditnotes = 0;
                //$deposits=$invoice->getSumDepositsUsed();
                $deposits = 0;
                $alreadypayed = price2num($paiement + $creditnotes + $deposits, 'MT');
                $remaintopay = price2num($invoice->total_ttc - $paiement - $creditnotes - $deposits, 'MT');
                if ($remaintopay == 0)
                {
                  $result = $invoice->set_paid($user, '', '');
                } else dol_syslog("Remain to pay for invoice ".$facid." not null. We do nothing.");
              }

              // Regenerate documents of invoices
              if (empty($conf->global->MAIN_DISABLE_PDF_AUTOUPDATE))
              {
                $newlang = '';
                $outputlangs = $langs;
                if ($conf->global->MAIN_MULTILANGS && empty($newlang))  $newlang = $invoice->thirdparty->default_lang;
                if (!empty($newlang)) {
                  $outputlangs = new Translate("", $conf);
                  $outputlangs->setDefaultLang($newlang);
                }
                $ret = $invoice->fetch($facid); // Reload to get new records
                $result = $invoice->generateDocument($invoice->model_pdf, $outputlangs);
                if ($result < 0) {
                  setEventMessages($invoice->error, $invoice->errors, 'errors');
                  $error++;
                }
              }
            } else {
              $this->error = $this->db->lasterror();
              $error++;
            }
          } else {
            dol_syslog(get_class($this).'::Create Amount line '.$key.' not a number. We discard it.');
          }
        }

        if (!$error)
        {
          // Call trigger
          $result = $this->call_trigger('PAYMENT_SUPPLIER_CREATE', $user);
          if ($result < 0) $error++;
          // End call triggers
        }
      } else {
        $this->error = $this->db->lasterror();
        $error++;
      }
    } else {
      $this->error = "ErrorTotalIsNull";
      dol_syslog('PaiementFourn::Create Error '.$this->error, LOG_ERR);
      $error++;
    }

    if ($totalamount <> 0 && $error == 0) // On accepte les montants negatifs
    {
      $this->amount = $total;
      $this->total = $total;
      $this->multicurrency_amount = $mtotal;
      $this->db->commit();
      dol_syslog('PaiementFourn::Create Ok Total = '.$this->total);
      return $this->id;
    } else {
      $this->db->rollback();
      return -1;
    }
  }


  public function delete($notrigger = 0)
  {
    global $conf, $user, $langs;

    $bank_line_id = $this->bank_line;

    $this->db->begin();

    // Verifier si paiement porte pas sur une facture a l'etat payee
    // Si c'est le cas, on refuse la suppression
    $billsarray = $this->getBillsArray('paye=1');
    if (is_array($billsarray))
    {
      if (count($billsarray))
      {
        $this->error = "ErrorCantDeletePaymentSharedWithPayedInvoice";
        $this->db->rollback();
        return -1;
      }
    } else {
      $this->db->rollback();
      return -2;
    }

    // Verifier si paiement ne porte pas sur ecriture bancaire rapprochee
    // Si c'est le cas, on refuse le delete
    if ($bank_line_id)
    {
      $accline = new AccountLine($this->db);
      $accline->fetch($bank_line_id);
      if ($accline->rappro)
      {
        $this->error = "ErrorCantDeletePaymentReconciliated";
        $this->db->rollback();
        return -3;
      }
    }

    // Efface la ligne de paiement (dans paiement_facture et paiement)
    $sql = 'DELETE FROM '.MAIN_DB_PREFIX.'paiementfourn_facturefourn';
    $sql .= ' WHERE fk_paiementfourn = '.$this->id;
    $resql = $this->db->query($sql);
    if ($resql)
    {
      $sql = 'DELETE FROM '.MAIN_DB_PREFIX.'paiementfourn';
      $sql .= ' WHERE rowid = '.$this->id;
      $result = $this->db->query($sql);
      if (!$result)
      {
        $this->error = $this->db->error();
        $this->db->rollback();
        return -3;
      }

      // Supprimer l'ecriture bancaire si paiement lie a ecriture
      if ($bank_line_id)
      {
        $accline = new AccountLine($this->db);
        $result = $accline->fetch($bank_line_id);
        if ($result > 0) // If result = 0, record not found, we don't try to delete
        {
          $result = $accline->delete($user);
        }
        if ($result < 0)
        {
          $this->error = $accline->error;
          $this->db->rollback();
          return -4;
        }
      }

      if (!$notrigger)
      {
        // Appel des triggers
        $result = $this->call_trigger('PAYMENT_SUPPLIER_DELETE', $user);
        if ($result < 0)
        {
          $this->db->rollback();
          return -1;
        }
        // Fin appel triggers
      }

      $this->db->commit();
      return 1;
    } else {
      $this->error = $this->db->error;
      $this->db->rollback();
      return -5;
    }
  }

  public function info($id)
  {
    $sql = 'SELECT c.rowid, datec, fk_user_author as fk_user_creat, tms';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'paiementfourn as c';
    $sql .= ' WHERE c.rowid = '.$id;

    $resql = $this->db->query($sql);
    if ($resql)
    {
      $num = $this->db->num_rows($resql);
      if ($num)
      {
        $obj = $this->db->fetch_object($resql);
        $this->id = $obj->rowid;

        if ($obj->fk_user_creat)
        {
          $cuser = new User($this->db);
          $cuser->fetch($obj->fk_user_creat);
          $this->user_creation = $cuser;
        }
        if ($obj->fk_user_modif)
        {
          $muser = new User($this->db);
          $muser->fetch($obj->fk_user_modif);
          $this->user_modification = $muser;
        }
        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->tms);
      }
      $this->db->free($resql);
    } else {
      dol_print_error($this->db);
    }
  }

  public function getBillsArray($filter = '')
  {
    $sql = 'SELECT fk_facturefourn';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'paiementfourn_facturefourn as pf, '.MAIN_DB_PREFIX.'facture_fourn as f';
    $sql .= ' WHERE pf.fk_facturefourn = f.rowid AND fk_paiementfourn = '.$this->id;
    if ($filter) $sql .= ' AND '.$filter;

    dol_syslog(get_class($this).'::getBillsArray', LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql)
    {
      $i = 0;
      $num = $this->db->num_rows($resql);
      $billsarray = array();

      while ($i < $num)
      {
        $obj = $this->db->fetch_object($resql);
        $billsarray[$i] = $obj->fk_facturefourn;
        $i++;
      }

      return $billsarray;
    } else {
      $this->error = $this->db->error();
      dol_syslog(get_class($this).'::getBillsArray Error '.$this->error);
      return -1;
    }
  }

  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->statut, $mode);
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;

    $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'),'statut1').' '.$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'),'statut1');
      if ($status == 1) return img_picto($langs->trans('Validated'),'statut4');
    }
    if ($mode == 4)
    {
      if ($status == 0) return img_picto($langs->trans('ToValidate'),'statut1').' '.$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'),'statut1');
      if ($status == 1) return $langs->trans('Validated').' '.img_picto($langs->trans('Validated'),'statut4');
    }
    if ($mode == 6)
    {
      if ($status == 0) return $langs->trans('ToValidate').' '.img_picto($langs->trans('ToValidate'),'statut1');
      if ($status == 1) return $langs->trans('Validated').' '.img_picto($langs->trans('Validated'),'statut4');
    }*/
    return '';
  }


  public function getNomUrl($withpicto = 0, $option = '', $mode = 'withlistofinvoices', $notooltip = 0)
  {
    global $langs;

    $result = '';

    $text = $this->ref; // Sometimes ref contains label
    $reg = array();
    if (preg_match('/^\((.*)\)$/i', $text, $reg)) {
      // Label generique car entre parentheses. On l'affiche en le traduisant
      if ($reg[1] == 'paiement') $reg[1] = 'Payment';
      $text = $langs->trans($reg[1]);
    }

    $label = '<u>'.$langs->trans("Payment").'</u><br>';
    $label .= '<strong>'.$langs->trans("Ref").':</strong> '.$text;
    if ($this->datepaye ? $this->datepaye : $this->date) $label .= '<br><strong>'.$langs->trans("Date").':</strong> '.dol_print_date($this->datepaye ? $this->datepaye : $this->date, 'dayhour');

    $linkstart = '<a href="'.DOL_URL_ROOT.'/fourn/paiement/card.php?id='.$this->id.'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip">';
    $linkend = '</a>';

    $result .= $linkstart;
    if ($withpicto) $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
    if ($withpicto != 2) $result .= $this->ref;
    $result .= $linkend;

    return $result;
  }

  public function initAsSpecimen($option = '')
  {
    global $user, $langs, $conf;

    $now = dol_now();
    $arraynow = dol_getdate($now);
    $nownotime = dol_mktime(0, 0, 0, $arraynow['mon'], $arraynow['mday'], $arraynow['year']);

    // Initialize parameters
    $this->id = 0;
    $this->ref = 'SPECIMEN';
    $this->specimen = 1;
    $this->facid = 1;
    $this->socid = 1;
    $this->datepaye = $nownotime;
  }

  public function getNextNumRef($soc, $mode = 'next')
  {
    global $conf, $db, $langs;
    $langs->load("bills");

    // Clean parameters (if not defined or using deprecated value)
    if (empty($conf->global->SUPPLIER_PAYMENT_ADDON)) $conf->global->SUPPLIER_PAYMENT_ADDON = 'mod_supplier_payment_bronan';
    elseif ($conf->global->SUPPLIER_PAYMENT_ADDON == 'brodator') $conf->global->SUPPLIER_PAYMENT_ADDON = 'mod_supplier_payment_brodator';
    elseif ($conf->global->SUPPLIER_PAYMENT_ADDON == 'bronan') $conf->global->SUPPLIER_PAYMENT_ADDON = 'mod_supplier_payment_bronan';

    if (!empty($conf->global->SUPPLIER_PAYMENT_ADDON))
    {
      $mybool = false;

      $file = $conf->global->SUPPLIER_PAYMENT_ADDON.".php";
      $classname = $conf->global->SUPPLIER_PAYMENT_ADDON;

      // Include file with class
      $dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);

      foreach ($dirmodels as $reldir) {
        $dir = dol_buildpath($reldir."core/modules/supplier_payment/");

        // Load file with numbering class (if found)
        if (is_file($dir.$file) && is_readable($dir.$file))
        {
          $mybool |= include_once $dir.$file;
        }
      }

      // For compatibility
      if ($mybool === false) {
        $file = $conf->global->SUPPLIER_PAYMENT_ADDON.".php";
        $classname = "mod_supplier_payment_".$conf->global->SUPPLIER_PAYMENT_ADDON;
        $classname = preg_replace('/\-.*$/', '', $classname);
        // Include file with class
        foreach ($conf->file->dol_document_root as $dirroot) {
          $dir = $dirroot."/core/modules/supplier_payment/";

          // Load file with numbering class (if found)
          if (is_file($dir.$file) && is_readable($dir.$file)) {
            $mybool |= include_once $dir.$file;
          }
        }
      }

      if ($mybool === false) {
        dol_print_error('', "Failed to include file ".$file);
        return '';
      }

      $obj = new $classname();
      $numref = "";
      $numref = $obj->getNextValue($soc, $this);

      if ($mode != 'last' && !$numref) {
        dol_print_error($db, "SupplierPayment::getNextNumRef ".$obj->error);
        return "";
      }

      return $numref;
    } else {
      $langs->load("errors");
      print $langs->trans("Error")." ".$langs->trans("ErrorModuleSetupNotComplete", $langs->transnoentitiesnoconv("Supplier"));
      return "";
    }
  }

  public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null)
  {
    global $conf, $user, $langs;

    $langs->load("suppliers");

    // Set the model on the model name to use
    if (empty($modele))
    {
      if (!empty($conf->global->SUPPLIER_PAYMENT_ADDON_PDF))
      {
        $modele = $conf->global->SUPPLIER_PAYMENT_ADDON_PDF;
      } else {
        $modele = ''; // No default value. For supplier invoice, we allow to disable all PDF generation
      }
    }

    if (empty($modele))
    {
      return 0;
    } else {
      $modelpath = "core/modules/supplier_payment/doc/";

      return $this->commonGenerateDocument($modelpath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams);
    }
  }



  public function getWay()
  {
    global $conf;

    $way = 'dolibarr';
    if (!empty($conf->multicurrency->enabled))
    {
      foreach ($this->multicurrency_amounts as $value)
      {
        if (!empty($value)) // one value found then payment is in invoice currency
        {
          $way = 'customer';
          break;
        }
      }
    }

    return $way;
  }


  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_thirdparty($force_thirdparty_id = 0)
  {
    // phpcs:enable
    require_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.facture.class.php';

    if (empty($force_thirdparty_id))
    {
      $billsarray = $this->getBillsArray(); // From payment, the fk_soc isn't available, we should load the first supplier invoice to get him
      if (!empty($billsarray))
      {
        $supplier_invoice = new FactureFournisseur($this->db);
        if ($supplier_invoice->fetch($billsarray[0]) > 0)
        {
          $force_thirdparty_id = $supplier_invoice->fk_soc;
        }
      }
    }

    return parent::fetch_thirdparty($force_thirdparty_id);
  }
}