companypaymentmode.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017     Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2024       Frédéric France       <frederic.france@free.fr>
 * Copyright (C) 2024   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 . '/societe/class/societe.class.php';
//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
 
class CompanyPaymentMode extends CommonObject
{
  public $element = 'companypaymentmode';
 
  public $table_element = 'societe_rib';
 
  public $picto = 'generic';
 
 
  const STATUS_ENABLED = 1;
  const STATUS_CANCELED = 0;
 
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'Rowid', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 10),
    'fk_soc' => array('type' => 'integer', 'label' => 'Fk soc', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 15),
    'label' => array('type' => 'varchar(30)', 'label' => 'Label', 'enabled' => 1, 'visible' => -2, 'position' => 30),
    'bank' => array('type' => 'varchar(255)', 'label' => 'Bank', 'enabled' => 1, 'visible' => -2, 'position' => 35),
    'code_banque' => array('type' => 'varchar(128)', 'label' => 'Code banque', 'enabled' => 1, 'visible' => -2, 'position' => 40),
    'code_guichet' => array('type' => 'varchar(6)', 'label' => 'Code guichet', 'enabled' => 1, 'visible' => -2, 'position' => 45),
    'number' => array('type' => 'varchar(255)', 'label' => 'Number', 'enabled' => 1, 'visible' => -2, 'position' => 50),
    'cle_rib' => array('type' => 'varchar(5)', 'label' => 'Cle rib', 'enabled' => 1, 'visible' => -2, 'position' => 55),
    'bic' => array('type' => 'varchar(20)', 'label' => 'Bic', 'enabled' => 1, 'visible' => -2, 'position' => 60),
    'iban_prefix' => array('type' => 'varchar(34)', 'label' => 'Iban prefix', 'enabled' => 1, 'visible' => -2, 'position' => 65),
    'domiciliation' => array('type' => 'varchar(255)', 'label' => 'Domiciliation', 'enabled' => 1, 'visible' => -2, 'position' => 70),
    'proprio' => array('type' => 'varchar(60)', 'label' => 'Proprio', 'enabled' => 1, 'visible' => -2, 'position' => 75),
    'owner_address' => array('type' => 'text', 'label' => 'Owner address', 'enabled' => 1, 'visible' => -2, 'position' => 80),
    'default_rib' => array('type' => 'tinyint(4)', 'label' => 'Default rib', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 85),
    'rum' => array('type' => 'varchar(32)', 'label' => 'Rum', 'enabled' => 1, 'visible' => -2, 'position' => 90),
    'date_rum' => array('type' => 'date', 'label' => 'Date rum', 'enabled' => 1, 'visible' => -2, 'position' => 95),
    'frstrecur' => array('type' => 'varchar(16)', 'label' => 'Frstrecur', 'enabled' => 1, 'visible' => -2, 'position' => 100),
    'type' => array('type' => 'varchar(32)', 'label' => 'Type', 'enabled' => 1, 'visible' => -2, 'position' => 110),
    'last_four' => array('type' => 'varchar(4)', 'label' => 'Last four', 'enabled' => 1, 'visible' => -2, 'position' => 115),
    'card_type' => array('type' => 'varchar(255)', 'label' => 'Card type', 'enabled' => 1, 'visible' => -2, 'position' => 120),
    'cvn' => array('type' => 'varchar(255)', 'label' => 'Cvn', 'enabled' => 1, 'visible' => -2, 'position' => 125),
    'exp_date_month' => array('type' => 'integer', 'label' => 'Exp date month', 'enabled' => 1, 'visible' => -2, 'position' => 130),
    'exp_date_year' => array('type' => 'integer', 'label' => 'Exp date year', 'enabled' => 1, 'visible' => -2, 'position' => 135),
    'country_code' => array('type' => 'varchar(10)', 'label' => 'Country code', 'enabled' => 1, 'visible' => -2, 'position' => 140),
    'approved' => array('type' => 'integer', 'label' => 'Approved', 'enabled' => 1, 'visible' => -2, 'position' => 145),
    'email' => array('type' => 'varchar(255)', 'label' => 'Email', 'enabled' => 1, 'visible' => -2, 'position' => 150),
    'max_total_amount_of_all_payments' => array('type' => 'double(24,8)', 'label' => 'Max total amount of all payments', 'enabled' => 1, 'visible' => -2, 'position' => 155),
    'preapproval_key' => array('type' => 'varchar(255)', 'label' => 'Preapproval key', 'enabled' => 1, 'visible' => -2, 'position' => 160),
    'total_amount_of_all_payments' => array('type' => 'double(24,8)', 'label' => 'Total amount of all payments', 'enabled' => 1, 'visible' => -2, 'position' => 165),
    'stripe_card_ref' => array('type' => 'varchar(128)', 'label' => 'ExternalSystemID', 'enabled' => 1, 'visible' => -2, 'position' => 170, 'help' => 'IDOfPaymentInAnExternalSystem'),
    'stripe_account' => array('type' => 'varchar(128)', 'label' => 'ExternalSystemCustomerAccount', 'enabled' => 1, 'visible' => -2, 'position' => 171, 'help' => 'IDOfCustomerInAnExternalSystem'),
    'ext_payment_site' => array('type' => 'varchar(128)', 'label' => 'ExternalSystem', 'enabled' => 1, 'visible' => -2, 'position' => 172, 'help' => 'NameOfExternalSystem'),
    'status' => array('type' => 'integer', 'label' => 'Status', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 175),
    'starting_date' => array('type' => 'date', 'label' => 'Starting date', 'enabled' => 1, 'visible' => -2, 'position' => 180),
    'ending_date' => array('type' => 'date', 'label' => 'Ending date', 'enabled' => 1, 'visible' => -2, 'position' => 185),
    'datec' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -2, 'position' => 20),
    'tms' => array('type' => 'timestamp', 'label' => 'Tms', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 25),
    'import_key' => array('type' => 'varchar(14)', 'label' => 'Import key', 'enabled' => 1, 'visible' => -2, 'position' => 105),
    //'aaa' =>array('type'=>'date', 'label'=>'Ending date', 'enabled'=>0, 'visible'=>-2, 'position'=>185),
  );
 
  public $rowid;
 
  public $fk_soc;
 
  public $label;
 
  public $bank;
  public $code_banque;
  public $code_guichet;
  public $number;
  public $cle_rib;
  public $bic;
 
  public $iban;
 
  public $iban_prefix;
 
  public $domiciliation;
 
  public $address;
 
  public $proprio;
 
  public $owner_name;
 
  public $owner_address;
 
  public $default_rib;
  public $rum;
  public $date_rum;
  public $frstrecur;
  public $type;
  public $last_four;
  public $card_type;
  public $cvn;
  public $exp_date_month;
  public $exp_date_year;
  public $country_code;
  public $approved;
  public $email;
  public $max_total_amount_of_all_payments;
  public $preapproval_key;
  public $total_amount_of_all_payments;
  public $stripe_card_ref;  // External system payment mode ID
  public $stripe_account;   // External system customer ID
  public $ext_payment_site; // External system 'StripeLive', 'StripeTest', 'StancerLive', 'StancerTest', ...
 
  public $status;
 
  public $starting_date;
  public $ending_date;
 
  public $datec;
 
  public $import_key;
  // END MODULEBUILDER PROPERTIES
 
 
  public function __construct(DoliDB $db)
  {
    global $conf;
 
    $this->db = $db;
 
    $this->ismultientitymanaged = 'fk_soc@societe';
    $this->isextrafieldmanaged = 0;
 
    if (!getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid'])) {
      $this->fields['rowid']['visible'] = 0;
    }
    if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
      $this->fields['entity']['enabled'] = 0;
    }
  }
 
  public function create(User $user, $notrigger = 0)
  {
    $idpayment = $this->createCommon($user, $notrigger);
 
    return $idpayment;
  }
 
  public function createFromClone(User $user, $fromid)
  {
    global $hookmanager, $langs;
    $error = 0;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $object = new self($this->db);
 
    $this->db->begin();
 
    // Load source object
    $object->fetchCommon($fromid);
    // Reset some properties
    unset($object->id);
    unset($object->fk_user_creat);
    unset($object->import_key);
 
    // Clear fields
    $object->ref = "copy_of_".$object->ref;
    // $object->title = $langs->trans("CopyOf")." ".$object->title;
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->createCommon($user);
    if ($result < 0) {
      $error++;
      $this->error = $object->error;
      $this->errors = $object->errors;
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetch($id, $ref = null, $socid = 0, $type = '', $morewhere = '')
  {
    if ($socid) {
      $morewhere .= " AND fk_soc = ".((int) $socid)." AND default_rib = 1";
    }
    if ($type) {
      $morewhere .= " AND type = '".$this->db->escape($type)."'";
    }
 
    $result = $this->fetchCommon($id, $ref, $morewhere);
 
    $this->iban_prefix = dolDecrypt($this->iban_prefix);
 
    // For backward compatibility
    $this->iban = $this->iban_prefix;
    $this->date_modification = $this->tms;
 
    //if ($result > 0 && !empty($this->table_element_line)) $this->fetchLines();
    return $result;
  }
 
  /*public function fetchLines()
  {
    $this->lines=array();
 
    // Load lines with object CompanyPaymentModeLine
 
    return count($this->lines)?1:0;
  }*/
 
  public function update(User $user, $notrigger = 0)
  {
    return $this->updateCommon($user, $notrigger);
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    return $this->deleteCommon($user, $notrigger);
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $db, $conf, $langs;
    global $dolibarr_main_authentication, $dolibarr_main_demo;
    global $menumanager;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1; // Force disable tooltips
    }
 
    $result = '';
    $companylink = '';
 
    $label = '<u>'.$langs->trans("CompanyPaymentMode").'</u>';
    $label .= '<br>';
    $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;
 
    $url = '';
 
    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("ShowCompanyPaymentMode");
        $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
      }
      $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
      $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)) : '');
 
    return $result;
  }
 
  public function setAsDefault($id = 0, $alltypes = 0)
  {
    $sql1 = "SELECT rowid as id, fk_soc, type FROM ".MAIN_DB_PREFIX."societe_rib";
    $sql1 .= " WHERE rowid = ".((int) ($id ? $id : $this->id));
 
    dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
    $result1 = $this->db->query($sql1);
    if ($result1) {
      if ($this->db->num_rows($result1) == 0) {
        return 0;
      } else {
        $obj = $this->db->fetch_object($result1);
 
        $type = '';
        if (empty($alltypes)) {
          $type = $obj->type;
        }
 
        $this->db->begin();
 
        $sql2 = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET default_rib = 0, tms = tms";
        $sql2 .= " WHERE default_rib <> 0 AND fk_soc = ".((int) $obj->fk_soc);
        if ($type) {
          $sql2 .= " AND type = '".$this->db->escape($type)."'";
        }
        dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
        $result2 = $this->db->query($sql2);
 
        $sql3 = "UPDATE ".MAIN_DB_PREFIX."societe_rib SET default_rib = 1";
        $sql3 .= " WHERE rowid = ".((int) $obj->id);
        if ($type) {
          $sql3 .= " AND type = '".$this->db->escape($type)."'";
        }
        dol_syslog(get_class($this).'::setAsDefault', LOG_DEBUG);
        $result3 = $this->db->query($sql3);
 
        if (!$result2 || !$result3) {
          dol_print_error($this->db);
          $this->db->rollback();
          return -1;
        } else {
          $this->db->commit();
          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
    if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
      global $langs;
      //$langs->load("mymodule");
      $this->labelStatus[self::STATUS_ENABLED] = $langs->transnoentitiesnoconv('Enabled');
      $this->labelStatus[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
      $this->labelStatusShort[self::STATUS_ENABLED] = $langs->transnoentitiesnoconv('Enabled');
      $this->labelStatusShort[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
    }
 
    $statusType = 'status5';
    if ($status == self::STATUS_ENABLED) {
      $statusType = 'status4';
    }
 
    return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
  }
 
  public function info($id)
  {
    $sql = 'SELECT rowid, date_creation as datec, tms as datem,';
    $sql .= ' fk_user_creat, fk_user_modif';
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
    $sql .= ' WHERE t.rowid = '.((int) $id);
    $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_creat;
        $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);
    }
  }
 
  public function initAsSpecimen()
  {
    return $this->initAsSpecimenCommon();
  }
}