modules_barcode.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2014 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/>.
 * or see https://www.gnu.org/
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/commonnumrefgenerator.class.php';
 
 
abstract class ModeleBarCode
{
  public $error = '';
 
 
  public function isEnabled()
  {
    return true;
  }
 
 
  abstract public function info($langs);
 
 
  public function writeBarCode($code, $encoding, $readable = 'Y', $scale = 1, $nooutputiferror = 0)
  {
    return -1;  // Error by default, this method must be implemented by the driver
  }
 
  abstract public function encodingIsSupported($encoding);
}
 
 
abstract class ModeleNumRefBarCode extends CommonNumRefGenerator
{
  // variables inherited from CommonNumRefGenerator
  public $code_null;
 
 
  public function getNextValue($objcommon = null, $type = '')
  {
    global $langs;
    return $langs->trans("Function_getNextValue_InModuleNotWorking");
  }
 
 
  abstract public function getExample($langs = null, $object = null);
 
 
  public function getToolTip($langs, $soc, $type)
  {
    $langs->loadLangs(array("admin", "companies"));
 
    $s = '';
    $s .= $langs->trans("Name").': <b>'.$this->name.'</b><br>';
    $s .= $langs->trans("Version").': <b>'.$this->getVersion().'</b><br>';
    if ($type != -1) {
      $s .= $langs->trans("ValidityControledByModule").': <b>'.$this->getName($langs).'</b><br>';
    }
    $s .= '<br>';
    $s .= '<u>'.$langs->trans("ThisIsModuleRules").':</u><br>';
    if ($type == 0) {
      $s .= $langs->trans("RequiredIfProduct").': ';
      if (getDolGlobalString('MAIN_BARCODE_CODE_ALWAYS_REQUIRED') && !empty($this->code_null)) {
        $s .= '<strike>';
      }
      $s .= yn($this->code_null ? 0 : 1, 1, 2);
      if (getDolGlobalString('MAIN_BARCODE_CODE_ALWAYS_REQUIRED') && !empty($this->code_null)) {
        $s .= '</strike> '.yn(1, 1, 2).' ('.$langs->trans("ForcedToByAModule", $langs->transnoentities("yes")).')';
      }
      $s .= '<br>';
    }
    if ($type == 1) {
      $s .= $langs->trans("RequiredIfService").': ';
      if (getDolGlobalString('MAIN_BARCODE_CODE_ALWAYS_REQUIRED') && !empty($this->code_null)) {
        $s .= '<strike>';
      }
      $s .= yn($this->code_null ? 0 : 1, 1, 2);
      if (getDolGlobalString('MAIN_BARCODE_CODE_ALWAYS_REQUIRED') && !empty($this->code_null)) {
        $s .= '</strike> '.yn(1, 1, 2).' ('.$langs->trans("ForcedToByAModule", $langs->transnoentities("yes")).')';
      }
      $s .= '<br>';
    }
    if ($type == -1) {
      $s .= $langs->trans("Required").': ';
      if (getDolGlobalString('MAIN_BARCODE_CODE_ALWAYS_REQUIRED') && !empty($this->code_null)) {
        $s .= '<strike>';
      }
      $s .= yn($this->code_null ? 0 : 1, 1, 2);
      if (getDolGlobalString('MAIN_BARCODE_CODE_ALWAYS_REQUIRED') && !empty($this->code_null)) {
        $s .= '</strike> '.yn(1, 1, 2).' ('.$langs->trans("ForcedToByAModule", $langs->transnoentities("yes")).')';
      }
      $s .= '<br>';
    }
    /*$s.=$langs->trans("CanBeModifiedIfOk").': ';
    $s.=yn($this->code_modifiable,1,2);
    $s.='<br>';
    $s.=$langs->trans("CanBeModifiedIfKo").': '.yn($this->code_modifiable_invalide,1,2).'<br>';
    */
    $s .= $langs->trans("AutomaticCode").': '.yn($this->code_auto, 1, 2).'<br>';
    $s .= '<br>';
 
    $nextval = $this->getNextValue($soc, '');
    if (empty($nextval)) {
      $nextval = $langs->trans("Undefined");
    }
    $s .= $langs->trans("NextValue").': <b>'.$nextval.'</b><br>';
 
    return $s;
  }
 
 
  abstract public function verif($db, &$code, $object, $thirdparty_type, $type);
}