paiement.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2002-2004  Rodolphe Quiedeville    <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2010  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2005       Marc Barilley / Ocebo   <marc@ocebo.com>
 * Copyright (C) 2012      Cédric Salvador       <csalvador@gpcsolutions.fr>
 * Copyright (C) 2014      Raphaël Doursenaud    <rdoursenaud@gpcsolutions.fr>
 * Copyright (C) 2014      Marcos García     <marcosgdf@gmail.com>
 * Copyright (C) 2015      Juanjo Menent     <jmenent@2byte.es>
 * Copyright (C) 2018      Ferran Marcet     <fmarcet@2byte.es>
 * Copyright (C) 2018      Thibault FOUCART    <support@ptibogxiv.net>
 * Copyright (C) 2018       Frédéric France         <frederic.france@netlogic.fr>
 * Copyright (C) 2020      Andreu Bisquerra Gaya <jove@bisquerra.com>
 *
 * 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.'/core/class/commonobject.class.php';
require_once DOL_DOCUMENT_ROOT.'/multicurrency/class/multicurrency.class.php';


class Paiement extends CommonObject
{
  public $element = 'payment';

  public $table_element = 'paiement';

  public $picto = 'payment';

  public $facid;
  public $datepaye;

  public $total;

  public $montant;

  public $amount; // Total amount of payment (in the main currency)
  public $multicurrency_amount; // Total amount of payment (in the currency of the bank account)
  public $amounts = array(); // array: invoice ID => amount for that invoice (in the main currency)>
  public $multicurrency_amounts = array(); // array: invoice ID => amount for that invoice (in the invoice's currency)>

  public $pos_change = 0; // Excess received in TakePOS cash payment

  public $author;
  public $paiementid; // Type of payment. Id saved into fields fk_paiement on llx_paiement
  public $paiementcode; // Code of payment.

  public $type_label;

  public $type_code;

  public $num_paiement;

  public $num_payment;

  public $ext_payment_id;

  public $ext_payment_site;

  public $bank_account;

  public $fk_account;

  public $bank_line;

  // 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 $fk_paiement; // Type of payment

  public $ref_ext;

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

  public function fetch($id, $ref = '', $fk_bank = '')
  {
    $sql = 'SELECT p.rowid, p.ref, p.ref_ext, p.datep as dp, p.amount, p.statut, p.ext_payment_id, p.ext_payment_site, p.fk_bank, p.multicurrency_amount,';
    $sql .= ' c.code as type_code, c.libelle as type_label,';
    $sql .= ' p.num_paiement as num_payment, p.note,';
    $sql .= ' b.fk_account';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'paiement as p 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('invoice').')';
    if ($id > 0)
      $sql .= ' AND p.rowid = '.$id;
    elseif ($ref)
      $sql .= " AND p.ref = '".$ref."'";
    elseif ($fk_bank)
      $sql .= ' AND p.fk_bank = '.$fk_bank;

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

        $this->id             = $obj->rowid;
        $this->ref            = $obj->ref ? $obj->ref : $obj->rowid;
        $this->ref_ext        = $obj->ref_ext;
        $this->date           = $this->db->jdate($obj->dp);
        $this->datepaye       = $this->db->jdate($obj->dp);
        $this->num_payment    = $obj->num_payment;
        $this->montant        = $obj->amount; // deprecated
        $this->amount         = $obj->amount;
        $this->multicurrency_amount = $obj->multicurrency_amount;
        $this->note           = $obj->note;
        $this->type_label = $obj->type_label;
        $this->type_code      = $obj->type_code;
        $this->statut         = $obj->statut;
        $this->ext_payment_id = $obj->ext_payment_id;
        $this->ext_payment_site = $obj->ext_payment_site;

        $this->bank_account   = $obj->fk_account; // deprecated
        $this->fk_account     = $obj->fk_account;
        $this->bank_line      = $obj->fk_bank;

        $this->db->free($resql);
        return 1;
      } else {
        $this->db->free($resql);
        return 0;
      }
    } else {
      dol_print_error($this->db);
      return -1;
    }
  }

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

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

    $now = dol_now();

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

    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)  // How payment is dispatch
    {
      $value_converted = Multicurrency::getAmountConversionFromInvoiceRate($key, $value, $way);
      $totalamount_converted += $value_converted;
      $amounts_to_update[$key] = price2num($value_converted, 'MT');

      $newvalue = price2num($value, 'MT');
      $amounts[$key] = $newvalue;
      $totalamount += $newvalue;
      if (!empty($newvalue)) $atleastonepaymentnotnull++;
    }

    $totalamount = price2num($totalamount);
    $totalamount_converted = price2num($totalamount_converted);

    // Check parameters
    if (empty($totalamount) && empty($atleastonepaymentnotnull))   // We accept negative amounts for withdraw reject but not empty arrays
    {
      $this->errors[] = 'TotalAmountEmpty';
      $this->error = 'TotalAmountEmpty';
      return -1;
    }

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

    $this->db->begin();

    $this->ref = $this->getNextNumRef(is_object($thirdparty) ? $thirdparty : '');

    if (empty($this->ref_ext)) {
      $this->ref_ext = '';
    }

    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;
    }

    $num_payment = $this->num_payment;
    $note = ($this->note_private ? $this->note_private : $this->note);

    $sql = "INSERT INTO ".MAIN_DB_PREFIX."paiement (entity, ref, ref_ext, datec, datep, amount, multicurrency_amount, fk_paiement, num_paiement, note, ext_payment_id, ext_payment_site, fk_user_creat, pos_change)";
    $sql .= " VALUES (".$conf->entity.", '".$this->db->escape($this->ref)."', '".$this->db->escape($this->ref_ext)."', '".$this->db->idate($now)."', '".$this->db->idate($this->datepaye)."', ".$total.", ".$mtotal.", ".$this->paiementid.", ";
    $sql .= "'".$this->db->escape($num_payment)."', '".$this->db->escape($note)."', ".($this->ext_payment_id ? "'".$this->db->escape($this->ext_payment_id)."'" : "null").", ".($this->ext_payment_site ? "'".$this->db->escape($this->ext_payment_site)."'" : "null").", ".$user->id.", ".((float) $this->pos_change).")";

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

      // Insert links amount / invoices
      foreach ($this->amounts as $key => $amount)
      {
        $facid = $key;
        if (is_numeric($amount) && $amount <> 0)
        {
          $amount = price2num($amount);
          $sql = 'INSERT INTO '.MAIN_DB_PREFIX.'paiement_facture (fk_facture, fk_paiement, amount, multicurrency_amount)';
          $sql .= ' VALUES ('.$facid.', '.$this->id.', \''.$amount.'\', \''.$this->multicurrency_amounts[$key].'\')';

          dol_syslog(get_class($this).'::create Amount line '.$key.' insert paiement_facture', LOG_DEBUG);
          $resql = $this->db->query($sql);
          if ($resql)
          {
            $invoice = new Facture($this->db);
            $invoice->fetch($facid);

            // If we want to closed payed invoices
            if ($closepaidinvoices)
            {
              $paiement = $invoice->getSommePaiement();
              $creditnotes = $invoice->getSumCreditNotesUsed();
              $deposits = $invoice->getSumDepositsUsed();
              $alreadypayed = price2num($paiement + $creditnotes + $deposits, 'MT');
              $remaintopay = price2num($invoice->total_ttc - $paiement - $creditnotes - $deposits, 'MT');

              //var_dump($invoice->total_ttc.' - '.$paiement.' -'.$creditnotes.' - '.$deposits.' - '.$remaintopay);exit;

              //Invoice types that are eligible for changing status to paid
              $affected_types = array(
                Facture::TYPE_STANDARD,
                Facture::TYPE_REPLACEMENT,
                Facture::TYPE_CREDIT_NOTE,
                Facture::TYPE_DEPOSIT,
                Facture::TYPE_SITUATION
              );

              if (!in_array($invoice->type, $affected_types)) dol_syslog("Invoice ".$facid." is not a standard, nor replacement invoice, nor credit note, nor deposit invoice, nor situation invoice. We do nothing more.");
              elseif ($remaintopay) dol_syslog("Remain to pay for invoice ".$facid." not null. We do nothing more.");
              //else if ($mustwait) dol_syslog("There is ".$mustwait." differed payment to process, we do nothing more.");
              else {
                // If invoice is a down payment, we also convert down payment to discount
                if ($invoice->type == Facture::TYPE_DEPOSIT)
                {
                  $amount_ht = $amount_tva = $amount_ttc = array();
                  $multicurrency_amount_ht = $multicurrency_amount_tva = $multicurrency_amount_ttc = array();

                  // Insert one discount by VAT rate category
                  $discount = new DiscountAbsolute($this->db);
                  $discount->fetch('', $invoice->id);
                  if (empty($discount->id)) { // If the invoice was not yet converted into a discount (this may have been done manually before we come here)
                    $discount->description = '(DEPOSIT)';
                    $discount->fk_soc = $invoice->socid;
                    $discount->fk_facture_source = $invoice->id;

                    // Loop on each vat rate
                    $i = 0;
                    foreach ($invoice->lines as $line) {
                      if ($line->total_ht != 0) {    // no need to create discount if amount is null
                        $amount_ht[$line->tva_tx] += $line->total_ht;
                        $amount_tva[$line->tva_tx] += $line->total_tva;
                        $amount_ttc[$line->tva_tx] += $line->total_ttc;
                        $multicurrency_amount_ht[$line->tva_tx] += $line->multicurrency_total_ht;
                        $multicurrency_amount_tva[$line->tva_tx] += $line->multicurrency_total_tva;
                        $multicurrency_amount_ttc[$line->tva_tx] += $line->multicurrency_total_ttc;
                        $i++;
                      }
                    }

                    foreach ($amount_ht as $tva_tx => $xxx) {
                      $discount->amount_ht = abs($amount_ht[$tva_tx]);
                      $discount->amount_tva = abs($amount_tva[$tva_tx]);
                      $discount->amount_ttc = abs($amount_ttc[$tva_tx]);
                      $discount->multicurrency_amount_ht = abs($multicurrency_amount_ht[$tva_tx]);
                      $discount->multicurrency_amount_tva = abs($multicurrency_amount_tva[$tva_tx]);
                      $discount->multicurrency_amount_ttc = abs($multicurrency_amount_ttc[$tva_tx]);
                      $discount->tva_tx = abs($tva_tx);

                      $result = $discount->create($user);
                      if ($result < 0) {
                        $error++;
                        break;
                      }
                    }
                  }

                  if ($error)
                  {
                    setEventMessages($discount->error, $discount->errors, 'errors');
                    $error++;
                  }
                }

                // Set invoice to paid
                if (!$error)
                {
                  $result = $invoice->set_paid($user, '', '');
                  if ($result < 0)
                  {
                    $this->error = $invoice->error;
                    $this->errors = $invoice->errors;
                    $error++;
                  }
                }
              }
            }

            // Regenerate documents of invoices
            if (empty($conf->global->MAIN_DISABLE_PDF_AUTOUPDATE))
            {
              dol_syslog(get_class($this).'::create Regenerate the document after inserting payment for thirdparty default_lang='.(is_object($invoice->thirdparty) ? $invoice->thirdparty->default_lang : 'null'), LOG_DEBUG);

              $newlang = '';
              $outputlangs = $langs;
              if ($conf->global->MAIN_MULTILANGS && empty($newlang)) {
                $invoice->fetch_thirdparty();
                $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->modelpdf, $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)    // All payments into $this->amounts were recorded without errors
      {
        // Appel des triggers
        $result = $this->call_trigger('PAYMENT_CUSTOMER_CREATE', $user);
        if ($result < 0) { $error++; }
        // Fin appel triggers
      }
    } else {
      $this->error = $this->db->lasterror();
      $error++;
    }

    if (!$error)
    {
      $this->amount = $total;
      $this->total = $total; // deprecated
      $this->multicurrency_amount = $mtotal;
      $this->db->commit();
      return $this->id;
    } else {
      $this->db->rollback();
      return -1;
    }
  }


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

    $error = 0;

    $bank_line_id = $this->bank_line;

    $this->db->begin();

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

    // Delete bank urls. If payment is on a conciliated line, return error.
    if ($bank_line_id > 0)
    {
      $accline = new AccountLine($this->db);

      $result = $accline->fetch($bank_line_id);
      if ($result == 0) {
        $accline->id = $accline->rowid = $bank_line_id; // If not found, we set artificially rowid to allow delete of llx_bank_url
      }

      // Delete bank account url lines linked to payment
      $result = $accline->delete_urls($user);
      if ($result < 0)
      {
        $this->error = $accline->error;
        $this->db->rollback();
        return -3;
      }

      // Delete bank account lines linked to payment
      $result = $accline->delete($user);
      if ($result < 0)
      {
        $this->error = $accline->error;
        $this->db->rollback();
        return -4;
      }
    }

    if (!$notrigger)
    {
      // Call triggers
      $result = $this->call_trigger('PAYMENT_CUSTOMER_DELETE', $user);
      if ($result < 0)
      {
        $this->db->rollback();
        return -1;
      }
      // End call triggers
    }

    // Delete payment (into paiement_facture and paiement)
    $sql = 'DELETE FROM '.MAIN_DB_PREFIX.'paiement_facture';
    $sql .= ' WHERE fk_paiement = '.$this->id;
    dol_syslog($sql);
    $result = $this->db->query($sql);
    if ($result)
    {
      $sql = 'DELETE FROM '.MAIN_DB_PREFIX.'paiement';
      $sql .= ' WHERE rowid = '.$this->id;
      dol_syslog($sql);
      $result = $this->db->query($sql);
      if (!$result)
      {
        $this->error = $this->db->lasterror();
        $this->db->rollback();
        return -3;
      }

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


  public function addPaymentToBank($user, $mode, $label, $accountid, $emetteur_nom, $emetteur_banque, $notrigger = 0, $accountancycode = '')
  {
    global $conf, $langs, $user;

    $error = 0;
    $bank_line_id = 0;

    if (!empty($conf->banque->enabled))
    {
      if ($accountid <= 0)
      {
        $this->error = 'Bad value for parameter accountid='.$accountid;
        dol_syslog(get_class($this).'::addPaymentToBank '.$this->error, LOG_ERR);
        return -1;
      }

      $this->db->begin();

      $this->fk_account = $accountid;

      include_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php';

      dol_syslog("$user->id, $mode, $label, $this->fk_account, $emetteur_nom, $emetteur_banque");

      $acc = new Account($this->db);
      $result = $acc->fetch($this->fk_account);

      $totalamount = $this->amount;
      if (empty($totalamount)) $totalamount = $this->total; // For backward compatibility

      // if dolibarr currency != bank currency then we received an amount in customer currency (currently I don't manage the case : my currency is USD, the customer currency is EUR and he paid me in GBP. Seems no sense for me)
      if (!empty($conf->multicurrency->enabled) && $conf->currency != $acc->currency_code) $totalamount = $this->multicurrency_amount;

      if ($mode == 'payment_supplier') $totalamount = -$totalamount;

      // Insert payment into llx_bank
      $bank_line_id = $acc->addline(
        $this->datepaye,
        $this->paiementid, // Payment mode id or code ("CHQ or VIR for example")
        $label,
        $totalamount, // Sign must be positive when we receive money (customer payment), negative when you give money (supplier invoice or credit note)
        $this->num_payment,
        '',
        $user,
        $emetteur_nom,
        $emetteur_banque,
        $accountancycode
      );

      // Mise a jour fk_bank dans llx_paiement
      // On connait ainsi le paiement qui a genere l'ecriture bancaire
      if ($bank_line_id > 0)
      {
        $result = $this->update_fk_bank($bank_line_id);
        if ($result <= 0)
        {
          $error++;
          dol_print_error($this->db);
        }

        // Add link 'payment', 'payment_supplier' in bank_url between payment and bank transaction
        if (!$error)
        {
          $url = '';
          if ($mode == 'payment') $url = DOL_URL_ROOT.'/compta/paiement/card.php?id=';
          if ($mode == 'payment_supplier') $url = DOL_URL_ROOT.'/fourn/paiement/card.php?id=';
          if ($url)
          {
            $result = $acc->add_url_line($bank_line_id, $this->id, $url, '(paiement)', $mode);
            if ($result <= 0)
            {
              $error++;
              dol_print_error($this->db);
            }
          }
        }

        // Add link 'company' in bank_url between invoice and bank transaction (for each invoice concerned by payment)
        //if (! $error && $label != '(WithdrawalPayment)')
        if (!$error)
        {
          $linkaddedforthirdparty = array();
          foreach ($this->amounts as $key => $value)  // We should have invoices always for same third party but we loop in case of.
          {
            if ($mode == 'payment')
            {
              $fac = new Facture($this->db);
              $fac->fetch($key);
              $fac->fetch_thirdparty();
              if (!in_array($fac->thirdparty->id, $linkaddedforthirdparty)) // Not yet done for this thirdparty
              {
                $result = $acc->add_url_line(
                  $bank_line_id,
                  $fac->thirdparty->id,
                  DOL_URL_ROOT.'/comm/card.php?socid=',
                  $fac->thirdparty->name,
                  'company'
                );
                if ($result <= 0) dol_syslog(get_class($this).'::addPaymentToBank '.$this->db->lasterror());
                $linkaddedforthirdparty[$fac->thirdparty->id] = $fac->thirdparty->id; // Mark as done for this thirdparty
              }
            }
            if ($mode == 'payment_supplier')
            {
              $fac = new FactureFournisseur($this->db);
              $fac->fetch($key);
              $fac->fetch_thirdparty();
              if (!in_array($fac->thirdparty->id, $linkaddedforthirdparty)) // Not yet done for this thirdparty
              {
                $result = $acc->add_url_line(
                  $bank_line_id,
                  $fac->thirdparty->id,
                  DOL_URL_ROOT.'/fourn/card.php?socid=',
                  $fac->thirdparty->name,
                  'company'
                );
                if ($result <= 0) dol_syslog(get_class($this).'::addPaymentToBank '.$this->db->lasterror());
                $linkaddedforthirdparty[$fac->thirdparty->id] = $fac->thirdparty->id; // Mark as done for this thirdparty
              }
            }
          }
        }

        // Add link 'WithdrawalPayment' in bank_url
        if (!$error && $label == '(WithdrawalPayment)') {
          $result = $acc->add_url_line(
            $bank_line_id,
            $this->id_prelevement,
            DOL_URL_ROOT.'/compta/prelevement/card.php?id=',
            $this->num_payment,
            'withdraw'
          );
        }

        if (!$error && !$notrigger)
        {
          // Appel des triggers
          $result = $this->call_trigger('PAYMENT_ADD_TO_BANK', $user);
          if ($result < 0) { $error++; }
          // Fin appel triggers
        }
      } else {
        $this->error = $acc->error;
        $error++;
      }

      if (!$error)
      {
        $this->db->commit();
      } else {
        $this->db->rollback();
      }
    }

    if (!$error)
    {
      return $bank_line_id;
    } else {
      return -1;
    }
  }


  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function update_fk_bank($id_bank)
  {
    // phpcs:enable
    $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element.' set fk_bank = '.$id_bank;
    $sql .= ' WHERE rowid = '.$this->id;

    dol_syslog(get_class($this).'::update_fk_bank', LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result)
    {
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      dol_syslog(get_class($this).'::update_fk_bank '.$this->error);
      return -1;
    }
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function update_date($date)
  {
    // phpcs:enable
    $error = 0;

    if (!empty($date) && $this->statut != 1)
    {
      $this->db->begin();

      dol_syslog(get_class($this)."::update_date with date = ".$date, LOG_DEBUG);

      $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
      $sql .= " SET datep = '".$this->db->idate($date)."'";
      $sql .= " WHERE rowid = ".$this->id;

      $result = $this->db->query($sql);
      if (!$result)
      {
        $error++;
        $this->error = 'Error -1 '.$this->db->error();
      }

      $type = $this->element;

      $sql = "UPDATE ".MAIN_DB_PREFIX.'bank';
      $sql .= " SET dateo = '".$this->db->idate($date)."', datev = '".$this->db->idate($date)."'";
      $sql .= " WHERE rowid IN (SELECT fk_bank FROM ".MAIN_DB_PREFIX."bank_url WHERE type = '".$this->db->escape($type)."' AND url_id = ".$this->id.")";
      $sql .= " AND rappro = 0";

      $result = $this->db->query($sql);
      if (!$result)
      {
        $error++;
        $this->error = 'Error -1 '.$this->db->error();
      }

      if (!$error)
      {
      }

      if (!$error)
      {
        $this->datepaye = $date;
        $this->date = $date;

        $this->db->commit();
        return 0;
      } else {
        $this->db->rollback();
        return -2;
      }
    }
    return -1; //no date given or already validated
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function update_num($num)
  {
    // phpcs:enable
    if (!empty($num) && $this->statut != 1) {
      $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
      $sql .= " SET num_paiement = '".$this->db->escape($num)."'";
      $sql .= " WHERE rowid = ".$this->id;

      dol_syslog(get_class($this)."::update_num", LOG_DEBUG);
      $result = $this->db->query($sql);
      if ($result)
      {
        $this->num_payment = $this->db->escape($num);
        return 0;
      } else {
        $this->error = 'Error -1 '.$this->db->error();
        return -2;
      }
    }
    return -1; //no num given or already validated
  }

  public function valide(User $user = null)
  {
    return $this->validate($user);
  }

  public function validate(User $user = null)
  {
    $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element.' SET statut = 1 WHERE rowid = '.$this->id;

    dol_syslog(get_class($this).'::valide', LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result)
    {
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      dol_syslog(get_class($this).'::valide '.$this->error);
      return -1;
    }
  }

  public function reject(User $user = null)
  {
    $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element.' SET statut = 2 WHERE rowid = '.$this->id;

    dol_syslog(get_class($this).'::reject', LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result)
    {
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      dol_syslog(get_class($this).'::reject '.$this->error);
      return -1;
    }
  }

  public function info($id)
  {
    $sql = 'SELECT p.rowid, p.datec, p.fk_user_creat, p.fk_user_modif, p.tms';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'paiement as p';
    $sql .= ' WHERE p.rowid = '.$id;

    dol_syslog(get_class($this).'::info', LOG_DEBUG);
    $result = $this->db->query($sql);

    if ($result)
    {
      if ($this->db->num_rows($result))
      {
        $obj = $this->db->fetch_object($result);
        $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($result);
    } else {
      dol_print_error($this->db);
    }
  }

  public function getBillsArray($filter = '')
  {
    $sql = 'SELECT pf.fk_facture';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'paiement_facture as pf, '.MAIN_DB_PREFIX.'facture as f'; // We keep link on invoice to allow use of some filters on invoice
    $sql .= ' WHERE pf.fk_facture = f.rowid AND pf.fk_paiement = '.$this->id;
    if ($filter) $sql .= ' AND '.$filter;
    $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_facture;
        $i++;
      }

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

  public function getAmountsArray()
  {
    $sql = 'SELECT pf.fk_facture, pf.amount';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'paiement_facture as pf';
    $sql .= ' WHERE pf.fk_paiement = '.$this->id;
    $resql = $this->db->query($sql);
    if ($resql)
    {
      $i = 0;
      $num = $this->db->num_rows($resql);
      $amounts = array();

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

      return $amounts;
    } else {
      $this->error = $this->db->error();
      dol_syslog(get_class($this).'::getAmountsArray Error '.$this->error.' -', LOG_DEBUG);
      return -1;
    }
  }

  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->PAYMENT_ADDON)) $conf->global->PAYMENT_ADDON = 'mod_payment_cicada';
    elseif ($conf->global->PAYMENT_ADDON == 'ant') $conf->global->PAYMENT_ADDON = 'mod_payment_ant';
    elseif ($conf->global->PAYMENT_ADDON == 'cicada') $conf->global->PAYMENT_ADDON = 'mod_payment_cicada';

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

      $file = $conf->global->PAYMENT_ADDON.".php";
      $classname = $conf->global->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/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)
      {
        $file = $conf->global->PAYMENT_ADDON.".php";
        $classname = "mod_payment_".$conf->global->PAYMENT_ADDON;
        $classname = preg_replace('/\-.*$/', '', $classname);
        // Include file with class
        foreach ($conf->file->dol_document_root as $dirroot)
        {
          $dir = $dirroot."/core/modules/payment/";

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

      if (!$mybool)
      {
        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, "Payment::getNextNumRef ".$obj->error);
        return "";
      }

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

  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;
  }

  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->datepaye = $nownotime;
  }


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

    if (!empty($conf->dol_no_mouse_hover)) $notooltip = 1; // Force disable tooltips

    $result = '';

    $label = img_picto('', $this->picto).' <u>'.$langs->trans("Payment").'</u><br>';
    $label .= '<strong>'.$langs->trans("Ref").':</strong> '.$this->ref;
        $dateofpayment = ($this->datepaye ? $this->datepaye : $this->date);
        if ($dateofpayment) {
          $label .= '<br><strong>'.$langs->trans("Date").':</strong> ';
          $tmparray = dol_getdate($dateofpayment);
          if ($tmparray['seconds'] == 0 && $tmparray['minutes'] == 0 && ($tmparray['hours'] == 0 || $tmparray['hours'] == 12)) {  // We set hours to 0:00 or 12:00 because we don't know it
            $label .= dol_print_date($dateofpayment, 'day');
          } else {  // Hours was set to real date of payment (special case for POS for example)
            $label .= dol_print_date($dateofpayment, 'dayhour', 'tzuser');
          }
        }
    if ($mode == 'withlistofinvoices')
    {
      $arraybill = $this->getBillsArray();
      if (is_array($arraybill) && count($arraybill) > 0)
      {
        include_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
        $facturestatic = new Facture($this->db);
        foreach ($arraybill as $billid)
        {
          $facturestatic->fetch($billid);
          $label .= '<br> '.$facturestatic->getNomUrl(1, '', 0, 0, '', 1).' '.$facturestatic->getLibStatut(2, 1);
        }
      }
    }

    $linkclose = '';
    if (empty($notooltip))
    {
      if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER))
      {
        $label = $langs->trans("ShowMyObject");
        $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
      }
      $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
      $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
    } else $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');

    $url = DOL_URL_ROOT.'/compta/paiement/card.php?id='.$this->id;

    $linkstart = '<a href="'.$url.'"';
    $linkstart .= $linkclose.'>';
    $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 && $withpicto != 2) $result .= ($this->ref ? $this->ref : $this->id);
    $result .= $linkend;

    return $result;
  }

  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; // 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'),'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 '';
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_thirdparty($force_thirdparty_id = 0)
  {
    // phpcs:enable
    include_once DOL_DOCUMENT_ROOT.'/compta/facture/class/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))
      {
        $invoice = new Facture($this->db);
        if ($invoice->fetch($billsarray[0]) > 0)
        {
          $force_thirdparty_id = $invoice->socid;
        }
      }
    }

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