paymentvarious.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017-2021  Alexandre Spangaro          <alexandre@inovea-conseil.com>
 * Copyright (C) 2018-2025  Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024-2026  MDW                         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2026       Solution Libre SAS          <contact@solution-libre.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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
 
 
class PaymentVarious extends CommonObject
{
  public $element = 'payment_various';
 
  public $table_element = 'payment_various';
 
  public $picto = 'payment';
 
  public $id;
 
  public $ref;
 
  public $datep;
 
  public $datev;
 
  public $sens;
 
  public $amount;
 
  public $type_payment;
 
  public $num_payment;
 
  public $chqemetteur;
 
  public $chqbank;
 
  public $category_transaction;
 
  public $label;
 
  public $accountancy_code;
 
  public $subledger_account;
 
  public $fk_project;
 
  public $fk_account;
 
  public $accountid;
 
  public $fk_bank;
 
  public $socid;
 
  public $categorie_transaction;
 
  public $fk_user_author;
 
  public $fk_user_modif;
 
 
  public $fk_type;
 
  public $rappro;
 
  public $bank_num_releve;
 
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    // TODO: fill this array
  );
  // END MODULEBUILDER PROPERTIES
 
  const STATUS_DRAFT = 0;
 
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
  }
 
  public function update($user = null, $notrigger = 0)
  {
    global $conf, $langs;
 
    $error = 0;
 
    // Clean parameters
    $this->amount = (float) price2num($this->amount);
    $this->label = trim($this->label);
    $this->note = trim($this->note);
    $this->fk_bank = (int) $this->fk_bank;
    $this->fk_user_author = (int) $this->fk_user_author;
    $this->fk_user_modif = (int) $this->fk_user_modif;
 
    $this->db->begin();
 
    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX."payment_various SET";
    if ($this->tms) {
      $sql .= " tms='".$this->db->idate($this->tms)."',";
    }
    $sql .= " datep='".$this->db->idate($this->datep)."',";
    $sql .= " datev='".$this->db->idate($this->datev)."',";
    $sql .= " sens=".(int) $this->sens.",";
    $sql .= " amount=".price2num($this->amount).",";
    $sql .= " fk_typepayment=".(int) $this->type_payment.",";
    $sql .= " num_payment='".$this->db->escape($this->num_payment)."',";
    $sql .= " label='".$this->db->escape($this->label)."',";
    $sql .= " note='".$this->db->escape($this->note)."',";
    $sql .= " accountancy_code='".$this->db->escape($this->accountancy_code)."',";
    $sql .= " subledger_account='".$this->db->escape($this->subledger_account)."',";
    $sql .= " fk_projet='".$this->db->escape((string) $this->fk_project)."',";
    $sql .= " fk_bank=".($this->fk_bank > 0 ? ((int) $this->fk_bank) : "null").",";
    $sql .= " fk_user_author=".(int) $this->fk_user_author.",";
    $sql .= " fk_user_modif=".(int) $this->fk_user_modif;
    $sql .= " WHERE rowid=".((int) $this->id);
 
    dol_syslog(get_class($this)."::update", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
 
    // Actions on extra fields
    $result = $this->insertExtraFields();
    if ($result < 0) {
      $error++;
    }
 
    if (!$error && !$notrigger) {
      // Call trigger
      $result = $this->call_trigger('PAYMENT_VARIOUS_MODIFY', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
 
  public function fetch($id, $user = null)
  {
    $sql = "SELECT";
    $sql .= " v.rowid,";
    $sql .= " v.tms,";
    $sql .= " v.datep,";
    $sql .= " v.datev,";
    $sql .= " v.sens,";
    $sql .= " v.amount,";
    $sql .= " v.fk_typepayment,";
    $sql .= " v.num_payment,";
    $sql .= " v.label,";
    $sql .= " v.note as note_private,";
    $sql .= " v.accountancy_code,";
    $sql .= " v.subledger_account,";
    $sql .= " v.fk_projet as fk_project,";
    $sql .= " v.fk_bank,";
    $sql .= " v.fk_user_author,";
    $sql .= " v.fk_user_modif,";
    $sql .= " b.fk_account,";
    $sql .= " b.fk_type,";
    $sql .= " b.rappro,";
    $sql .= " b.num_releve as bank_num_releve";
    $sql .= " FROM ".MAIN_DB_PREFIX."payment_various as v";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."bank as b ON v.fk_bank = b.rowid";
    $sql .= " WHERE v.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->tms                  = $this->db->jdate($obj->tms);
        $this->datep                = $this->db->jdate($obj->datep);
        $this->datev                = $this->db->jdate($obj->datev);
        $this->sens                 = $obj->sens;
        $this->amount               = $obj->amount;
        $this->type_payment         = $obj->fk_typepayment;
        $this->num_payment          = $obj->num_payment;
        $this->label                = $obj->label;
        $this->note                 = $obj->note_private; // For backward compatibility
        $this->note_private         = $obj->note_private;
        $this->subledger_account    = $obj->subledger_account;
        $this->accountancy_code     = $obj->accountancy_code;
        $this->fk_project           = $obj->fk_project;
        $this->fk_bank              = $obj->fk_bank;
        $this->fk_user_author       = $obj->fk_user_author;
        $this->fk_user_modif        = $obj->fk_user_modif;
        $this->fk_account           = $obj->fk_account;
        $this->fk_type              = $obj->fk_type;
        $this->rappro               = $obj->rappro;
        $this->bank_num_releve      = $obj->bank_num_releve;
      }
 
      // Fetch extrafields
      $this->fetch_optionals();
 
      $this->db->free($resql);
 
      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }
 
 
  public function delete($user)
  {
    global $conf, $langs;
 
    $error = 0;
 
    // Call trigger
    $result = $this->call_trigger('PAYMENT_VARIOUS_DELETE', $user);
    if ($result < 0) {
      return -1;
    }
    // End call triggers
 
 
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."payment_various";
    $sql .= " WHERE rowid=".((int) $this->id);
 
    dol_syslog(get_class($this)."::delete", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
 
    return 1;
  }
 
 
  public function initAsSpecimen()
  {
    $this->id = 0;
    $this->tms = dol_now();
    $this->datep = dol_now();
    $this->datev = dol_now();
    $this->sens = 0;
    $this->amount = 100;
    $this->label = 'Specimen payment';
    $this->accountancy_code = '';
    $this->subledger_account = '';
    $this->note = '';
    $this->fk_bank = 0;
    $this->fk_user_author = 0;
    $this->fk_user_modif = 0;
 
    return 1;
  }
 
  public function check()
  {
    $newamount = price2num($this->amount, 'MT');
 
    // Validation of parameters
    if (!($newamount) > 0 || empty($this->datep)) {
      return false;
    }
 
    return true;
  }
 
  public function create($user)
  {
    global $conf, $langs;
 
    $error = 0;
    $now = dol_now();
 
    // Clean parameters
    $this->amount = (float) price2num($this->amount);
    $this->label = trim($this->label);
    $this->note = trim($this->note);
    $this->fk_bank = (int) $this->fk_bank;
    $this->fk_user_author = (int) $this->fk_user_author;
    $this->fk_user_modif = (int) $this->fk_user_modif;
    $this->fk_account = (int) $this->fk_account;
    if (empty($this->fk_account) && isset($this->accountid)) {  // For compatibility
      $this->fk_account = $this->accountid;
    }
 
    // Check parameters
    if (!$this->label) {
      $this->error = $langs->trans("ErrorFieldRequired", $langs->transnoentities("Label"));
      return -3;
    }
    if ($this->amount < 0 || $this->amount == '') {
      $this->error = $langs->trans("ErrorFieldRequired", $langs->transnoentities("Amount"));
      return -5;
    }
    if (isModEnabled("bank") && (empty($this->fk_account) || $this->fk_account <= 0)) {
      $this->error = $langs->trans("ErrorFieldRequired", $langs->transnoentities("BankAccount"));
      return -6;
    }
    if (isModEnabled("bank") && (empty($this->type_payment) || $this->type_payment <= 0)) {
      $this->error = $langs->trans("ErrorFieldRequired", $langs->transnoentities("PaymentMode"));
      return -7;
    }
 
    $this->db->begin();
 
    // Insert into llx_payment_various
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."payment_various (";
    $sql .= " datep";
    $sql .= ", datev";
    $sql .= ", sens";
    $sql .= ", amount";
    $sql .= ", fk_typepayment";
    $sql .= ", num_payment";
    if ($this->note) {
      $sql .= ", note";
    }
    $sql .= ", label";
    $sql .= ", accountancy_code";
    $sql .= ", subledger_account";
    $sql .= ", fk_projet";
    $sql .= ", fk_user_author";
    $sql .= ", datec";
    $sql .= ", fk_bank";
    $sql .= ", entity";
    $sql .= ")";
    $sql .= " VALUES (";
    $sql .= "'".$this->db->idate($this->datep)."'";
    $sql .= ", '".$this->db->idate($this->datev)."'";
    $sql .= ", '".$this->db->escape((string) $this->sens)."'";
    $sql .= ", ".price2num($this->amount);
    $sql .= ", '".$this->db->escape((string) $this->type_payment)."'";
    $sql .= ", '".$this->db->escape($this->num_payment)."'";
    if ($this->note) {
      $sql .= ", '".$this->db->escape($this->note)."'";
    }
    $sql .= ", '".$this->db->escape($this->label)."'";
    $sql .= ", '".$this->db->escape($this->accountancy_code)."'";
    $sql .= ", '".$this->db->escape($this->subledger_account)."'";
    $sql .= ", ".($this->fk_project > 0 ? ((int) $this->fk_project) : 0);
    $sql .= ", ".((int) $user->id);
    $sql .= ", '".$this->db->idate($now)."'";
    $sql .= ", NULL"; // Filled later
    $sql .= ", ".((int) $conf->entity);
    $sql .= ")";
 
    dol_syslog(get_class($this)."::create", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."payment_various");
      $this->ref = (string) $this->id;
 
      if ($this->id > 0) {
        // Insert extrafields
        $result = $this->insertExtraFields();
        if ($result < 0) {
          $error++;
        }
 
        if (isModEnabled("bank") && !empty($this->amount)) {
          // Insert into llx_bank
          require_once DOL_DOCUMENT_ROOT.'/compta/bank/class/account.class.php';
 
          $acc = new Account($this->db);
          $result = $acc->fetch($this->fk_account);
          if ($result <= 0) {
            dol_print_error($this->db);
          }
 
          // Insert payment into llx_bank
          // Add link 'payment_various' in bank_url between payment and bank transaction
          $sign = 1;
          if ($this->sens == '0') {
            $sign = -1;
          }
 
          $bank_line_id = $acc->addline(
            $this->datep,
            (string) $this->type_payment,
            $this->label,
            $sign * abs($this->amount),
            $this->num_payment,
            ($this->category_transaction > 0 ? $this->category_transaction : 0),
            $user,
            $this->chqemetteur,
            $this->chqbank,
            '',
            $this->datev
          );
 
          // Update fk_bank into llx_payment_various
          // So we know the payment which has generate the banking transaction
          if ($bank_line_id > 0) {
            $this->update_fk_bank($bank_line_id);
          } else {
            $this->error = $acc->error;
            $error++;
          }
 
          if (!$error) {
            // Add link 'payment_various' in bank_url between payment and bank transaction
            $url = DOL_URL_ROOT.'/compta/bank/various_payment/card.php?id=';
 
            $result = $acc->add_url_line($bank_line_id, $this->id, $url, "(VariousPayment)", "payment_various");
            if ($result <= 0) {
              $this->error = $acc->error;
              $error++;
            }
          }
 
          if ($result <= 0) {
            $this->error = $acc->error;
            $error++;
          }
        }
 
        // Call trigger
        $result = $this->call_trigger('PAYMENT_VARIOUS_CREATE', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      } else {
        $error++;
      }
 
      if (!$error) {
        $this->db->commit();
        return $this->id;
      } else {
        $this->db->rollback();
        return -2;
      }
    } else {
      $this->error = $this->db->error();
      $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_various SET fk_bank = '.((int) $id_bank);
    $sql .= " WHERE rowid = ".((int) $this->id);
    $result = $this->db->query($sql);
    if ($result) {
      // Keep the in memory object in sync, so a trigger called right after create() reports
      // the real bank line instead of 0 (#40673).
      $this->fk_bank = (int) $id_bank;
      return 1;
    } else {
      dol_print_error($this->db);
      return -1;
    }
  }
 
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
 
    /*
    if (empty($status)) {
      $status = 0;
    }
 
    if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
      $this->labelStatus[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
      //$this->labelStatus[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Enabled');
      //$this->labelStatus[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
      $this->labelStatusShort[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
      //$this->labelStatusShort[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Enabled');
      //$this->labelStatusShort[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
    }
 
    $statusType = 'status'.$status;
 
    return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
    */
    return '';
  }
 
 
  public function getNomUrl($withpicto = 0, $option = '', $save_lastsearch_value = -1, $notooltip = 0, $morecss = '')
  {
    global $db, $conf, $langs, $hookmanager;
    global $langs;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1; // Force disable tooltips
    }
 
    $result = '';
 
    $label = '<u>'.$langs->trans("ShowVariousPayment").'</u>';
    $label .= '<br>';
    $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;
 
    $url = DOL_URL_ROOT.'/compta/bank/various_payment/card.php?id='.$this->id;
 
    if ($option != 'nolink') {
      // Add param to save lastsearch_values or not
      $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
      if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
        $add_save_lastsearch_values = 1;
      }
      if ($add_save_lastsearch_values) {
        $url .= '&save_lastsearch_values=1';
      }
    }
 
    $linkclose = '';
    if (empty($notooltip)) {
      if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
        $label = $langs->trans("ShowMyObject");
        $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
      }
      $linkclose .= ' title="'.dolPrintHTMLForAttribute($label).'"';
      $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
    } else {
      $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
    }
 
    $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 != 2) {
      $result .= $this->ref;
    }
    $result .= $linkend;
    //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
 
    global $action;
    $hookmanager->initHooks(array('variouspayment'));
    $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;
  }
 
  public function info($id)
  {
    $sql = 'SELECT v.rowid, v.datec, v.fk_user_author, fk_user_modif, tms';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'payment_various as v';
    $sql .= ' WHERE v.rowid = '.((int) $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;
        $this->user_creation = $obj->fk_user_author;
        $this->user_creation_id = $obj->fk_user_author;
        $this->user_modification_id = $obj->fk_user_modif;
        $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 getVentilExportCompta($mode = 0)
  {
    $banklineid = $this->fk_bank;
 
    $alreadydispatched = 0;
 
    $type = 'bank';
 
    $sql = " SELECT ".($mode ? 'DISTINCT piece_num' : 'COUNT(ab.rowid)')." as nb";
    $sql .= " FROM ".MAIN_DB_PREFIX."accounting_bookkeeping as ab WHERE ab.doc_type = '".$this->db->escape($type)."' AND ab.fk_doc = ".((int) $banklineid);
    $resql = $this->db->query($sql);
    if ($resql) {
      $obj = $this->db->fetch_object($resql);
      if ($obj) {
        $alreadydispatched = $obj->nb;
      }
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
 
    if ($alreadydispatched) {
      return $alreadydispatched;
    }
    return 0;
  }
 
  public function getKanbanView($option = '', $arraydata = null)
  {
    global $langs;
 
    $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
    $bankline = ((empty($arraydata['bankline']) || empty($arraydata['bankline']->id)) ? 0 : $arraydata['bankline']);
    $formatedaccountancycode = (empty($arraydata['formatedaccountancycode']) ? '' : $arraydata['formatedaccountancycode']);
 
    $return = '<div class="box-flex-item box-flex-grow-zero">';
    $return .= '<div class="info-box info-box-sm">';
    $return .= '<span class="info-box-icon bg-infobox-action">';
    $return .= img_picto('', $this->picto);
    $return .= '</span>';
    $return .= '<div class="info-box-content">';
    $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">'.(method_exists($this, 'getNomUrl') ? $this->getNomUrl(1) : $this->ref).'</span>';
    if ($selected >= 0) {
      $return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';
    }
    if (!empty($bankline) && $bankline instanceof AccountLine) {
      $return .= ' | <span class="info-box-status ">'.$bankline->getNomUrl(1).'</span>';
    }
    if (property_exists($this, 'datep')) {
      $return .= '<br><span class="opacitymedium">'.$langs->trans("Date").'</span> : <span class="info-box-label">'.dol_print_date($this->datep, 'day').'</span>';
      if ($this->type_payment) {
        $return .= ' - <span class="info-box-label">'.$this->type_payment.'</span>';
      }
    }
    if (!empty($formatedaccountancycode)) {
      $return .= '<br><span class="opacitymedium">'.$langs->trans("Account").'</span> : <span class="info-box-label" title="'.$this->accountancy_code.'">';
      $return .= $formatedaccountancycode;
      $return .= '</span>';
    } elseif (property_exists($this, 'accountancy_code')) {
      $return .= '<br><span class="opacitymedium">'.$langs->trans("Account").'</span> : <span class="info-box-label" title="'.$this->accountancy_code.'">'.$this->accountancy_code.'</span>';
    }
 
    if (property_exists($this, 'amount')) {
      $return .= '<br><span class="opacitymedium">'.$langs->trans("Debit").'</span> : <span class="info-box-label amount">'.price($this->amount).'</span>';
    }
    $return .= '</div>';
    $return .= '</div>';
    $return .= '</div>';
    return $return;
  }
 
  public function lengthAccountg($account)
  {
    include_once DOL_DOCUMENT_ROOT.'/core/lib/accounting.lib.php';
 
    /*
    if (isModEnabled('accounting')) {
      $accountingaccount = new AccountingAccount($db);
      $accountingaccount->fetch(0, $valuetoshow, 1);
    }*/
 
    return length_accountg($account);
  }
 
  public function lengthAccounta($account)
  {
    include_once DOL_DOCUMENT_ROOT.'/core/lib/accounting.lib.php';
 
    return length_accounta($account);
  }
}