2019-02-26 19:27:04 +01:00
< ? 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 >
2021-05-05 13:47:43 +02:00
* Copyright ( C ) 2021 Ferran Marcet < fmarcet @ 2 byte . es >
2019-02-26 19:27:04 +01:00
*
* 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
2019-09-23 21:55:30 +02:00
* along with this program . If not , see < https :// www . gnu . org / licenses />.
2019-02-26 19:27:04 +01:00
*/
/**
* \defgroup bom Module Bom
* \brief Bom module descriptor .
*
2019-12-15 10:02:20 +01:00
* \file htdocs / core / modules / modBom . class . php
2019-02-26 19:27:04 +01:00
* \ingroup bom
2021-03-20 13:55:43 +01:00
* \brief Description and activation file for the module Bom
2019-02-26 19:27:04 +01:00
*/
2019-11-13 18:31:18 +01:00
include_once DOL_DOCUMENT_ROOT . '/core/modules/DolibarrModules.class.php' ;
2019-02-26 19:27:04 +01:00
/**
* Description and activation class for module Bom
*/
class modBom extends DolibarrModules
{
/**
* Constructor . Define names , constants , directories , boxes , permissions
*
* @ param DoliDB $db Database handler
*/
public function __construct ( $db )
{
2020-04-10 10:59:32 +02:00
global $langs , $conf ;
2019-02-26 19:27:04 +01:00
2019-11-07 12:59:59 +01:00
$this -> db = $db ;
2019-02-26 19:27:04 +01:00
// Id for module (must be unique).
// Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
2019-03-04 13:30:43 +01:00
$this -> numero = 650 ;
2019-02-26 19:27:04 +01:00
// 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', ...)
2020-10-02 16:15:24 +02:00
$this -> module_position = '65' ;
2019-02-26 19:27:04 +01:00
// 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).
2019-02-27 00:54:07 +01:00
$this -> name = preg_replace ( '/^mod/i' , '' , get_class ( $this ));
2019-02-26 19:27:04 +01:00
// Module description, used if translation string 'ModuleBomDesc' not found (Bom is name of module).
2019-10-14 12:10:14 +02:00
$this -> description = " Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO) " ;
2019-02-26 19:27:04 +01:00
// 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'
2019-09-09 12:58:32 +02:00
$this -> version = 'dolibarr' ;
2019-02-26 19:27:04 +01:00
2019-11-07 12:59:59 +01:00
//Url to the file with your last numberversion of this module
//$this->url_last_version = 'http://www.example.com/versionmodule.txt';
2019-02-26 19:27:04 +01:00
// 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'
2019-11-13 18:31:18 +01:00
$this -> picto = 'bom' ;
2019-02-26 19:27:04 +01:00
// Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
$this -> module_parts = array (
2019-11-07 12:59:59 +01:00
/*
2021-02-23 22:03:23 +01:00
'triggers' => 1 , // Set this to 1 if module has its own trigger directory (core/triggers)
2019-02-26 19:27:04 +01:00
'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)
2021-02-23 22:03:23 +01:00
'tpl' => 0 , // Set this to 1 if module overwrite template dir (core/tpl)
2019-02-26 19:27:04 +01:00
'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
2021-02-23 22:03:23 +01:00
'js' => array ( '/bom/js/bom.js.php' ), // Set this to relative path of js file if module must load a js on all pages
2019-02-26 19:27:04 +01:00
'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
2021-02-23 22:03:23 +01:00
*/
2019-02-26 19:27:04 +01:00
);
// 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.
2019-03-04 13:30:43 +01:00
$this -> config_page_url = array ( " bom.php " );
2019-02-26 19:27:04 +01:00
// Dependencies
2019-11-13 18:31:18 +01:00
$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', ...)
2019-03-04 12:46:07 +01:00
$this -> langfiles = array ( " mrp " );
2021-02-06 13:48:31 +01:00
//$this->phpmin = array(5, 6)); // Minimum version of PHP required by module
2019-11-13 18:31:18 +01:00
$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'...)
2019-02-26 19:27:04 +01:00
//$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 (
2019-11-28 15:17:55 +01:00
1 => array ( 'BOM_ADDON_PDF' , 'chaine' , 'generic_bom_odt' , 'Name of PDF model of BOM' , 0 ),
2019-11-07 12:59:59 +01:00
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 )
2019-02-26 19:27:04 +01:00
);
// 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'
) */
2021-02-23 22:03:23 +01:00
if ( ! isset ( $conf -> bom ) || ! isset ( $conf -> bom -> enabled )) {
2019-11-13 18:31:18 +01:00
$conf -> bom = new stdClass ();
$conf -> bom -> enabled = 0 ;
2019-02-26 19:27:04 +01:00
}
// Array to add new pages in new tabs
2019-11-07 12:59:59 +01:00
$this -> tabs = array ();
2019-02-26 19:27:04 +01:00
// 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
2019-11-07 12:59:59 +01:00
// $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
2019-02-26 19:27:04 +01:00
// '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
2019-11-07 12:59:59 +01:00
// Dictionaries
2020-04-10 10:59:32 +02:00
$this -> dictionaries = array ();
2019-11-07 12:59:59 +01:00
/* Example :
2021-02-23 22:03:23 +01:00
$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
);
*/
2019-02-26 19:27:04 +01:00
2019-11-07 12:59:59 +01:00
// Boxes/Widgets
2019-02-26 19:27:04 +01:00
// Add here list of php file(s) stored in bom/core/boxes that contains class to show a widget.
2019-11-07 12:59:59 +01:00
$this -> boxes = array (
0 => array ( 'file' => 'box_boms.php' , 'note' => '' , 'enabledbydefaulton' => 'Home' )
);
2019-02-26 19:27:04 +01:00
// 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)
// );
2019-10-31 22:46:34 +01:00
// Permissions provided by this module
2020-04-10 10:59:32 +02:00
$this -> rights = array (); // Permission array used by this module
2019-02-26 19:27:04 +01:00
2021-04-05 13:52:19 +02:00
$r = 1 ;
2020-04-10 10:59:32 +02:00
$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)
2019-02-26 19:27:04 +01:00
$r ++ ;
2020-04-10 10:59:32 +02:00
$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)
2019-02-26 19:27:04 +01:00
$r ++ ;
2020-04-10 10:59:32 +02:00
$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)
2019-02-26 19:27:04 +01:00
2019-10-31 22:46:34 +01:00
// Main menu entries to add
2020-04-10 10:59:32 +02:00
$this -> menu = array (); // List of menus to add
$r = 0 ;
2019-02-26 19:27:04 +01:00
// 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' ,
2019-03-04 12:46:07 +01:00
'langs' => 'mrp' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
2019-02-26 19:27:04 +01:00
'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
2021-02-23 22:03:23 +01:00
*/
2019-02-26 19:27:04 +01:00
/* 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' ,
2019-03-04 12:46:07 +01:00
'langs' => 'mrp' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
2019-02-26 19:27:04 +01:00
'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' ,
2019-03-04 12:46:07 +01:00
'langs' => 'mrp' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
2019-02-26 19:27:04 +01:00
'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
*/
2019-04-03 13:26:50 +02:00
2019-02-26 19:27:04 +01:00
/* END MODULEBUILDER LEFTMENU BILLOFMATERIALS */
// Exports
2019-11-13 18:31:18 +01:00
$r = 1 ;
2019-02-26 19:27:04 +01:00
/* BEGIN MODULEBUILDER EXPORT BILLOFMATERIALS */
2019-10-27 15:56:20 +01:00
$langs -> load ( " mrp " );
2019-11-13 18:31:18 +01:00
$this -> export_code [ $r ] = $this -> rights_class . '_' . $r ;
$this -> export_label [ $r ] = 'BomAndBomLines' ; // Translation key (used only if key ExportDataset_xxx_z not found)
2021-03-20 19:15:15 +01:00
$this -> export_permission [ $r ] = array ( array ( " bom " , " read " ));
2019-11-13 18:31:18 +01:00
$this -> export_icon [ $r ] = 'bom' ;
2021-03-01 20:37:16 +01:00
$keyforclass = 'BOM' ;
$keyforclassfile = '/bom/class/bom.class.php' ;
$keyforelement = 'bom' ;
2019-02-26 19:27:04 +01:00
include DOL_DOCUMENT_ROOT . '/core/commonfieldsinexport.inc.php' ;
2021-03-01 20:37:16 +01:00
$keyforclass = 'BOMLine' ;
$keyforclassfile = '/bom/class/bom.class.php' ;
$keyforelement = 'bomline' ;
$keyforalias = 'tl' ;
2019-10-27 15:56:20 +01:00
include DOL_DOCUMENT_ROOT . '/core/commonfieldsinexport.inc.php' ;
unset ( $this -> export_fields_array [ $r ][ 'tl.fk_bom' ]);
2021-03-01 20:37:16 +01:00
$keyforselect = 'bom_bom' ;
$keyforaliasextra = 'extra' ;
$keyforelement = 'bom' ;
2019-10-27 15:56:20 +01:00
include DOL_DOCUMENT_ROOT . '/core/extrafieldsinexport.inc.php' ;
2021-03-01 20:37:16 +01:00
$keyforselect = 'bom_bomline' ;
$keyforaliasextra = 'extraline' ;
$keyforelement = 'bomline' ;
2019-02-26 19:27:04 +01:00
include DOL_DOCUMENT_ROOT . '/core/extrafieldsinexport.inc.php' ;
2019-11-13 18:31:18 +01:00
$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' ;
2020-11-27 15:27:35 +01:00
$this -> export_sql_end [ $r ] .= ' LEFT JOIN ' . MAIN_DB_PREFIX . 'bom_bom_extrafields as extra on (t.rowid = extra.fk_object)' ;
2019-11-13 18:31:18 +01:00
$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' ) . ')' ;
2019-10-27 15:56:20 +01:00
$r ++ ;
2019-02-26 19:27:04 +01:00
/* END MODULEBUILDER EXPORT BILLOFMATERIALS */
2021-05-05 13:47:43 +02:00
// Imports
//--------
$r = 0 ;
//Import BOM Header
$r ++ ;
$this -> import_code [ $r ] = 'bom_' . $r ;
$this -> import_label [ $r ] = 'BillOfMaterials' ;
$this -> import_icon [ $r ] = $this -> picto ;
2021-09-02 21:00:31 +02:00
$this -> import_entities_array [ $r ] = array ();
$this -> import_tables_array [ $r ] = array ( 'b' => MAIN_DB_PREFIX . 'bom_bom' , 'extra' => MAIN_DB_PREFIX . 'bom_bom_extrafields' );
$this -> import_tables_creator_array [ $r ] = array ( 'b' => 'fk_user_creat' ); // Fields to store import user id
$this -> import_fields_array [ $r ] = array (
'b.ref' => 'Ref*' ,
'b.label' => 'Label*' ,
2021-05-05 13:47:43 +02:00
'b.fk_product' => 'ProductRef*' ,
'b.description' => 'Description' ,
'b.note_public' => 'Note' ,
'b.note_private' => 'NotePrivate' ,
'b.fk_warehouse' => 'WarehouseRef' ,
'b.qty' => 'Qty' ,
'b.efficiency' => 'Efficiency' ,
'b.duration' => 'Duration' ,
'b.date_creation' => 'DateCreation' ,
'b.date_valid' => 'DateValid' ,
'b.fk_user_modif' => 'ModifiedById' ,
'b.fk_user_valid' => 'ValidatedById' ,
'b.model_pdf' => 'Model' ,
'b.status' => 'Status*' ,
2021-09-02 21:00:31 +02:00
'b.bomtype' => 'Type*'
);
$import_sample = array ();
2021-05-05 13:47:43 +02:00
// Add extra fields
2021-09-02 21:00:31 +02:00
$import_extrafield_sample = array ();
2021-05-05 13:47:43 +02:00
$sql = " SELECT name, label, fieldrequired FROM " . MAIN_DB_PREFIX . " extrafields WHERE elementtype = 'bom_bom' AND entity IN (0, " . $conf -> entity . " ) " ;
$resql = $this -> db -> query ( $sql );
if ( $resql ) {
while ( $obj = $this -> db -> fetch_object ( $resql )) {
$fieldname = 'extra.' . $obj -> name ;
$fieldlabel = ucfirst ( $obj -> label );
$this -> import_fields_array [ $r ][ $fieldname ] = $fieldlabel . ( $obj -> fieldrequired ? '*' : '' );
$import_extrafield_sample [ $fieldname ] = $fieldlabel ;
}
}
// End add extra fields
2021-09-02 21:00:31 +02:00
$this -> import_examplevalues_array [ $r ] = array_merge ( $import_sample , $import_extrafield_sample );
$this -> import_fieldshidden_array [ $r ] = array ( 'extra.fk_object' => 'lastrowid-' . MAIN_DB_PREFIX . 'bom_bom' );
$this -> import_regex_array [ $r ] = array (
'b.ref' => ''
);
2021-05-05 13:47:43 +02:00
2021-09-02 21:00:31 +02:00
$this -> import_updatekeys_array [ $r ] = array ( 'b.ref' => 'Ref' );
$this -> import_convertvalue_array [ $r ] = array (
'b.fk_product' => array (
2021-05-05 13:47:43 +02:00
'rule' => 'fetchidfromref' ,
'file' => '/product/class/product.class.php' ,
'class' => 'Product' ,
'method' => 'fetch' ,
'element' => 'Product'
2021-09-02 21:00:31 +02:00
),
'b.fk_warehouse' => array (
2021-05-05 13:47:43 +02:00
'rule' => 'fetchidfromref' ,
'file' => '/product/stock/class/entrepot.class.php' ,
'class' => 'Entrepot' ,
'method' => 'fetch' ,
'element' => 'Warehouse'
2021-09-02 21:00:31 +02:00
),
'b.fk_user_valid' => array (
2021-05-05 13:47:43 +02:00
'rule' => 'fetchidfromref' ,
'file' => '/user/class/user.class.php' ,
'class' => 'User' ,
'method' => 'fetch' ,
'element' => 'user'
2021-09-02 21:00:31 +02:00
),
'b.fk_user_modif' => array (
2021-05-05 13:47:43 +02:00
'rule' => 'fetchidfromref' ,
'file' => '/user/class/user.class.php' ,
'class' => 'User' ,
'method' => 'fetch' ,
'element' => 'user'
2021-09-02 21:00:31 +02:00
),
);
2021-05-05 13:47:43 +02:00
//Import BOM Lines
$r ++ ;
$this -> import_code [ $r ] = 'bom_lines_' . $r ;
2021-09-02 21:00:31 +02:00
$this -> import_label [ $r ] = 'BillOfMaterialsLines' ;
2021-05-05 13:47:43 +02:00
$this -> import_icon [ $r ] = $this -> picto ;
2021-09-02 21:00:31 +02:00
$this -> import_entities_array [ $r ] = array ();
$this -> import_tables_array [ $r ] = array ( 'bd' => MAIN_DB_PREFIX . 'bom_bomline' , 'extra' => MAIN_DB_PREFIX . 'bom_bomline_extrafields' );
$this -> import_fields_array [ $r ] = array (
'bd.fk_bom' => 'BOM*' ,
2021-05-05 13:47:43 +02:00
'bd.fk_product' => 'ProductRef' ,
'bd.fk_bom_child' => 'BOMChild' ,
'bd.description' => 'Description' ,
'bd.qty' => 'LineQty' ,
2021-09-02 21:00:31 +02:00
'bd.qty_frozen' => 'LineIsFrozen' ,
2021-05-05 13:47:43 +02:00
'bd.disable_stock_change' => 'Disable Stock Change' ,
'bd.efficiency' => 'Efficiency' ,
'bd.position' => 'LinePosition'
2021-09-02 21:00:31 +02:00
);
2021-05-05 13:47:43 +02:00
// Add extra fields
$sql = " SELECT name, label, fieldrequired FROM " . MAIN_DB_PREFIX . " extrafields WHERE elementtype = 'bom_bomline' AND entity IN (0, " . $conf -> entity . " ) " ;
$resql = $this -> db -> query ( $sql );
if ( $resql ) {
while ( $obj = $this -> db -> fetch_object ( $resql )) {
$fieldname = 'extra.' . $obj -> name ;
$fieldlabel = ucfirst ( $obj -> label );
$this -> import_fields_array [ $r ][ $fieldname ] = $fieldlabel . ( $obj -> fieldrequired ? '*' : '' );
}
}
// End add extra fields
2021-09-02 21:00:31 +02:00
$this -> import_fieldshidden_array [ $r ] = array ( 'extra.fk_object' => 'lastrowid-' . MAIN_DB_PREFIX . 'bom_bomline' );
$this -> import_regex_array [ $r ] = array ();
$this -> import_updatekeys_array [ $r ] = array ( 'bd.fk_bom' => 'BOM Id' );
$this -> import_convertvalue_array [ $r ] = array (
'bd.fk_bom' => array (
2021-05-05 13:47:43 +02:00
'rule' => 'fetchidfromref' ,
'file' => '/bom/class/bom.class.php' ,
'class' => 'BOM' ,
'method' => 'fetch' ,
'element' => 'bom'
2021-09-02 21:00:31 +02:00
),
'bd.fk_product' => array (
2021-05-05 13:47:43 +02:00
'rule' => 'fetchidfromref' ,
'file' => '/product/class/product.class.php' ,
'class' => 'Product' ,
'method' => 'fetch' ,
'element' => 'Product'
2021-09-02 21:00:31 +02:00
),
);
2019-02-26 19:27:04 +01:00
}
/**
* Function called when module is enabled .
* The init function add constants , boxes , permissions and menus ( defined in constructor ) into Dolibarr database .
* It also creates data directories
*
2019-11-07 12:59:59 +01:00
* @ param string $options Options when enabling module ( '' , 'noboxes' )
2019-02-26 19:27:04 +01:00
* @ return int 1 if OK , 0 if KO
*/
public function init ( $options = '' )
{
2019-11-07 12:59:59 +01:00
global $conf , $langs ;
2019-10-31 02:36:16 +01:00
2019-02-26 19:27:04 +01:00
// Create extrafields
2019-10-31 22:46:34 +01:00
//include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
//$extrafields = new ExtraFields($this->db);
2019-03-04 12:46:07 +01:00
//$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');
2019-02-26 19:27:04 +01:00
2019-10-31 02:36:16 +01:00
// Permissions
$this -> remove ( $options );
2019-02-26 19:27:04 +01:00
$sql = array ();
2019-10-31 02:36:16 +01:00
// ODT template
2020-04-10 10:59:32 +02:00
$src = DOL_DOCUMENT_ROOT . '/install/doctemplates/boms/template_bom.odt' ;
$dirodt = DOL_DATA_ROOT . '/doctemplates/boms' ;
$dest = $dirodt . '/template_bom.odt' ;
2019-10-31 02:36:16 +01:00
2021-02-23 22:03:23 +01:00
if ( file_exists ( $src ) && ! file_exists ( $dest )) {
2019-11-07 12:59:59 +01:00
require_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php' ;
dol_mkdir ( $dirodt );
2020-04-10 10:59:32 +02:00
$result = dol_copy ( $src , $dest , 0 , 0 );
2021-02-23 22:03:23 +01:00
if ( $result < 0 ) {
2019-11-07 12:59:59 +01:00
$langs -> load ( " errors " );
2020-04-10 10:59:32 +02:00
$this -> error = $langs -> trans ( 'ErrorFailToCopyFile' , $src , $dest );
2019-11-07 12:59:59 +01:00
return 0 ;
}
2019-10-31 02:36:16 +01:00
}
$sql = array (
2021-08-27 22:42:04 +02:00
//"DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape('standard')."' AND type = 'bom' AND entity = ".((int) $conf->entity),
//"INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape('standard')."', 'bom', ".((int) $conf->entity).")"
2019-10-31 02:36:16 +01:00
);
2019-02-26 19:27:04 +01:00
return $this -> _init ( $sql , $options );
}
/**
* Function called when module is disabled .
* Remove from database constants , boxes and permissions from Dolibarr database .
* Data directories are not deleted
*
* @ param string $options Options when enabling module ( '' , 'noboxes' )
* @ return int 1 if OK , 0 if KO
*/
public function remove ( $options = '' )
{
$sql = array ();
return $this -> _remove ( $sql , $options );
}
}