salary.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2011-2022  Alexandre Spangaro      <aspangaro@open-dsi.fr>
 * Copyright (C) 2014       Juanjo Menent           <jmenent@2byte.es>
 * Copyright (C) 2021       Gauthier VERDOL         <gauthier.verdol@atm-consulting.fr>
 * Copyright (C) 2024-2025  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2024-2026  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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/modules/salaries/modules_salary.php';
 
 
class Salary extends CommonObject
{
  public $element = 'salary';
 
  public $db;
 
  public $table_element = 'salary';
 
  public $module = 'salaries';
 
  public $picto = 'salary';
 
  protected $childtables = array('payment_salary' => array('name' => 'SalaryPayment', 'fk_element' => 'fk_salary'));
 
  // /**
  //  * @var array    List of child tables. To know object to delete on cascade.
  //  *               If name matches '@ClassNAme:FilePathClass;ParentFkFieldName' it will
  //  *               call method deleteByParentField(parentId, ParentFkFieldName) to fetch and delete child object
  //  */
  //protected $childtablesoncascade = array('mymodule_myobjectdet');
 
 
  public $fk_user;
 
  public $datep;
  public $datev;
 
  public $salary;
  public $amount;
 
  public $fk_project;
 
  public $type_payment; // TODO Rename into type_payment_id
  public $type_payment_code;
 
  public $num_payment;
 
  public $label;
 
  public $datesp;
  public $dateep;
 
  public $fk_bank;
 
  public $fk_account;
 
  public $accountid;
 
  public $fk_user_author;
 
  public $fk_user_modif;
 
  public $user;
 
  public $paye;
 
  public $resteapayer;
 
 
  const STATUS_UNPAID = 0;
  const STATUS_PAID = 1;
 
 
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'index' => 1, 'position' => 1, 'comment' => 'Id'),
    'ref' => array('type' => 'varchar(128)', 'label' => 'Ref', 'enabled' => 1, 'position' => 10, 'visible' => 1, 'index' => 1, 'comment' => "Reference of object"),
    'ref_ext' => array('type' => 'varchar(128)', 'label' => 'RefExt', 'enabled' => 1, 'visible' => 0, 'position' => 11),
    'label' => array('type' => 'varchar(255)', 'label' => 'Label', 'enabled' => 1, 'position' => 12, 'notnull' => 0, 'visible' => 1),
    'datec' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => 0, 'position' => 30),
    'datep' => array('type' => 'date', 'label' => 'Date', 'enabled' => 1, 'visible' => 0, 'position' => 40, 'comment' => 'Date'),
    'datev' => array('type' => 'date', 'label' => 'Date', 'enabled' => 1, 'visible' => 0,  'position' => 50, 'comment' => 'Date'),
    'fk_user' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'Employee', 'enabled' => 1, 'position' => 15, 'notnull' => 1, 'visible' => 1, 'picto' => 'user'),
    'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 20),
    'salary' => array('type' => 'double(24,8)', 'label' => 'salary', 'enabled' => 1, 'visible' => 0, 'position' => 70),
    'amount' => array('type' => 'double(24,8)', 'label' => 'Amount', 'enabled' => 1, 'visible' => 1, 'notnull' => 1, 'position' => 80),
    'fk_projet' => array('type' => 'integer:Project:projet/class/project.class.php:1:(fk_statut:=:1)', 'label' => 'Project', 'enabled' => "isModEnabled('project')", 'visible' => 0, 'position' => 90),
    'fk_typepayment' => array('type' => 'typepayment', 'label' => 'DefaultPaymentMode', 'enabled' => 1, 'visible' => 1, 'position' => 100, 'comment' => 'Payment type'),
    'num_payment' => array('type' => 'string', 'label' => 'Reference', 'enabled' => 1, 'visible' => 0, 'position' => 110, 'comment' => 'Reference'),
    'datesp' => array('type' => 'date', 'label' => 'DateStart', 'enabled' => 1, 'visible' => 1, 'position' => 130, 'comment' => 'Date'),
    'dateep' => array('type' => 'date', 'label' => 'DateEnd', 'enabled' => 1, 'visible' => 1, 'position' => 140, 'comment' => 'Date'),
    'entity' => array('type' => 'integer', 'label' => 'Entity', 'default' => '1', 'enabled' => 1, 'visible' => 0, 'position' => 150, 'index' => 1),
    'note' => array('type' => 'text', 'label' => 'Note', 'enabled' => 1, 'position' => 160, 'visible' => 0,),
    'fk_bank' => array('type' => 'integer', 'label' => 'BankId', 'enabled' => 1, 'visible' => 0, 'position' => 170),
    'paye' => array('type' => 'smallint(6)', 'label' => 'Status', 'enabled' => 1, 'visible' => 1, 'notnull' => 1, 'position' => 180),
    'fk_user_author' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserAuthor', 'enabled' => 1, 'visible' => 0, 'position' => 190),
    'fk_user_modif' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserModif', 'enabled' => 1, 'position' => 200, 'visible' => 0,),
    'note_public' => array('type' => 'text', 'label' => 'NotePublic', 'enabled' => 1, 'visible' => 0, 'position' => 220),
  );
 
 
  public function __construct($db)
  {
    $this->db = $db;
    $this->element = 'salary';
    $this->table_element = 'salary';
    $this->isextrafieldmanaged = 1;
 
    $this->fields['ref_ext']['visible'] = getDolGlobalInt('MAIN_LIST_SHOW_REF_EXT');
  }
 
  public function generateDocument($model, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = array())
  {
    global $conf, $langs;
 
    if (!dol_strlen($model)) {
      setEventMessages($langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Model")), null, 'errors');
      return 0;
    }
 
    $modelpath = 'core/modules/salaries/doc/';
    $modelfile = $modelpath."pdf_".$model.".modules.php";
 
    // Check if model file exists
    if (file_exists(DOL_DOCUMENT_ROOT.'/'.$modelfile)) {
      require_once DOL_DOCUMENT_ROOT.'/'.$modelfile;
 
      $classname = 'pdf_'.$model;
      if (class_exists($classname)) {
        $module = new $classname($this->db);
 
        // Generate the PDF
        $result = $module->writeFile($this, $outputlangs);
        if ($result > 0) {
          return 1;
        } else {
          setEventMessages($module->error, $module->errors, 'errors');
          return 0;
        }
      } else {
        setEventMessages('Failed to load class '.$classname, null, 'errors');
        return 0;
      }
    } else {
      setEventMessages($langs->trans("ErrorModuleNotFound", $model), null, 'errors');
      return 0;
    }
  }
 
  public function update($user = null, $notrigger = 0)
  {
    $error = 0;
 
    // Clean parameters
    $this->amount = trim($this->amount);
    $this->label = trim($this->label);
    $this->note = trim($this->note);
    $this->note_private = trim($this->note_private);
    $this->note_public = trim($this->note_public);
 
    // Check parameters
    if (empty($this->fk_user) || $this->fk_user < 0) {
      $this->error = 'ErrorBadParameter';
      return -1;
    }
 
    $this->db->begin();
 
    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX."salary SET";
    $sql .= " tms='".$this->db->idate(dol_now())."',";
    $sql .= " fk_user=".((int) $this->fk_user).",";
    /*$sql .= " datep='".$this->db->idate($this->datep)."',";
    $sql .= " datev='".$this->db->idate($this->datev)."',";*/
    $sql .= " amount=".price2num($this->amount).",";
    $sql .= " fk_projet=".((int) $this->fk_project).",";
    $sql .= " fk_typepayment=".((int) $this->type_payment).",";
    $sql .= " label='".$this->db->escape($this->label)."',";
    $sql .= " datesp='".$this->db->idate($this->datesp)."',";
    $sql .= " dateep='".$this->db->idate($this->dateep)."',";
    $sql .= " note='".$this->db->escape($this->note)."',";
    $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=".($this->fk_user_modif > 0 ? (int) $this->fk_user_modif : (int) $user->id);
    $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;
    }
 
    // Update extrafield
    $result = $this->insertExtraFields();
    if ($result < 0) {
      $error++;
    }
 
    if (!$notrigger) {
      // Call trigger
      $result = $this->call_trigger('SALARY_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 .= " s.rowid,";
    $sql .= " s.tms,";
    $sql .= " s.fk_user,";
    $sql .= " s.datep,";
    $sql .= " s.datev,";
    $sql .= " s.amount,";
    $sql .= " s.fk_projet as fk_project,";
    $sql .= " s.fk_typepayment,";
    $sql .= " s.label,";
    $sql .= " s.datesp,";
    $sql .= " s.dateep,";
    $sql .= " s.note as note_private,";
    $sql .= " s.note_public,";
    $sql .= " s.paye,";
    $sql .= " s.fk_bank,";
    $sql .= " s.fk_user_author,";
    $sql .= " s.fk_user_modif,";
    $sql .= " s.fk_account,";
    $sql .= " cp.code as type_payment_code";
    $sql .= " FROM ".MAIN_DB_PREFIX."salary as s";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."bank as b ON s.fk_bank = b.rowid";
    $sql .= " LEFT JOIN ".MAIN_DB_PREFIX."c_paiement as cp ON s.fk_typepayment = cp.id";
    $sql .= " WHERE s.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->fk_user          = $obj->fk_user;
        $this->datep      = $this->db->jdate($obj->datep);
        $this->datev      = $this->db->jdate($obj->datev);
        $this->amount           = $obj->amount;
        $this->fk_project       = $obj->fk_project;
        $this->type_payment     = $obj->fk_typepayment;
        $this->type_payment_code = $obj->type_payment_code;
        $this->label      = $obj->label;
        $this->datesp     = $this->db->jdate($obj->datesp);
        $this->dateep     = $this->db->jdate($obj->dateep);
        $this->note       = $obj->note_private;
        $this->note_private   = $obj->note_private;
        $this->note_public    = $obj->note_public;
        $this->paye       = $obj->paye;
        $this->status       = $obj->paye;
        $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->accountid = $obj->fk_account;
 
        // Retrieve all extrafield
        // fetch optionals attributes and labels
        $this->fetch_optionals();
      }
      $this->db->free($resql);
 
      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }
 
 
  public function delete($user, $notrigger = 0)
  {
    return $this->deleteCommon($user, $notrigger);
  }
 
 
  public function initAsSpecimen()
  {
    $this->id = 0;
 
    $this->tms = dol_now();
    $this->fk_user = 0;
    $this->datep = '';
    $this->datev = '';
    $this->amount = '';
    $this->label = '';
    $this->datesp = '';
    $this->dateep = '';
    $this->note = '';
    $this->fk_bank = 0;
    $this->fk_user_author = 0;
    $this->fk_user_modif = 0;
 
    return 1;
  }
 
  public function create($user)
  {
    global $conf, $langs;
 
    $error = 0;
    $now = dol_now();
 
    // Clean parameters
    $this->amount = price2num(trim($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->accountid = (int) $this->accountid;
    $this->paye = (int) $this->paye;
 
    // Check parameters
    if (!$this->label) {
      $this->error = $langs->trans("ErrorFieldRequired", $langs->transnoentities("Label"));
      return -3;
    }
    if ($this->fk_user < 0 || $this->fk_user == '') {
      $this->error = $langs->trans("ErrorFieldRequired", $langs->transnoentities("Employee"));
      return -4;
    }
    if ($this->amount == '') {
      $this->error = $langs->trans("ErrorFieldRequired", $langs->transnoentities("Amount"));
      return -5;
    }
 
    $this->db->begin();
 
    // Insert into llx_salary
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."salary (fk_user";
    //$sql .= ", datep";
    //$sql .= ", datev";
    $sql .= ", amount";
    $sql .= ", fk_projet";
    $sql .= ", salary";
    $sql .= ", fk_typepayment";
    $sql .= ", fk_account";
    if ($this->note) {
      $sql .= ", note";
    }
    $sql .= ", label";
    $sql .= ", datesp";
    $sql .= ", dateep";
    $sql .= ", fk_user_author";
    $sql .= ", datec";
    $sql .= ", fk_bank";
    $sql .= ", entity";
    $sql .= ") ";
    $sql .= " VALUES (";
    $sql .= "'".((int) $this->fk_user)."'";
    //$sql .= ", '".$this->db->idate($this->datep)."'";
    //$sql .= ", '".$this->db->idate($this->datev)."'";
    $sql .= ", ".((float) $this->amount);
    $sql .= ", ".($this->fk_project > 0 ? ((int) $this->fk_project) : 0);
    $sql .= ", ".($this->salary > 0 ? ((float) $this->salary) : "null");
    $sql .= ", ".($this->type_payment > 0 ? ((int) $this->type_payment) : 0);
    $sql .= ", ".($this->accountid > 0 ? ((int) $this->accountid) : "null");
    if ($this->note) {
      $sql .= ", '".$this->db->escape($this->note)."'";
    }
    $sql .= ", '".$this->db->escape($this->label)."'";
    $sql .= ", '".$this->db->idate($this->datesp)."'";
    $sql .= ", '".$this->db->idate($this->dateep)."'";
    $sql .= ", '".((int) $user->id)."'";
    $sql .= ", '".$this->db->idate($now)."'";
    $sql .= ", NULL";
    $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."salary");
 
      if ($this->id > 0) {
        // Update extrafield
        $result = $this->insertExtraFields();
        if ($result < 0) {
          $error++;
        }
 
        // Call trigger
        $result = $this->call_trigger('SALARY_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.'salary SET fk_bank = '.((int) $id_bank);
    $sql .= " WHERE rowid = ".((int) $this->id);
    $result = $this->db->query($sql);
    if ($result) {
      return 1;
    } else {
      dol_print_error($this->db);
      return -1;
    }
  }
 
  public function getTooltipContentArray($params)
  {
    global $langs;
 
    $langs->loadLangs(['salaries']);
 
    // Complete datas
    if (!empty($params['fromajaxtooltip']) && !isset($this->alreadypaid)) {
      // Load the alreadypaid field
      $this->alreadypaid = $this->getSommePaiement(0);
    }
 
    $datas = [];
 
    $datas['picto'] = '<u>'.$langs->trans("Salary").'</u>';
    if (isset($this->status) && isset($this->alreadypaid)) {
      $datas['picto'] .= ' '.$this->getLibStatut(5, $this->alreadypaid);
    }
    $datas['ref'] = '<br><b>'.$langs->trans('Ref').':</b> '.$this->ref;
 
    return $datas;
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $conf, $langs, $hookmanager;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1;
    } // Force disable tooltips
 
    $result = '';
    $params = [
      'id' => $this->id,
      'objecttype' => $this->element,
      'option' => $option,
    ];
    $classfortooltip = 'classfortooltip';
    $dataparams = '';
    if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
      $classfortooltip = 'classforajaxtooltip';
      $dataparams = ' data-params="'.dol_escape_htmltag(json_encode($params)).'"';
      $label = '';
    } else {
      $label = implode($this->getTooltipContentArray($params));
    }
 
    $url = DOL_URL_ROOT.'/salaries/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 .= ($label ? ' title="'.dolPrintHTMLForAttribute($label).'"' : ' title="tocomplete"');
      $linkclose .= $dataparams.' 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 ' : '').'"'), 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;
    $hookmanager->initHooks(array('salarypayment'));
    $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 getSommePaiement($multicurrency = 0)
  {
    $sql = "SELECT sum(amount) as amount";
    //sum(multicurrency_amount) as multicurrency_amount   // Not yet supported
    $sql .= " FROM ".MAIN_DB_PREFIX."payment_salary";
    $sql .= " WHERE fk_salary = ".((int) $this->id);
 
    dol_syslog(get_class($this)."::getSommePaiement for salary id=".((int) $this->id), LOG_DEBUG);
 
    $resql = $this->db->query($sql);
 
    if ($resql) {
      $obj = $this->db->fetch_object($resql);
 
      $this->db->free($resql);
 
      if ($obj) {
        if ($multicurrency < 0) {
          //$this->totalpaid = $obj->amount;
          //$this->totalpaid_multicurrency = $obj->multicurrency_amount;
          //return array('alreadypaid'=>(float) $obj->amount, 'alreadypaid_multicurrency'=>(float) $obj->multicurrency_amount);
          return array(); // Not yet supported
        } elseif ($multicurrency) {
          //$this->totalpaid_multicurrency = $obj->multicurrency_amount;
          //return (float) $obj->multicurrency_amount;
          return -1;    // Not yet supported
        } else {
          //$this->totalpaid = $obj->amount;
          return (float) $obj->amount;
        }
      } else {
        return 0;
      }
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
  }
 
  public function info($id)
  {
    $sql = 'SELECT ps.rowid, ps.datec, ps.tms as datem, ps.fk_user_author, ps.fk_user_modif';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'salary as ps';
    $sql .= ' WHERE ps.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_id = $obj->fk_user_author;
        $this->user_modification_id = $obj->fk_user_modif;
        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
      }
      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function set_paid($user)
  {
    // phpcs:enable
    dol_syslog(get_class($this)."::set_paid is deprecated, use setPaid instead", LOG_NOTICE);
    return $this->setPaid($user);
  }
 
  public function setPaid($user)
  {
    $sql = "UPDATE ".MAIN_DB_PREFIX."salary SET";
    $sql .= " paye = 1";
    $sql .= " WHERE rowid = ".((int) $this->id);
 
    $return = $this->db->query($sql);
 
    if ($return) {
      $this->paye = 1;
      return 1;
    } else {
      return -1;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function set_unpaid($user)
  {
    // phpcs:enable
    $sql = "UPDATE ".MAIN_DB_PREFIX."salary SET";
    $sql .= " paye = 0";
    $sql .= " WHERE rowid = ".((int) $this->id);
 
    $return = $this->db->query($sql);
 
    if ($return) {
      $this->paye = 0;
      return 1;
    } else {
      return -1;
    }
  }
 
 
  public function getLibStatut($mode = 0, $alreadypaid = -1)
  {
    return $this->LibStatut($this->paye, $mode, $alreadypaid);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0, $alreadypaid = -1)
  {
    // phpcs:enable
    global $langs;
 
    // Load translation files required by the page
    $langs->loadLangs(array("customers", "bills"));
 
    // We reinit status array to force to redefine them because label may change according to properties values.
    $this->labelStatus = array();
    $this->labelStatusShort = array();
 
    if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
      global $langs;
      //$langs->load("mymodule");
      $this->labelStatus[self::STATUS_UNPAID] = $langs->transnoentitiesnoconv('BillStatusNotPaid');
      $this->labelStatus[self::STATUS_PAID] = $langs->transnoentitiesnoconv('BillStatusPaid');
      if ($status == self::STATUS_UNPAID && $alreadypaid != 0) {
        $this->labelStatus[self::STATUS_UNPAID] = $langs->transnoentitiesnoconv("BillStatusStarted");
      }
      $this->labelStatusShort[self::STATUS_UNPAID] = $langs->transnoentitiesnoconv('BillStatusNotPaid');
      $this->labelStatusShort[self::STATUS_PAID] = $langs->transnoentitiesnoconv('BillStatusPaid');
      if ($status == self::STATUS_UNPAID && $alreadypaid != 0) {
        $this->labelStatusShort[self::STATUS_UNPAID] = $langs->transnoentitiesnoconv("BillStatusStarted");
      }
    }
 
    $statusType = 'status1';
    if ($status == 0 && $alreadypaid != 0) {
      $statusType = 'status3';
    }
    if ($status == 1) {
      $statusType = 'status6';
    }
 
    return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
  }
 
  public function getKanbanView($option = '', $arraydata = null)
  {
    global $langs;
 
    $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
 
    $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">' . $this->getNomUrl(1) . '</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($arraydata['user']) && is_object($arraydata['user'])) {
      $user = $arraydata['user'];
      '@phan-var-force User $user';
      $return .= '<br><span class="info-box-label">'.$user->getNomUrl(empty($arraydata['user']->photo) ? 1 : -1, '', 0, 0, 16, 0, '', 'maxwidth100').'</span>';
    }
    $return .= '<br><span class="info-box-label amount">'.price($this->amount).'</span>';
    if (!empty($this->type_payment)) {
      $return .= ' <span class="info-box-label opacitymedium small">';
      if ($langs->trans("PaymentTypeShort".$this->type_payment) != "PaymentTypeShort".$this->type_payment) {
        $return .= $langs->trans("PaymentTypeShort".$this->type_payment);
      } elseif ($langs->trans("PaymentType".$this->type_payment) != "PaymentType".$this->type_payment) {
        $return .= $langs->trans("PaymentType".$this->type_payment);
      }
      $return .= '</span>';
    }
    $return .= '<br><div class="info-box-status">'.$this->getLibStatut(3, isset($this->alreadypaid) ? $this->alreadypaid : $this->totalpaid).'</div>';
    $return .= '</div>';
    $return .= '</div>';
    $return .= '</div>';
 
    return $return;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function demande_prelevement($fuser, $amount = 0, $type = 'direct-debit', $sourcetype = 'salaire', $checkduplicateamongall = 0)
  {
    // phpcs:enable
    global $conf, $mysoc;
 
    $error = 0;
 
    dol_syslog(get_class($this)."::demande_prelevement", LOG_DEBUG);
    if ($this->paye == 0) {
      require_once DOL_DOCUMENT_ROOT.'/societe/class/companybankaccount.class.php';
      $bac = new CompanyBankAccount($this->db);
      // @phan-suppress-next-line PhanPluginSuspiciousParamPosition
      $bac->fetch(0, '', $mysoc->id);
 
      $sql = "SELECT count(rowid) as nb";
      $sql .= " FROM ".$this->db->prefix()."prelevement_demande";
      if ($type == 'salaire') {
        $sql .= " WHERE fk_salary = ".((int) $this->id);
      } else {
        $sql .= " WHERE fk_facture = ".((int) $this->id);
      }
      $sql .= " AND type = 'ban'"; // To exclude record done for some online payments
      if (empty($checkduplicateamongall)) {
        $sql .= " AND traite = 0";
      }
 
      dol_syslog(get_class($this)."::demande_prelevement", LOG_DEBUG);
 
      $resql = $this->db->query($sql);
      if ($resql) {
        $obj = $this->db->fetch_object($resql);
        if ($obj && $obj->nb == 0) {  // If no request found yet
          $now = dol_now();
 
          $totalpaid = $this->getSommePaiement();
          // $totalcreditnotes = $this->getSumCreditNotesUsed();
          // $totaldeposits = $this->getSumDepositsUsed();
          //print "totalpaid=".$totalpaid." totalcreditnotes=".$totalcreditnotes." totaldeposts=".$totaldeposits;
 
          // We can also use bcadd to avoid pb with floating points
          // For example print 239.2 - 229.3 - 9.9; does not return 0.
          //$resteapayer=bcadd($this->total_ttc,$totalpaid,$conf->global->MAIN_MAX_DECIMALS_TOT);
          //$resteapayer=bcadd($resteapayer,$totalavoir,$conf->global->MAIN_MAX_DECIMALS_TOT);
          // if (empty($amount)) {
          //  $amount = price2num($this->total_ttc - $totalpaid - $totalcreditnotes - $totaldeposits, 'MT');
          // }
 
          if (is_numeric($amount) && $amount != 0) {
            $sql = 'INSERT INTO '.$this->db->prefix().'prelevement_demande(';
            if ($type == 'salaire') {
              $sql .= 'fk_salary, ';
            } else {
              $sql .= 'fk_facture, ';
            }
            $sql .= ' amount, date_demande, fk_user_demande, code_banque, code_guichet, number, cle_rib, sourcetype, type, entity)';
            $sql .= " VALUES (".((int) $this->id);
            $sql .= ", ".((float) price2num($amount));
            $sql .= ", '".$this->db->idate($now)."'";
            $sql .= ", ".((int) $fuser->id);
            $sql .= ", '".$this->db->escape($bac->code_banque)."'";
            $sql .= ", '".$this->db->escape($bac->code_guichet)."'";
            $sql .= ", '".$this->db->escape($bac->number)."'";
            $sql .= ", '".$this->db->escape($bac->cle_rib)."'";
            $sql .= ", '".$this->db->escape($sourcetype)."'";
            $sql .= ", 'ban'";
            $sql .= ", ".((int) $conf->entity);
            $sql .= ")";
 
            dol_syslog(get_class($this)."::demande_prelevement", LOG_DEBUG);
            $resql = $this->db->query($sql);
            if (!$resql) {
              $this->error = $this->db->lasterror();
              dol_syslog(get_class($this).'::demandeprelevement Erreur');
              $error++;
            }
          } else {
            $this->error = 'WithdrawRequestErrorNilAmount';
            dol_syslog(get_class($this).'::demandeprelevement WithdrawRequestErrorNilAmount');
            $error++;
          }
 
          if (!$error) {
            // Force payment mode of invoice to withdraw
            $payment_mode_id = dol_getIdFromCode($this->db, (($type == 'bank-transfer' || $type == 'salaire') ? 'VIR' : 'PRE'), 'c_paiement', 'code', 'id', 1);
            if ($payment_mode_id > 0) {
              $result = $this->setPaymentMethods($payment_mode_id);
            }
          }
 
          if ($error) {
            return -1;
          }
          return 1;
        } else {
          $this->error = "A request already exists";
          dol_syslog(get_class($this).'::demandeprelevement Can t create a request to generate a direct debit, a request already exists.');
          return 0;
        }
      } else {
        $this->error = $this->db->error();
        dol_syslog(get_class($this).'::demandeprelevement Error -2');
        return -2;
      }
    } else {
      $this->error = "Status of invoice does not allow this";
      dol_syslog(get_class($this)."::demandeprelevement ".$this->error." $this->status, $this->paye, $this->mode_reglement_id");
      return -3;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function demande_prelevement_delete($fuser, $did)
  {
    // phpcs:enable
    $sql = 'DELETE FROM '.$this->db->prefix().'prelevement_demande';
    $sql .= ' WHERE rowid = '.((int) $did);
    $sql .= ' AND traite = 0';
    if ($this->db->query($sql)) {
      return 0;
    } else {
      $this->error = $this->db->lasterror();
      dol_syslog(get_class($this).'::demande_prelevement_delete Error '.$this->error);
      return -1;
    }
  }
}