paymentdonation.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2015       Alexandre Spangaro        <aspangaro@open-dsi.fr>
 * Copyright (C) 2024-2025  Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024-2025  MDW             <mdeweerd@users.noreply.github.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';
 
 
class PaymentDonation extends CommonObject
{
  public $element = 'payment_donation';
 
  public $table_element = 'payment_donation';
 
  public $picto = 'payment';
 
  public $rowid;
 
  public $fk_donation;
 
  public $datec = '';
 
  public $datep = '';
 
  public $amount; // Total amount of payment
 
  public $amounts = array(); // Array of amounts
 
  public $fk_typepayment;
 
  public $paymenttype;
 
  public $num_payment;
 
  public $fk_bank;
 
  public $fk_user_creat;
 
  public $fk_user_modif;
 
  public $total;
 
  public $type_code;
  public $type_label;
  public $chid;
  public $datepaid;
  public $bank_account;
  public $bank_line;
 
  public $ext_payment_id;
 
  public $ext_payment_site;
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
  public function create($user, $notrigger = 0)
  {
    $error = 0;
 
    $now = dol_now();
 
    // Validate parameters
    if (!$this->datep) {
      $this->error = 'ErrorBadValueForParameterCreatePaymentDonation';
      return -1;
    }
 
    // Clean parameters
    if (isset($this->chid)) {
      $this->chid = (int) $this->chid;
    } elseif (isset($this->fk_donation)) {
      // NOTE : The property used in INSERT for fk_donation is not fk_donation but chid
      //        (keep priority to chid property)
      $this->chid = (int) $this->fk_donation;
    }
    if (isset($this->fk_donation)) {
      $this->fk_donation = (int) $this->fk_donation;
    }
    if (isset($this->amount)) {
      $this->amount = (float) price2num($this->amount);
    }
    if (isset($this->fk_typepayment)) {
      $this->fk_typepayment = (int) price2num($this->fk_typepayment);
    }
    if (isset($this->num_payment)) {
      $this->num_payment = trim($this->num_payment);
    }
    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 = 0;
    foreach ($this->amounts as $key => $value) {  // How payment is dispatch
      $newvalue = (float) price2num($value, 'MT');
      $this->amounts[$key] = $newvalue;
      $totalamount += $newvalue;
    }
    $totalamount = (float) price2num($totalamount);
 
    // Check parameters
    if ($totalamount == 0) {
      return -1; // On accepte les montants negatifs pour les rejets de prelevement mais pas null
    }
 
 
    $this->db->begin();
 
    if ($totalamount != 0) {
      $sql = "INSERT INTO ".MAIN_DB_PREFIX."payment_donation (fk_donation, datec, datep, amount,";
      $sql .= " fk_typepayment, num_payment, note, ext_payment_id, ext_payment_site,";
      $sql .= " fk_user_creat, fk_bank)";
      $sql .= " VALUES (".((int) $this->chid).", '".$this->db->idate($now)."',";
      $sql .= " '".$this->db->idate($this->datep)."',";
      $sql .= " ".((float) price2num($totalamount)).",";
      $sql .= " ".((int) $this->paymenttype).", '".$this->db->escape($this->num_payment)."', '".$this->db->escape($this->note_public)."', ";
      $sql .= " ".($this->ext_payment_id ? "'".$this->db->escape($this->ext_payment_id)."'" : "null").", ".($this->ext_payment_site ? "'".$this->db->escape($this->ext_payment_site)."'" : "null").",";
      $sql .= " ".((int) $user->id).", 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_donation");
        $this->ref = (string) $this->id;
      } else {
        $error++;
      }
    }
 
    if (!$error && !$notrigger) {
      // Call triggers
      $result = $this->call_trigger('DONATION_PAYMENT_CREATE', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if ($totalamount != 0 && !$error) {
      $this->amount = $totalamount;
      $this->total = $totalamount; // deprecated
      $this->db->commit();
      return $this->id;
    } else {
      $this->error = $this->db->error();
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetch($id)
  {
    global $langs;
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.fk_donation,";
    $sql .= " t.datec,";
    $sql .= " t.tms,";
    $sql .= " t.datep,";
    $sql .= " t.amount,";
    $sql .= " t.fk_typepayment,";
    $sql .= " t.num_payment,";
    $sql .= " t.note as 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_donation 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 = ".((int) $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_donation    = $obj->fk_donation;
        $this->datec      = $this->db->jdate($obj->datec);
        $this->tms            = $this->db->jdate($obj->tms);
        $this->datep      = $this->db->jdate($obj->datep);
        $this->amount         = $obj->amount;
        $this->fk_typepayment = $obj->fk_typepayment; // Id on type of payent
        $this->paymenttype    = $obj->fk_typepayment; // Id on type of payment. We should store the code into paymenttype.
        $this->num_payment    = $obj->num_payment;
        $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, $notrigger = 0)
  {
    global $conf, $langs;
    $error = 0;
 
    // Clean parameters
 
    if (isset($this->fk_donation)) {
      $this->fk_donation = (int) $this->fk_donation;
    }
    if (isset($this->amount)) {
      $this->amount = (float) price2num($this->amount);
    }
    if (isset($this->fk_typepayment)) {
      $this->fk_typepayment = (int) price2num($this->fk_typepayment);
    }
    if (isset($this->num_payment)) {
      $this->num_payment = trim($this->num_payment);
    }
    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;
    }
 
    // Check parameters
    // Put here code to add control on parameters values
 
    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX."payment_donation SET";
    $sql .= " fk_donation=".(isset($this->fk_donation) ? $this->fk_donation : "null").",";
    $sql .= " datec=".(dol_strlen($this->datec) != 0 ? "'".$this->db->idate($this->datec)."'" : 'null').",";
    $sql .= " tms=".(dol_strlen((string) $this->tms) != 0 ? "'".$this->db->idate($this->tms)."'" : 'null').",";
    $sql .= " datep=".(dol_strlen($this->datep) != 0 ? "'".$this->db->idate($this->datep)."'" : 'null').",";
    $sql .= " amount=".(isset($this->amount) ? $this->amount : "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=".(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=".(int) $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();
    }
 
    if (!$error && !$notrigger) {
      // Call triggers
      $result = $this->call_trigger('DONATION_PAYMENT_MODIFY', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    // 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();
 
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."bank_url";
    $sql .= " WHERE type='payment_donation' AND url_id=".(int) $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_donation";
      $sql .= " WHERE rowid=".((int) $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 && !$notrigger) {
      // Call triggers
      $result = $this->call_trigger('DONATION_PAYMENT_DELETE', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    // 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 createFromClone(User $user, $fromid)
  {
    $error = 0;
 
    $object = new PaymentDonation($this->db);
 
    $this->db->begin();
 
    // Load source object
    $object->fetch($fromid);
    $object->id = 0;
    $object->statut = 0;
 
    // Clear fields
    // ...
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->create($user);
 
    // Other options
    if ($result < 0) {
      $this->setErrorsFromObject($object);
      $error++;
    }
 
    if (!$error) {
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object->id;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
 
  public function getLibStatut($mode = 0)
  {
    return '';
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
 
    return '';
  }
 
 
  public function initAsSpecimen()
  {
    $this->id = 0;
 
    $this->fk_donation = 0;
    $this->datec = dol_now();
    $this->tms = dol_now();
    $this->datep = '';
    $this->amount = 1000.80;
    $this->fk_typepayment = 0;
    $this->paymenttype = 0;
    $this->num_payment = '';
    $this->note_public = 'Public note';
    $this->fk_bank = 0;
    $this->fk_user_creat = 1;
    $this->fk_user_modif = 1;
 
    return 1;
  }
 
 
  public function addPaymentToBank($user, $mode, $label, $accountid, $emetteur_nom, $emetteur_banque)
  {
    global $conf;
 
    $error = 0;
    $amount = 0;
 
    if (isModEnabled("bank")) {
      require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php';
 
      $acc = new Account($this->db);
      $acc->fetch($accountid);
 
      $total = $this->total;
      if ($mode == 'payment_donation') {
        $amount = $total;
      }
      // Insert payment into llx_bank
      $bank_line_id = $acc->addline(
        $this->datep,
        (string) $this->paymenttype, // Payment mode id or code ("CHQ or VIR for example")
        $label,
        (float) $amount,
        $this->num_payment,
        0,
        $user,
        $emetteur_nom,
        $emetteur_banque
      );
 
      // Update fk_bank in 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', 'payment_donation' in bank_url between payment and bank transaction
        $url = '';
        if ($mode == 'payment_donation') {
          $url = DOL_URL_ROOT.'/don/payment/card.php?rowid=';
        }
        if ($url) {
          $result = $acc->add_url_line($bank_line_id, $this->id, $url, '(paiement)', $mode);
          if ($result <= 0) {
            $error++;
            dol_print_error($this->db);
          }
        }
      } else {
        $this->error = $acc->error;
        $error++;
      }
    }
 
    if (!$error) {
      return 1;
    } else {
      return -1;
    }
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function update_fk_bank($id_bank)
  {
    // phpcs:enable
    $sql = "UPDATE ".MAIN_DB_PREFIX."payment_donation SET fk_bank = ".(int) $id_bank." WHERE rowid = ".(int) $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->error();
      return 0;
    }
  }
 
  public function getNomUrl($withpicto = 0, $maxlen = 0)
  {
    global $langs, $hookmanager;
 
    $result = '';
 
    $label = '<u>'.$langs->trans("DonationPayment").'</u>';
    $label .= '<br>';
    $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;
 
    if (!empty($this->id)) {
      $link = '<a href="'.DOL_URL_ROOT.'/don/payment/card.php?id='.$this->id.'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip">';
      $linkend = '</a>';
 
      if ($withpicto) {
        $result .= ($link.img_object($label, 'payment', 'class="classfortooltip"').$linkend.' ');
      }
      if ($withpicto && $withpicto != 2) {
        $result .= ' ';
      }
      if ($withpicto != 2) {
        $result .= $link.($maxlen ? dol_trunc($this->ref, $maxlen) : $this->ref).$linkend;
      }
    }
 
    global $action;
    $hookmanager->initHooks(array($this->element . 'dao'));
    $parameters = array('id' => $this->id, 'getnomurl' => &$result);
    $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
    if ($reshook > 0) {
      $result = $hookmanager->resPrint;
    } else {
      $result .= $hookmanager->resPrint;
    }
    return $result;
  }
}