mod_codeclient_elephant.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2004      Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2006-2009 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2007-2012 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2011      Juanjo Menent      <jmenent@2byte.es>
 * Copyright (C) 2013-2018 Philippe Grand       <philippe.grand@atoo-net.com>
 * Copyright (C) 2020-2025  Frédéric France   <frederic.france@free.fr>
 * Copyright (C) 2024-2025  MDW         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024   Eric Seigne     <eric.seigne@cap-rel.fr>
 * Copyright (C) 2025   Charlene Benke    <charlene@patas-monkey.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/>.
 * or see https://www.gnu.org/
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/modules/societe/modules_societe.class.php';
 
 
class mod_codeclient_elephant extends ModeleThirdPartyCode
{
  // variables inherited from ModeleThirdPartyCode class
  public $name = 'Elephant';
  public $version = 'dolibarr';
 
  // variables not inherited
 
  public $searchcode;
 
  public $numbitcounter;
 
 
  public function __construct($db)
  {
    $this->db = $db;
 
    $this->code_null = 0;
    $this->code_modifiable = 1;
    $this->code_modifiable_invalide = 1;
    $this->code_modifiable_null = 1;
    $this->code_auto = 1;
    $this->prefixIsRequired = 0;
  }
 
 
  public function info($langs)
  {
    global $conf, $mc;
    global $form;
 
    $langs->load("companies");
 
    $disabled = ((!empty($mc->sharings['referent']) && $mc->sharings['referent'] != $conf->entity) ? ' disabled' : '');
 
    $texte = $langs->trans('GenericNumRefModelDesc')."<br>\n";
    $texte .= '<form action="'.$_SERVER["PHP_SELF"].'" method="POST">';
    $texte .= '<input type="hidden" name="token" value="'.newToken().'">';
    $texte .= '<input type="hidden" name="page_y" value="">';
    $texte .= '<input type="hidden" name="action" value="setModuleOptions">';
    $texte .= '<input type="hidden" name="param1" value="COMPANY_ELEPHANT_MASK_CUSTOMER">';
    $texte .= '<input type="hidden" name="param2" value="COMPANY_ELEPHANT_MASK_SUPPLIER">';
    $texte .= '<input type="hidden" name="param3" value="COMPANY_ELEPHANT_DATE_START">';
    $texte .= '<input type="hidden" name="param4" value="COMPANY_ELEPHANT_DATE_START_ENABLE">';
    $texte .= '<table class="nobordernopadding" width="100%">';
 
    $tooltip = $langs->trans("GenericMaskCodes", $langs->transnoentities("ThirdParty"), $langs->transnoentities("ThirdParty"));
    $tooltip .= $langs->trans("GenericMaskCodes1");
    //$tooltip.=$langs->trans("GenericMaskCodes2"); Not required for third party numbering
    $tooltip .= $langs->trans("GenericMaskCodes2b").'<br>';
    $tooltip .= '<br>';
    $tooltip .= $langs->trans("GenericMaskCodes3");
    $tooltip .= '<br>';
    $tooltip .= $langs->trans("GenericMaskCodes4b");
    $tooltip .= $langs->trans("GenericMaskCodes5");
    //$tooltip .= '<br>'.$langs->trans("GenericMaskCodes5b");
 
    // Setting of prefix customers
    $texte .= '<tr><td>'.$langs->trans("Mask").' ('.$langs->trans("CustomerCodeModel").'):</td>';
    $texte .= '<td class="nowraponall">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="value1" value="'.getDolGlobalString('COMPANY_ELEPHANT_MASK_CUSTOMER').'"'.$disabled.'>', $tooltip, 1, 'help', '', 0, 3, 'tooltipelephantcutomer').'</td>';
 
    $texte .= '<td class="left" rowspan="2">&nbsp; <input type="submit" class="button button-edit reposition smallpaddingimp" name="modify" value="'.$langs->trans("Modify").'"'.$disabled.'></td>';
 
    $texte .= '</tr>';
 
    // Setting of prefix suppliers
    $texte .= '<tr><td>'.$langs->trans("Mask").' ('.$langs->trans("SupplierCodeModel").'):</td>';
    $texte .= '<td class="nowraponall">'.$form->textwithpicto('<input type="text" class="flat minwidth175" name="value2" value="'.getDolGlobalString('COMPANY_ELEPHANT_MASK_SUPPLIER').'"'.$disabled.'>', $tooltip, 1, 'help', '', 0, 3, 'tooltipelephantsupplier').'</td>';
    $texte .= '</tr>';
 
    // Date of switch to that numbering model
    $datedb = getDolGlobalString('COMPANY_ELEPHANT_DATE_START');
    // After save, default dolibarr store data like displayed : 20/05/2024 and we need a timestamp -> override data
    if (!empty($datedb)) {
      if (!is_numeric($datedb) && GETPOSTISSET('value3')) {
        if (GETPOST('value4') == 1) {
          $dateinput = GETPOSTDATE('value3');
          $res = dolibarr_set_const($this->db, 'COMPANY_ELEPHANT_DATE_START', $dateinput, 'chaine', 0, '', $conf->entity);
          $res = dolibarr_set_const($this->db, 'COMPANY_ELEPHANT_DATE_START_ENABLE', 1, 'chaine', 0, '', $conf->entity);
        } else {
          $res = dolibarr_set_const($this->db, 'COMPANY_ELEPHANT_DATE_START', '', 'chaine', 0, '', $conf->entity);
          $res = dolibarr_set_const($this->db, 'COMPANY_ELEPHANT_DATE_START_ENABLE', 1, 'chaine', 0, '', $conf->entity);
        }
      } else {
        $dateinput = $datedb;
      }
    }
    if (empty($dateinput)) {
      $dateinput = dol_now();
    }
    $isEnabled = getDolGlobalString('COMPANY_ELEPHANT_DATE_START_ENABLE');
    $texte .= '<tr><td>';
    $texte .= '<input type="checkbox"';
    if ($isEnabled) {
      $texte .= ' checked="checked"';
    }
    $texte .= ' onclick="if (this.checked) { jQuery(\'#elephantchoosedate\').show(); } else { jQuery(\'#elephantchoosedate\').hide(); }" id="elephantdisablebefore" name="value4" value="1" class="inline-block"/>';
    $texte .= '<label for="elephantdisablebefore" class="small">';
    $texte .= $form->textwithpicto($langs->trans("DateStartThatModel"), $langs->trans("DateStartThatModelHelp"));
    $texte .= '</label>';
    $texte .= '</td>';
    $texte .= '<td class="nowraponall">';
    $texte .= '<div class="'.($isEnabled ? '' : 'hideobject ').' inline-block" id="elephantchoosedate">';
    $texte .= $form->selectDate($dateinput, 'value3', 0, 0, 1, '', 1, 0, $disabled ? 1 : 0);
    $texte .= '</div>';
    $texte .= '</td>';
 
    $texte .= '</tr>';
 
    $texte .= '</table>';
    $texte .= '</form>';
 
    return $texte;
  }
 
 
  public function getExample($langs = null, $objsoc = '', $type = -1)
  {
    if (!$langs instanceof Translate) {
      $langs = $GLOBALS['langs'];
      '@phan-var-force Translate $langs';
    }
    $examplecust = '';
    $examplesup = '';
    $errmsg = array(
      "ErrorBadMask",
      "ErrorCantUseRazIfNoYearInMask",
      "ErrorCantUseRazInStartedYearIfNoYearMonthInMask",
      "ErrorCounterMustHaveMoreThan3Digits",
      "ErrorBadMaskBadRazMonth",
      "ErrorCantUseRazWithYearOnOneDigit",
    );
 
    $cssforerror = (getDolGlobalString('SOCIETE_CODECLIENT_ADDON') == 'mod_codeclient_elephant' ? 'error' : 'opacitymedium');
 
    if ($type != 1) {
      $examplecust = $this->getNextValue($objsoc, 0);
      if (!$examplecust && ($cssforerror == 'error' || $this->error != 'NotConfigured')) {
        $langs->load("errors");
        $examplecust = '<span class="'.$cssforerror.'">'.$langs->trans('ErrorBadMask').'</span>';
      }
      if (in_array($examplecust, $errmsg)) {
        $langs->load("errors");
        $examplecust = '<span class="'.$cssforerror.'">'.$langs->trans($examplecust).'</span>';
      }
    }
    if ($type != 0) {
      $examplesup = $this->getNextValue($objsoc, 1);
      if (!$examplesup && ($cssforerror == 'error' || $this->error != 'NotConfigured')) {
        $langs->load("errors");
        $examplesup = '<span class="'.$cssforerror.'">'.$langs->trans('ErrorBadMask').'</span>';
      }
      if (in_array($examplesup, $errmsg)) {
        $langs->load("errors");
        $examplesup = '<span class="'.$cssforerror.'">'.$langs->trans($examplesup).'</span>';
      }
    }
 
    if ($type == 0) {
      return $examplecust;
    } elseif ($type == 1) {
      return $examplesup;
    } else {
      return $examplecust.'<br>'.$examplesup;
    }
  }
 
  public function getNextValue($objsoc = '', $type = -1)
  {
    global $db;
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
 
    // Get Mask value
    $mask = '';
    if ($type == 0) {
      $mask = getDolGlobalString('COMPANY_ELEPHANT_MASK_CUSTOMER');
    }
    if ($type == 1) {
      $mask = getDolGlobalString('COMPANY_ELEPHANT_MASK_SUPPLIER');
    }
    if (!$mask) {
      $this->error = 'NotConfigured';
      return '';
    }
 
    $field = '';
    $where = '';
    if ($type == 0) {
      $field = 'code_client';
      //$where = ' AND client in (1,2)';
    } elseif ($type == 1) {
      $field = 'code_fournisseur';
      //$where = ' AND fournisseur = 1';
    } else {
      return -1;
    }
 
    $now = dol_now();
 
    $numFinal = get_next_value($db, $mask, 'societe', $field, $where, '', $now);
 
    return  $numFinal;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function verif_prefixIsUsed()
  {
    // phpcs:enable
    global $conf;
 
    $mask = getDolGlobalString('COMPANY_ELEPHANT_MASK_CUSTOMER');
    if (preg_match('/\{pre\}/i', $mask)) {
      return 1;
    }
 
    $mask = getDolGlobalString('COMPANY_ELEPHANT_MASK_SUPPLIER');
    if (preg_match('/\{pre\}/i', $mask)) {
      return 1;
    }
 
    return 0;
  }
 
 
  public function verif($db, &$code, $soc, $type)
  {
    global $conf;
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';
 
    $result = 0;
    $code = strtoupper(trim($code));
 
    if (getDolGlobalString('COMPANY_ELEPHANT_DATE_START_ENABLE') && $soc->date_creation < getDolGlobalString('COMPANY_ELEPHANT_DATE_START')) {
      return -5;
    }
    if (empty($code) && $this->code_null && !getDolGlobalString('MAIN_COMPANY_CODE_ALWAYS_REQUIRED')) {
      $result = 0;
    } elseif (empty($code) && (!$this->code_null || getDolGlobalString('MAIN_COMPANY_CODE_ALWAYS_REQUIRED'))) {
      $result = -2;
    } else {
      // Get Mask value
      $mask = '';
      if ($type == 0) {
        $mask = !getDolGlobalString('COMPANY_ELEPHANT_MASK_CUSTOMER') ? '' : $conf->global->COMPANY_ELEPHANT_MASK_CUSTOMER;
      }
      if ($type == 1) {
        $mask = !getDolGlobalString('COMPANY_ELEPHANT_MASK_SUPPLIER') ? '' : $conf->global->COMPANY_ELEPHANT_MASK_SUPPLIER;
      }
      if (!$mask) {
        $this->error = 'NotConfigured';
        return -5;
      }
      $result = check_value($mask, $code);
      if (is_string($result)) {
        $this->error = $result;
        return -6;
      } else {
        $is_dispo = $this->verif_dispo($db, $code, $soc, $type);
        if ($is_dispo != 0) {
          $result = -3; // Code $code duplicate
        }
      }
    }
 
    dol_syslog("mod_codeclient_elephant::verif type=".$type." result=".$result);
    return $result;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function verif_dispo($db, $code, $soc, $type = 0)
  {
    // phpcs:enable
    $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."societe";
    if ($type == 1) {
      $sql .= " WHERE code_fournisseur = '".$db->escape($code)."'";
    } else {
      $sql .= " WHERE code_client = '".$db->escape($code)."'";
    }
    if ($soc->id > 0) {
      $sql .= " AND rowid <> ".((int) $soc->id);
    }
    $sql .= " AND entity IN (".getEntity('societe').")";
 
    $resql = $db->query($sql);
    if ($resql) {
      if ($db->num_rows($resql) == 0) {
        return 0;
      } else {
        // Code $code duplicate
        return -1;
      }
    } else {
      return -2;
    }
  }
}