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   Frédéric France   <frederic.france@netlogic.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/>.
 * or see https://www.gnu.org/
 */

require_once DOL_DOCUMENT_ROOT.'/core/modules/societe/modules_societe.class.php';


class mod_codeclient_elephant extends ModeleThirdPartyCode
{
  public $name = 'Elephant';

  public $code_modifiable;

  public $code_modifiable_invalide;

  public $code_modifiable_null;

  public $code_null;

  public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'

  public $code_auto;

  public $searchcode;

  public $numbitcounter;

  public $prefixIsRequired;


  public function __construct()
  {
    $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="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 .= '<table class="nobordernopadding" width="100%">';

    $tooltip = $langs->trans("GenericMaskCodes", $langs->transnoentities("ThirdParty"), $langs->transnoentities("ThirdParty"));
    //$tooltip.=$langs->trans("GenericMaskCodes2"); Not required for third party numbering
    $tooltip .= $langs->trans("GenericMaskCodes3");
    $tooltip .= $langs->trans("GenericMaskCodes4b");
    $tooltip .= $langs->trans("GenericMaskCodes5");

    // Parametrage du prefix customers
    $texte .= '<tr><td>'.$langs->trans("Mask").' ('.$langs->trans("CustomerCodeModel").'):</td>';
    $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat" size="24" name="value1" value="'.$conf->global->COMPANY_ELEPHANT_MASK_CUSTOMER.'"'.$disabled.'>', $tooltip, 1, 1).'</td>';

    $texte .= '<td class="left" rowspan="2">&nbsp; <input type="submit" class="button" value="'.$langs->trans("Modify").'" name="Button"'.$disabled.'></td>';

    $texte .= '</tr>';

    // Parametrage du prefix suppliers
    $texte .= '<tr><td>'.$langs->trans("Mask").' ('.$langs->trans("SupplierCodeModel").'):</td>';
    $texte .= '<td class="right">'.$form->textwithpicto('<input type="text" class="flat" size="24" name="value2" value="'.$conf->global->COMPANY_ELEPHANT_MASK_SUPPLIER.'"'.$disabled.'>', $tooltip, 1, 1).'</td>';
    $texte .= '</tr>';

    $texte .= '</table>';
    $texte .= '</form>';

    return $texte;
  }


  public function getExample($langs, $objsoc = 0, $type = -1)
  {
    $examplecust = '';
    $examplesup = '';
    $errmsg = array(
      "ErrorBadMask",
      "ErrorCantUseRazIfNoYearInMask",
      "ErrorCantUseRazInStartedYearIfNoYearMonthInMask",
    );
    if ($type != 1) {
      $examplecust = $this->getNextValue($objsoc, 0);
      if (!$examplecust) {
        $examplecust = $langs->trans('NotConfigured');
      }
      if (in_array($examplecust, $errmsg)) {
        $langs->load("errors");
        $examplecust = $langs->trans($examplecust);
      }
    }
    if ($type != 0) {
      $examplesup = $this->getNextValue($objsoc, 1);
      if (!$examplesup) {
        $examplesup = $langs->trans('NotConfigured');
      }
      if (in_array($examplesup, $errmsg)) {
        $langs->load("errors");
        $examplesup = $langs->trans($examplesup);
      }
    }

    if ($type == 0) {
      return $examplecust;
    } elseif ($type == 1) {
      return $examplesup;
    } else {
      return $examplecust.'<br>'.$examplesup;
    }
  }

  public function getNextValue($objsoc = 0, $type = -1)
  {
    global $db, $conf;

    require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';

    // Get Mask value
    $mask = '';
    if ($type == 0) $mask = empty($conf->global->COMPANY_ELEPHANT_MASK_CUSTOMER) ? '' : $conf->global->COMPANY_ELEPHANT_MASK_CUSTOMER;
    if ($type == 1) $mask = empty($conf->global->COMPANY_ELEPHANT_MASK_SUPPLIER) ? '' : $conf->global->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 = $conf->global->COMPANY_ELEPHANT_MASK_CUSTOMER;
    if (preg_match('/\{pre\}/i', $mask)) return 1;

    $mask = $conf->global->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 (empty($code) && $this->code_null && empty($conf->global->MAIN_COMPANY_CODE_ALWAYS_REQUIRED))
    {
      $result = 0;
    } elseif (empty($code) && (!$this->code_null || !empty($conf->global->MAIN_COMPANY_CODE_ALWAYS_REQUIRED)))
    {
      $result = -2;
    } else {
      // Get Mask value
      $mask = '';
      if ($type == 0) $mask = empty($conf->global->COMPANY_ELEPHANT_MASK_CUSTOMER) ? '' : $conf->global->COMPANY_ELEPHANT_MASK_CUSTOMER;
      if ($type == 1) $mask = empty($conf->global->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;
      }
    }

    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 <> ".$soc->id;

    $resql = $db->query($sql);
    if ($resql)
    {
      if ($db->num_rows($resql) == 0)
      {
        return 0;
      } else {
        return -1;
      }
    } else {
      return -2;
    }
  }
}