paymentloan.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2014-2018  Alexandre Spangaro   <aspangaro@open-dsi.fr>
 * Copyright (C) 2015-2018  Frederic France      <frederic.france@netlogic.fr>
 * Copyright (C) 2020       Maxime DEMAREST      <maxime@indelog.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.'/core/class/commonobject.class.php';


class PaymentLoan extends CommonObject
{
  public $element = 'payment_loan';

  public $table_element = 'payment_loan';

  public $picto = 'money-bill-alt';

  public $fk_loan;

  public $datec = '';

  public $tms = '';

  public $datep = '';

  public $amounts = array(); // Array of amounts

  public $amount_capital; // Total amount of payment

  public $amount_insurance;

  public $amount_interest;

  public $fk_typepayment;

  public $num_payment;

  public $fk_bank;

  public $fk_user_creat;

  public $fk_user_modif;

  public $type_code;
  public $type_label;


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

  public function create($user)
  {
    global $conf, $langs;

    $error = 0;

    $now = dol_now();

    // Validate parameters
    if (!$this->datep)
    {
      $this->error = 'ErrorBadValueForParameter';
      return -1;
    }

    // Clean parameters
    if (isset($this->fk_loan)) $this->fk_loan = (int) $this->fk_loan;
    if (isset($this->amount_capital)) $this->amount_capital = price2num($this->amount_capital ? $this->amount_capital : 0);
    if (isset($this->amount_insurance)) $this->amount_insurance = price2num($this->amount_insurance ? $this->amount_insurance : 0);
    if (isset($this->amount_interest))  $this->amount_interest = price2num($this->amount_interest ? $this->amount_interest : 0);
    if (isset($this->fk_typepayment)) $this->fk_typepayment = (int) $this->fk_typepayment;
    if (isset($this->num_payment)) $this->num_payment = (int) $this->num_payment;
    if (isset($this->note_private))     $this->note_private = trim($this->note_private);
    if (isset($this->note_public))      $this->note_public = trim($this->note_public);
    if (isset($this->fk_bank)) $this->fk_bank = (int) $this->fk_bank;
    if (isset($this->fk_user_creat)) $this->fk_user_creat = (int) $this->fk_user_creat;
    if (isset($this->fk_user_modif)) $this->fk_user_modif = (int) $this->fk_user_modif;

    $totalamount = $this->amount_capital + $this->amount_insurance + $this->amount_interest;
    $totalamount = price2num($totalamount);

    // Check parameters
    if ($totalamount == 0) return -1; // Negative amounts are accepted for reject prelevement but not null


    $this->db->begin();

    if ($totalamount != 0)
    {
      $sql = "INSERT INTO ".MAIN_DB_PREFIX."payment_loan (fk_loan, datec, datep, amount_capital, amount_insurance, amount_interest,";
      $sql .= " fk_typepayment, num_payment, note_private, note_public, fk_user_creat, fk_bank)";
      $sql .= " VALUES (".$this->chid.", '".$this->db->idate($now)."',";
      $sql .= " '".$this->db->idate($this->datep)."',";
      $sql .= " ".$this->amount_capital.",";
      $sql .= " ".$this->amount_insurance.",";
      $sql .= " ".$this->amount_interest.",";
      $sql .= " ".$this->paymenttype.", '".$this->db->escape($this->num_payment)."', '".$this->db->escape($this->note_private)."', '".$this->db->escape($this->note_public)."', ".$user->id.",";
      $sql .= " 0)";

      dol_syslog(get_class($this)."::create", LOG_DEBUG);
      $resql = $this->db->query($sql);
      if ($resql)
      {
        $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."payment_loan");
      } else {
        $this->error = $this->db->lasterror();
        $error++;
      }
    }

    if ($totalamount != 0 && !$error)
    {
      $this->amount_capital = $totalamount;
      $this->db->commit();
      return $this->id;
    } else {
      $this->error = $this->db->lasterror();
      $this->db->rollback();
      return -1;
    }
  }

  public function fetch($id)
  {
    global $langs;
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.fk_loan,";
    $sql .= " t.datec,";
    $sql .= " t.tms,";
    $sql .= " t.datep,";
    $sql .= " t.amount_capital,";
    $sql .= " t.amount_insurance,";
    $sql .= " t.amount_interest,";
    $sql .= " t.fk_typepayment,";
    $sql .= " t.num_payment,";
    $sql .= " t.note_private,";
    $sql .= " t.note_public,";
    $sql .= " t.fk_bank,";
    $sql .= " t.fk_user_creat,";
    $sql .= " t.fk_user_modif,";
    $sql .= " pt.code as type_code, pt.libelle as type_label,";
    $sql .= ' b.fk_account';
    $sql .= " FROM ".MAIN_DB_PREFIX."payment_loan as t";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."c_paiement as pt ON t.fk_typepayment = pt.id";
    $sql .= ' LEFT JOIN '.MAIN_DB_PREFIX.'bank as b ON t.fk_bank = b.rowid';
    $sql .= " WHERE t.rowid = ".$id;

    dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
    $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->rowid;

        $this->fk_loan = $obj->fk_loan;
        $this->datec = $this->db->jdate($obj->datec);
        $this->tms = $this->db->jdate($obj->tms);
        $this->datep = $this->db->jdate($obj->datep);
        $this->amount_capital = $obj->amount_capital;
        $this->amount_insurance = $obj->amount_insurance;
        $this->amount_interest = $obj->amount_interest;
        $this->fk_typepayment = $obj->fk_typepayment;
        $this->num_payment = $obj->num_payment;
        $this->note_private = $obj->note_private;
        $this->note_public = $obj->note_public;
        $this->fk_bank = $obj->fk_bank;
        $this->fk_user_creat = $obj->fk_user_creat;
        $this->fk_user_modif = $obj->fk_user_modif;

        $this->type_code = $obj->type_code;
        $this->type_label = $obj->type_label;

        $this->bank_account = $obj->fk_account;
        $this->bank_line = $obj->fk_bank;
      }
      $this->db->free($resql);

      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }


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

    // Clean parameters
    if (isset($this->fk_loan)) $this->fk_loan = (int) $this->fk_loan;
    if (isset($this->amount_capital)) $this->amount_capital = trim($this->amount_capital);
    if (isset($this->amount_insurance)) $this->amount_insurance = trim($this->amount_insurance);
    if (isset($this->amount_interest)) $this->amount_interest = trim($this->amount_interest);
    if (isset($this->fk_typepayment)) $this->fk_typepayment = (int) $this->fk_typepayment;
    if (isset($this->num_payment)) $this->num_payment = (int) $this->num_payment;
    if (isset($this->note_private)) $this->note = trim($this->note_private);
    if (isset($this->note_public)) $this->note = trim($this->note_public);
    if (isset($this->fk_bank)) $this->fk_bank = (int) $this->fk_bank;
    if (isset($this->fk_user_creat)) $this->fk_user_creat = (int) $this->fk_user_creat;
    if (isset($this->fk_user_modif)) $this->fk_user_modif = (int) $this->fk_user_modif;

    // Check parameters

    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX."payment_loan SET";

    $sql .= " fk_loan=".(isset($this->fk_loan) ? $this->fk_loan : "null").",";
    $sql .= " datec=".(dol_strlen($this->datec) != 0 ? "'".$this->db->idate($this->datec)."'" : 'null').",";
    $sql .= " tms=".(dol_strlen($this->tms) != 0 ? "'".$this->db->idate($this->tms)."'" : 'null').",";
    $sql .= " datep=".(dol_strlen($this->datep) != 0 ? "'".$this->db->idate($this->datep)."'" : 'null').",";
    $sql .= " amount_capital=".(isset($this->amount_capital) ? $this->amount_capital : "null").",";
    $sql .= " amount_insurance=".(isset($this->amount_insurance) ? $this->amount_insurance : "null").",";
    $sql .= " amount_interest=".(isset($this->amount_interest) ? $this->amount_interest : "null").",";
    $sql .= " fk_typepayment=".(isset($this->fk_typepayment) ? $this->fk_typepayment : "null").",";
    $sql .= " num_payment=".(isset($this->num_payment) ? "'".$this->db->escape($this->num_payment)."'" : "null").",";
    $sql .= " note_private=".(isset($this->note_private) ? "'".$this->db->escape($this->note_private)."'" : "null").",";
    $sql .= " note_public=".(isset($this->note_public) ? "'".$this->db->escape($this->note_public)."'" : "null").",";
    $sql .= " fk_bank=".(isset($this->fk_bank) ? $this->fk_bank : "null").",";
    $sql .= " fk_user_creat=".(isset($this->fk_user_creat) ? $this->fk_user_creat : "null").",";
    $sql .= " fk_user_modif=".(isset($this->fk_user_modif) ? $this->fk_user_modif : "null")."";

    $sql .= " WHERE rowid=".$this->id;

    $this->db->begin();

    dol_syslog(get_class($this)."::update", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) { $error++; $this->errors[] = "Error ".$this->db->lasterror(); }

    // Commit or rollback
    if ($error)
    {
      foreach ($this->errors as $errmsg)
      {
        dol_syslog(get_class($this)."::update ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return 1;
    }
  }


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

    $this->db->begin();

    if (!$error)
    {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX."bank_url";
      $sql .= " WHERE type='payment_loan' AND url_id=".$this->id;

      dol_syslog(get_class($this)."::delete", LOG_DEBUG);
      $resql = $this->db->query($sql);
      if (!$resql) { $error++; $this->errors[] = "Error ".$this->db->lasterror(); }
    }

    if (!$error)
    {
      $sql = "DELETE FROM ".MAIN_DB_PREFIX."payment_loan";
      $sql .= " WHERE rowid=".$this->id;

      dol_syslog(get_class($this)."::delete", LOG_DEBUG);
      $resql = $this->db->query($sql);
      if (!$resql) { $error++; $this->errors[] = "Error ".$this->db->lasterror(); }
    }

    // Set loan unpaid if loan has no other payment
    if (!$error)
    {
      require_once DOL_DOCUMENT_ROOT.'/loan/class/loan.class.php';
      $loan = new Loan($this->db);
      $loan->fetch($this->fk_loan);
      $sum_payment = $loan->getSumPayment();
      if ($sum_payment == 0)
      {
        dol_syslog(get_class($this)."::delete : set loan to unpaid", LOG_DEBUG);
        if ($loan->set_unpaid($user) < 1)
        {
          $error++;
          dol_print_error($this->db);
        }
      }
    }

    //if (! $error)
    //{
    //  if (! $notrigger)
    //  {
        // Uncomment this and change MYOBJECT to your own tag if you
        // want this action call a trigger.

        //include_once DOL_DOCUMENT_ROOT . '/core/class/interfaces.class.php';
        //$interface=new Interfaces($this->db);
        //$result=$interface->run_triggers('MYOBJECT_DELETE',$this,$user,$langs,$conf);
        //if ($result < 0) { $error++; $this->errors=$interface->errors; }
    //  }
    //}

    // Commit or rollback
    if ($error)
    {
      foreach ($this->errors as $errmsg)
      {
        dol_syslog(get_class($this)."::delete ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      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
    return '';
  }

  public function addPaymentToBank($user, $fk_loan, $mode, $label, $accountid, $emetteur_nom, $emetteur_banque)
  {
    global $conf;

    $error = 0;
    $this->db->begin();

    if (!empty($conf->banque->enabled))
    {
      require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php';

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

      $total = $this->amount_capital;
      if ($mode == 'payment_loan') $total = -$total;

      // Insert payment into llx_bank
      $bank_line_id = $acc->addline(
        $this->datep,
        $this->paymenttype, // Payment mode ID or code ("CHQ or VIR for example")
        $label,
        $total,
        $this->num_payment,
        '',
        $user,
        $emetteur_nom,
        $emetteur_banque
      );

      // Update fk_bank into llx_paiement.
      // We know the payment who generated the account write
      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_loan' in bank_url between payment and bank transaction
        $url = '';
        if ($mode == 'payment_loan') $url = DOL_URL_ROOT.'/loan/payment/card.php?id=';
        if ($url)
        {
          $result = $acc->add_url_line($bank_line_id, $this->id, $url, '(payment)', $mode);
          if ($result <= 0)
          {
            $error++;
            dol_print_error($this->db);
          }
        }


        // Add link 'loan' in bank_url between invoice and bank transaction (for each invoice concerned by payment)
        if ($mode == 'payment_loan')
        {
          $result = $acc->add_url_line($bank_line_id, $fk_loan, DOL_URL_ROOT.'/loan/card.php?id=', ($this->label ? $this->label : ''), 'loan');
          if ($result <= 0) dol_print_error($this->db);
        }
      } else {
        $this->error = $acc->error;
        $error++;
      }
    }


    // Set loan payment started if no set
    if (!$error)
    {
      require_once DOL_DOCUMENT_ROOT.'/loan/class/loan.class.php';
      $loan = new Loan($this->db);
      $loan->fetch($fk_loan);
      if ($loan->paid == $loan::STATUS_UNPAID)
      {
        dol_syslog(get_class($this)."::addPaymentToBank : set loan payment to started", LOG_DEBUG);
        if ($loan->set_started($user) < 1)
        {
          $error++;
          dol_print_error($this->db);
        }
      }
    }

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


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

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

  public function getNomUrl($withpicto = 0, $maxlen = 0, $notooltip = 0, $moretitle = '', $save_lastsearch_value = -1)
  {
    global $langs, $conf;

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

    $result = '';
    $label = '<u>'.$langs->trans("Loan").'</u>';
    if (!empty($this->id)) {
      $label .= '<br><b>'.$langs->trans('Ref').':</b> '.$this->id;
    }
    if ($moretitle) $label .= ' - '.$moretitle;

    $url = DOL_URL_ROOT.'/loan/payment/card.php?id='.$this->id;

    $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
    if ($save_lastsearch_value == -1 && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) $add_save_lastsearch_values = 1;
    if ($add_save_lastsearch_values) $url .= '&save_lastsearch_values=1';

    $linkstart = '<a href="'.$url.'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip">';
    $linkend = '</a>';

    $result .= $linkstart;
    if ($withpicto) $result .= img_object(($notooltip ? '' : $label), $this->picto, ($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;
  }
}