modBom.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2004-2018 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2018    Nicolas ZABOURI  <info@inovea-conseil.com>
 * Copyright (C) 2019 Maxime Kohlhaas <maxime@atm-consulting.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 modBom extends DolibarrModules
{
  public function __construct($db)
  {
    global $langs, $conf;

    $this->db = $db;

    // Id for module (must be unique).
    // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
    $this->numero = 650;
    // Key text used to identify module (for permissions, menus, etc...)
    $this->rights_class = 'bom';

    // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
    // It is used to group modules by family in module setup page
    $this->family = "products";
    // Module position in the family on 2 digits ('01', '10', '20', ...)
    $this->module_position = '65';
    // Gives the possibility for the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this)
    //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));

    // Module label (no space allowed), used if translation string 'ModuleBomName' not found (Bom is name of module).
    $this->name = preg_replace('/^mod/i', '', get_class($this));
    // Module description, used if translation string 'ModuleBomDesc' not found (Bom is name of module).
    $this->description = "Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)";
    // Used only if file README.md and README-LL.md not found.
    $this->descriptionlong = "Bill of Materials definitions. They can be used to make Manufacturing Resource Planning";

    // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
    $this->version = 'dolibarr';

    //Url to the file with your last numberversion of this module
    //$this->url_last_version = 'http://www.example.com/versionmodule.txt';
    // Key used in llx_const table to save module status enabled/disabled (where BILLOFMATERIALS is value of property name of module in uppercase)
    $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
    // Name of image file used for this module.
    // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
    // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
    $this->picto = 'bom';

    // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
    $this->module_parts = array(
      /*
        'triggers' => 1,                                  // Set this to 1 if module has its own trigger directory (core/triggers)
      'login' => 0,                                     // Set this to 1 if module has its own login method file (core/login)
      'substitutions' => 1,                             // Set this to 1 if module has its own substitution function file (core/substitutions)
      'menus' => 0,                                     // Set this to 1 if module has its own menus handler directory (core/menus)
      'theme' => 0,                                     // Set this to 1 if module has its own theme directory (theme)
        'tpl' => 0,                                       // Set this to 1 if module overwrite template dir (core/tpl)
      'barcode' => 0,                                   // Set this to 1 if module has its own barcode directory (core/modules/barcode)
      'models' => 0,                                    // Set this to 1 if module has its own models directory (core/modules/xxx)
      'css' => array('/bom/css/bom.css.php'), // Set this to relative path of css file if module has its own css file
      'js' => array('/bom/js/bom.js.php'),          // Set this to relative path of js file if module must load a js on all pages
      'hooks' => array('data'=>array('hookcontext1','hookcontext2'), 'entity'=>'0'),  // Set here all hooks context managed by module. To find available hook context, make a "grep -r '>initHooks(' *" on source code. You can also set hook context 'all'
      'moduleforexternal' => 0              // Set this to 1 if feature of module are opened to external users
        */
    );

    // Data directories to create when module is enabled.
    // Example: this->dirs = array("/bom/temp","/bom/subdir");
    $this->dirs = array("/bom/temp");

    // Config pages. Put here list of php page, stored into bom/admin directory, to use to setup module.
    $this->config_page_url = array("bom.php");

    // Dependencies
    $this->hidden = false; // A condition to hide module
    $this->depends = array('modProduct'); // List of module class names as string that must be enabled if this module is enabled. Example: array('always1'=>'modModuleToEnable1','always2'=>'modModuleToEnable2', 'FR1'=>'modModuleToEnableFR'...)
    $this->requiredby = array('modMrp'); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
    $this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
    $this->langfiles = array("mrp");
    //$this->phpmin = array(5,4);         // Minimum version of PHP required by module
    $this->need_dolibarr_version = array(9, 0); // Minimum version of Dolibarr required by module
    $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
    $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
    //$this->automatic_activation = array('FR'=>'BomWasAutomaticallyActivatedBecauseOfYourCountryChoice');
    //$this->always_enabled = true;               // If true, can't be disabled

    // Constants
    // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
    // Example: $this->const=array(0=>array('BILLOFMATERIALS_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
    //                             1=>array('BILLOFMATERIALS_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
    // );
    $this->const = array(
      1=>array('BOM_ADDON_PDF', 'chaine', 'generic_bom_odt', 'Name of PDF model of BOM', 0),
      2=>array('BOM_ADDON', 'chaine', 'mod_bom_standard', 'Name of numbering rules of BOM', 0),
      3=>array('BOM_ADDON_PDF_ODT_PATH', 'chaine', 'DOL_DATA_ROOT/doctemplates/boms', '', 0)
    );

    // Some keys to add into the overwriting translation tables
    /*$this->overwrite_translation = array(
      'en_US:ParentCompany'=>'Parent company or reseller',
      'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
    )*/

    if (!isset($conf->bom) || !isset($conf->bom->enabled))
    {
      $conf->bom = new stdClass();
      $conf->bom->enabled = 0;
    }


    // Array to add new pages in new tabs
    $this->tabs = array();
    // Example:
    // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@bom:$user->rights->bom->read:/bom/mynewtab1.php?id=__ID__');           // To add a new tab identified by code tabname1
    // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@bom:$user->rights->othermodule->read:/bom/mynewtab2.php?id=__ID__',   // To add another new tab identified by code tabname2. Label will be result of calling all substitution functions on 'Title2' key.
    // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove');                                                                         // To remove an existing tab identified by code tabname
    //
    // Where objecttype can be
    // 'categories_x'   to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
    // 'contact'          to add a tab in contact view
    // 'contract'         to add a tab in contract view
    // 'group'            to add a tab in group view
    // 'intervention'     to add a tab in intervention view
    // 'invoice'          to add a tab in customer invoice view
    // 'invoice_supplier' to add a tab in supplier invoice view
    // 'member'           to add a tab in fundation member view
    // 'opensurveypoll'   to add a tab in opensurvey poll view
    // 'order'            to add a tab in customer order view
    // 'order_supplier'   to add a tab in supplier order view
    // 'payment'      to add a tab in payment view
    // 'payment_supplier' to add a tab in supplier payment view
    // 'product'          to add a tab in product view
    // 'propal'           to add a tab in propal view
    // 'project'          to add a tab in project view
    // 'stock'            to add a tab in stock view
    // 'thirdparty'       to add a tab in third party view
    // 'user'             to add a tab in user view


    // Dictionaries
    $this->dictionaries = array();
    /* Example:
        $this->dictionaries=array(
            'langs'=>'mylangfile@bom',
            'tabname'=>array(MAIN_DB_PREFIX."table1",MAIN_DB_PREFIX."table2",MAIN_DB_PREFIX."table3"),    // List of tables we want to see into dictonnary editor
            'tablib'=>array("Table1","Table2","Table3"),                          // Label of tables
            'tabsql'=>array('SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table1 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table2 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table3 as f'), // Request to select fields
            'tabsqlsort'=>array("label ASC","label ASC","label ASC"),                                         // Sort order
            'tabfield'=>array("code,label","code,label","code,label"),                                          // List of fields (result of select to show dictionary)
            'tabfieldvalue'=>array("code,label","code,label","code,label"),                                       // List of fields (list of fields to edit a record)
            'tabfieldinsert'=>array("code,label","code,label","code,label"),                                      // List of fields (list of fields for insert)
            'tabrowid'=>array("rowid","rowid","rowid"),                                                 // Name of columns with primary key (try to always name it 'rowid')
            'tabcond'=>array($conf->bom->enabled,$conf->bom->enabled,$conf->bom->enabled)                       // Condition to show each dictionary
        );
        */


    // Boxes/Widgets
    // Add here list of php file(s) stored in bom/core/boxes that contains class to show a widget.
    $this->boxes = array(
      0=>array('file' => 'box_boms.php', 'note' => '', 'enabledbydefaulton' => 'Home')
    );


    // Cronjobs (List of cron jobs entries to add when module is enabled)
    // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
    $this->cronjobs = array(
      //0=>array('label'=>'MyJob label', 'jobtype'=>'method', 'class'=>'/bom/class/bom.class.php', 'objectname'=>'Bom', 'method'=>'doScheduledJob', 'parameters'=>'', 'comment'=>'Comment', 'frequency'=>2, 'unitfrequency'=>3600, 'status'=>0, 'test'=>'$conf->bom->enabled', 'priority'=>50)
    );
    // Example: $this->cronjobs=array(0=>array('label'=>'My label', 'jobtype'=>'method', 'class'=>'/dir/class/file.class.php', 'objectname'=>'MyClass', 'method'=>'myMethod', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>2, 'unitfrequency'=>3600, 'status'=>0, 'test'=>'$conf->bom->enabled', 'priority'=>50),
    //                                1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'$conf->bom->enabled', 'priority'=>50)
    // );


    // Permissions provided by this module
    $this->rights = array(); // Permission array used by this module

    $r = 0;
    $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
    $this->rights[$r][1] = 'Read bom of Bom'; // Permission label
    $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'read'; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
    $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)

    $r++;
    $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
    $this->rights[$r][1] = 'Create/Update bom of Bom'; // Permission label
    $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'write'; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
    $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)

    $r++;
    $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
    $this->rights[$r][1] = 'Delete bom of Bom'; // Permission label
    $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'delete'; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
    $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)


    // Main menu entries to add
    $this->menu = array(); // List of menus to add
    $r = 0;

    // Add here entries to declare new menus

    /* BEGIN MODULEBUILDER TOPMENU */
    /*$this->menu[$r++]=array('fk_menu'=>'',                      // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
                'type'=>'top',                      // This is a Top menu entry
                'titre'=>'Bom',
                'mainmenu'=>'bom',
                'leftmenu'=>'',
                'url'=>'/bom/bom_list.php',
                'langs'=>'mrp',         // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
                'position'=>1000+$r,
                'enabled'=>'$conf->bom->enabled', // Define condition to show or hide menu entry. Use '$conf->bom->enabled' if entry must be visible if module is enabled.
                'perms'=>'1',                     // Use 'perms'=>'$user->rights->bom->level1->level2' if you want your menu with a permission rules
                'target'=>'',
                'user'=>2);                       // 0=Menu for internal users, 1=external users, 2=both
        */
    /* END MODULEBUILDER TOPMENU */

    /* BEGIN MODULEBUILDER LEFTMENU BILLOFMATERIALS
    $this->menu[$r++]=array(  'fk_menu'=>'fk_mainmenu=bom',     // '' if this is a top menu. For left menu, 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'=>'List Bom',
                'mainmenu'=>'bom',
                'leftmenu'=>'bom_bom_list',
                'url'=>'/bom/bom_list.php',
                'langs'=>'mrp',         // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
                'position'=>1000+$r,
                'enabled'=>'$conf->bom->enabled',  // Define condition to show or hide menu entry. Use '$conf->bom->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
                'perms'=>'1',                     // Use 'perms'=>'$user->rights->bom->level1->level2' if you want your menu with a permission rules
                'target'=>'',
                'user'=>2);                       // 0=Menu for internal users, 1=external users, 2=both
    $this->menu[$r++]=array(  'fk_menu'=>'fk_mainmenu=bom,fk_leftmenu=bom',     // '' if this is a top menu. For left menu, 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'=>'New Bom',
                'mainmenu'=>'bom',
                'leftmenu'=>'bom_bom_new',
                'url'=>'/bom/bom_page.php?action=create',
                'langs'=>'mrp',         // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
                'position'=>1000+$r,
                'enabled'=>'$conf->bom->enabled',  // Define condition to show or hide menu entry. Use '$conf->bom->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
                'perms'=>'1',                     // Use 'perms'=>'$user->rights->bom->level1->level2' if you want your menu with a permission rules
                'target'=>'',
                'user'=>2);                       // 0=Menu for internal users, 1=external users, 2=both
    */

    /* END MODULEBUILDER LEFTMENU BILLOFMATERIALS */


    // Exports
    $r = 1;

    /* BEGIN MODULEBUILDER EXPORT BILLOFMATERIALS */
    $langs->load("mrp");
    $this->export_code[$r] = $this->rights_class.'_'.$r;
    $this->export_label[$r] = 'BomAndBomLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
    $this->export_icon[$r] = 'bom';
    $keyforclass = 'BOM'; $keyforclassfile = '/bom/class/bom.class.php'; $keyforelement = 'bom';
    include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
    $keyforclass = 'BOMLine'; $keyforclassfile = '/bom/class/bom.class.php'; $keyforelement = 'bomline'; $keyforalias = 'tl';
    include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
    unset($this->export_fields_array[$r]['tl.fk_bom']);
    $keyforselect = 'bom_bom'; $keyforaliasextra = 'extra'; $keyforelement = 'bom';
    include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
    $keyforselect = 'bom_bomline'; $keyforaliasextra = 'extraline'; $keyforelement = 'bomline';
    include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
    $this->export_dependencies_array[$r] = array('bomline'=>'tl.rowid'); // To force to activate one or several fields if we select some fields that need same (like to select a unique key if we ask a field of a child to avoid the DISTINCT to discard them, or for computed field than need several other fields)
    $this->export_sql_start[$r] = 'SELECT DISTINCT ';
    $this->export_sql_end[$r]  = ' FROM '.MAIN_DB_PREFIX.'bom_bom as t';
    $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'bom_bom_extrafields as extra on (t.rowid = extra.fk_object)';
    $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'bom_bomline as tl ON tl.fk_bom = t.rowid';
    $this->export_sql_end[$r] .= ' WHERE 1 = 1';
    $this->export_sql_end[$r] .= ' AND t.entity IN ('.getEntity('bom').')';
    $r++;
    /* END MODULEBUILDER EXPORT BILLOFMATERIALS */
  }

  public function init($options = '')
  {
    global $conf, $langs;

    $result = $this->_load_tables('/bom/sql/');
    if ($result < 0) return -1; // Do not activate module if not allowed errors found on module SQL queries (the _load_table run sql with run_sql with error allowed parameter to 'default')

    // Create extrafields
    //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
    //$extrafields = new ExtraFields($this->db);
    //$result1=$extrafields->addExtraField('myattr1', "New Attr 1 label", 'boolean', 1,  3, 'thirdparty',   0, 0, '', '', 1, '', 0, 0, '', '', 'mrp', '$conf->bom->enabled');
    //$result2=$extrafields->addExtraField('myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project',      0, 0, '', '', 1, '', 0, 0, '', '', 'mrp', '$conf->bom->enabled');
    //$result3=$extrafields->addExtraField('myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'mrp', '$conf->bom->enabled');
    //$result4=$extrafields->addExtraField('myattr4', "New Attr 4 label", 'select',  1,  3, 'thirdparty',   0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1,'', 0, 0, '', '', 'mrp', '$conf->bom->enabled');
    //$result5=$extrafields->addExtraField('myattr5', "New Attr 5 label", 'text',    1, 10, 'user',         0, 0, '', '', 1, '', 0, 0, '', '', 'mrp', '$conf->bom->enabled');


    // Permissions
    $this->remove($options);

    $sql = array();

    // ODT template
    $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/boms/template_bom.odt';
    $dirodt = DOL_DATA_ROOT.'/doctemplates/boms';
    $dest = $dirodt.'/template_bom.odt';

    if (file_exists($src) && !file_exists($dest))
    {
      require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
      dol_mkdir($dirodt);
      $result = dol_copy($src, $dest, 0, 0);
      if ($result < 0)
      {
        $langs->load("errors");
        $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
        return 0;
      }
    }

    $sql = array(
      //"DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape('standard')."' AND type = 'bom' AND entity = ".$conf->entity,
      //"INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape('standard')."', 'bom', ".$conf->entity.")"
    );

    return $this->_init($sql, $options);
  }

  public function remove($options = '')
  {
    $sql = array();

    return $this->_remove($sql, $options);
  }
}