modBarcode.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2005      Rodolphe Quiedeville <rodolphe@quiedeville.org>
 * Copyright (C) 2005-2008 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2009 Regis Houssin        <regis.houssin@inodbox.com>
 * Copyright (C) 2015      Juanjo Menent        <jmenent@2byte.es>
 * Copyright (C) 2026       Frédéric France         <frederic.france@free.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/>.
 */
 
include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
 
class modBarcode extends DolibarrModules
{
  public function __construct($db)
  {
    $this->db = $db;
    $this->numero = 55;
 
    $this->family = "technic";
    // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
    $this->name = preg_replace('/^mod/i', '', get_class($this));
    $this->description = "Gestion des codes barres";
    // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
    $this->version = 'dolibarr';
    $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
    $this->picto = 'barcode';
 
    // Data directories to create when module is enabled
    $this->dirs = array("/barcode/temp");
 
    // Dependencies
    $this->depends = array(); // May be used for product or service or third party module
    $this->requiredby = array();
 
    // Config pages
    $this->config_page_url = array("barcode.php");
 
    // Constants
    // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
    // Example: $this->const=array(1 => array('MYMODULE_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
    //                             2 => array('MYMODULE_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
    $this->const = array(
      0 => array('BARCODE_USE_ON_PRODUCT', 'chaine', '1', 'Constant to activate barcode for products', 0)
    );
 
    // Boxes
    $this->boxes = array();
 
    // Permissions
    $this->rights = array();
    $this->rights_class = 'barcode';
    $r = 0;
 
    $this->rights[$r][0] = 301; // Permission id (must not be already used)
    $this->rights[$r][1] = 'Generate PDF sheets of barcodes'; // Permission label
    $this->rights[$r][2] = 'r'; // Permission type (deprecated)
    $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'read';
    $r++;
 
    $this->rights[$r][0] = 304; // Permission id (must not be already used)
    $this->rights[$r][1] = 'Read barcodes'; // Permission label
    $this->rights[$r][2] = 'r'; // Permission type (deprecated)
    $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'lire_advance';
    $r++;
 
    $this->rights[$r][0] = 305; // Permission id (must not be already used)
    $this->rights[$r][1] = 'Create/modify barcodes'; // Permission label
    $this->rights[$r][2] = 'w'; // Permission type (deprecated)
    $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'creer_advance';
    $r++;
 
    // Main menu entries
    $r = 0;
 
    // A menu entry for the Tools top menu
    $this->menu[$r] = array(
      'fk_menu'=>'fk_mainmenu=tools', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
      'mainmenu'=>'tools',
      'leftmenu'=>'barcodeprint',
      'type'=>'left', // This is a Left menu entry
      'titre'=>'BarCodePrintsheet',
      'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth"'),
      'url'=>'/barcode/printsheet.php?mainmenu=tools&leftmenu=barcodeprint',
      'langs'=>'products', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
      'position'=>200,
      'enabled'=>'isModEnabled("barcode")', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
      'perms'=>'$user->hasRight("barcode", "read")',
      'target'=>'',
      'user'=>0, // 0=Menu for internal users, 1=external users, 2=both
    );
    $r++;
 
    // A menu entry for the left menu
    $this->menu[$r] = array(
      'fk_menu'=>'fk_mainmenu=home,fk_leftmenu=admintools', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
      'type'=>'left', // This is a Left menu entry
      'titre'=>'MassBarcodeInit',
      'url'=>'/barcode/codeinit.php?mainmenu=home&leftmenu=admintools',
      'langs'=>'products', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
      'position'=>300,
      'enabled'=>'isModEnabled("barcode") && preg_match(\'/^(admintools|all)/\', $leftmenu)', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
      'perms'=>'$user->admin',
      'target'=>'',
      'user'=>0, // 0=Menu for internal users, 1=external users, 2=both
    );
    $r++;
  }
 
 
  public function init($options = '')
  {
    // Permissions
    $this->remove($options);
 
    $sql = array(
      array('sql'=>"INSERT INTO ".MAIN_DB_PREFIX."c_barcode_type (code, libelle, coder, example, entity) VALUES ('EAN8', 'EAN8', 0, '1234567', __ENTITY__)", 'ignoreerror'=>1),
      array('sql'=>"INSERT INTO ".MAIN_DB_PREFIX."c_barcode_type (code, libelle, coder, example, entity) VALUES ('EAN13', 'EAN13', 0, '123456789012', __ENTITY__)", 'ignoreerror'=>1),
      array('sql'=>"INSERT INTO ".MAIN_DB_PREFIX."c_barcode_type (code, libelle, coder, example, entity) VALUES ('UPC', 'UPC', 0, '123456789012', __ENTITY__)", 'ignoreerror'=>1),
      array('sql'=>"INSERT INTO ".MAIN_DB_PREFIX."c_barcode_type (code, libelle, coder, example, entity) VALUES ('ISBN', 'ISBN', 0, '123456789', __ENTITY__)", 'ignoreerror'=>1),
      array('sql'=>"INSERT INTO ".MAIN_DB_PREFIX."c_barcode_type (code, libelle, coder, example, entity) VALUES ('C39', 'Code 39', 0, '1234567890', __ENTITY__)", 'ignoreerror'=>1),
      array('sql'=>"INSERT INTO ".MAIN_DB_PREFIX."c_barcode_type (code, libelle, coder, example, entity) VALUES ('C128', 'Code 128', 0, 'ABCD1234567890', __ENTITY__)", 'ignoreerror'=>1),
      array('sql'=>"INSERT INTO ".MAIN_DB_PREFIX."c_barcode_type (code, libelle, coder, example, entity) VALUES ('DATAMATRIX', 'Datamatrix', 0, '1234567xyz', __ENTITY__)", 'ignoreerror'=>1),
      array('sql'=>"INSERT INTO ".MAIN_DB_PREFIX."c_barcode_type (code, libelle, coder, example, entity) VALUES ('QRCODE', 'Qr Code', 0, 'www.dolibarr.org', __ENTITY__)", 'ignoreerror'=>1)
    );
 
    return $this->_init($sql, $options);
  }
}