modBom.class.php 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527
  1. <?php
  2. /* Copyright (C) 2004-2018 Laurent Destailleur <eldy@users.sourceforge.net>
  3. * Copyright (C) 2018 Nicolas ZABOURI <info@inovea-conseil.com>
  4. * Copyright (C) 2019 Maxime Kohlhaas <maxime@atm-consulting.fr>
  5. * Copyright (C) 2021 Ferran Marcet <fmarcet@2byte.es>
  6. *
  7. * This program is free software; you can redistribute it and/or modify
  8. * it under the terms of the GNU General Public License as published by
  9. * the Free Software Foundation; either version 3 of the License, or
  10. * (at your option) any later version.
  11. *
  12. * This program is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. * GNU General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU General Public License
  18. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  19. */
  20. /**
  21. * \defgroup bom Module Bom
  22. * \brief Bom module descriptor.
  23. *
  24. * \file htdocs/core/modules/modBom.class.php
  25. * \ingroup bom
  26. * \brief Description and activation file for the module Bom
  27. */
  28. include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
  29. /**
  30. * Description and activation class for module Bom
  31. */
  32. class modBom extends DolibarrModules
  33. {
  34. /**
  35. * Constructor. Define names, constants, directories, boxes, permissions
  36. *
  37. * @param DoliDB $db Database handler
  38. */
  39. public function __construct($db)
  40. {
  41. global $langs, $conf;
  42. $this->db = $db;
  43. // Id for module (must be unique).
  44. // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
  45. $this->numero = 650;
  46. // Key text used to identify module (for permissions, menus, etc...)
  47. $this->rights_class = 'bom';
  48. // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
  49. // It is used to group modules by family in module setup page
  50. $this->family = "products";
  51. // Module position in the family on 2 digits ('01', '10', '20', ...)
  52. $this->module_position = '65';
  53. // 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)
  54. //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
  55. // Module label (no space allowed), used if translation string 'ModuleBomName' not found (Bom is name of module).
  56. $this->name = preg_replace('/^mod/i', '', get_class($this));
  57. // Module description, used if translation string 'ModuleBomDesc' not found (Bom is name of module).
  58. $this->description = "Module to define your Bills Of Materials (BOM). Can be used for Manufacturing Resource Planning by the module Manufacturing Orders (MO)";
  59. // Used only if file README.md and README-LL.md not found.
  60. $this->descriptionlong = "Bill of Materials definitions. They can be used to make Manufacturing Resource Planning";
  61. // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
  62. $this->version = 'dolibarr';
  63. //Url to the file with your last numberversion of this module
  64. //$this->url_last_version = 'http://www.example.com/versionmodule.txt';
  65. // Key used in llx_const table to save module status enabled/disabled (where BILLOFMATERIALS is value of property name of module in uppercase)
  66. $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
  67. // Name of image file used for this module.
  68. // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
  69. // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
  70. $this->picto = 'bom';
  71. // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
  72. $this->module_parts = array(
  73. /*
  74. 'triggers' => 1, // Set this to 1 if module has its own trigger directory (core/triggers)
  75. 'login' => 0, // Set this to 1 if module has its own login method file (core/login)
  76. 'substitutions' => 1, // Set this to 1 if module has its own substitution function file (core/substitutions)
  77. 'menus' => 0, // Set this to 1 if module has its own menus handler directory (core/menus)
  78. 'theme' => 0, // Set this to 1 if module has its own theme directory (theme)
  79. 'tpl' => 0, // Set this to 1 if module overwrite template dir (core/tpl)
  80. 'barcode' => 0, // Set this to 1 if module has its own barcode directory (core/modules/barcode)
  81. 'models' => 0, // Set this to 1 if module has its own models directory (core/modules/xxx)
  82. 'css' => array('/bom/css/bom.css.php'), // Set this to relative path of css file if module has its own css file
  83. 'js' => array('/bom/js/bom.js.php'), // Set this to relative path of js file if module must load a js on all pages
  84. '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'
  85. 'moduleforexternal' => 0 // Set this to 1 if feature of module are opened to external users
  86. */
  87. );
  88. // Data directories to create when module is enabled.
  89. // Example: this->dirs = array("/bom/temp","/bom/subdir");
  90. $this->dirs = array("/bom/temp");
  91. // Config pages. Put here list of php page, stored into bom/admin directory, to use to setup module.
  92. $this->config_page_url = array("bom.php");
  93. // Dependencies
  94. $this->hidden = false; // A condition to hide module
  95. $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'...)
  96. $this->requiredby = array('modMrp'); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
  97. $this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
  98. $this->langfiles = array("mrp");
  99. //$this->phpmin = array(5, 6)); // Minimum version of PHP required by module
  100. $this->need_dolibarr_version = array(9, 0); // Minimum version of Dolibarr required by module
  101. $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
  102. $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
  103. //$this->automatic_activation = array('FR'=>'BomWasAutomaticallyActivatedBecauseOfYourCountryChoice');
  104. //$this->always_enabled = true; // If true, can't be disabled
  105. // Constants
  106. // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
  107. // Example: $this->const=array(0=>array('BILLOFMATERIALS_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
  108. // 1=>array('BILLOFMATERIALS_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
  109. // );
  110. $this->const = array(
  111. 1=>array('BOM_ADDON_PDF', 'chaine', 'generic_bom_odt', 'Name of PDF model of BOM', 0),
  112. 2=>array('BOM_ADDON', 'chaine', 'mod_bom_standard', 'Name of numbering rules of BOM', 0),
  113. 3=>array('BOM_ADDON_PDF_ODT_PATH', 'chaine', 'DOL_DATA_ROOT/doctemplates/boms', '', 0)
  114. );
  115. // Some keys to add into the overwriting translation tables
  116. /*$this->overwrite_translation = array(
  117. 'en_US:ParentCompany'=>'Parent company or reseller',
  118. 'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
  119. )*/
  120. if (!isset($conf->bom) || !isset($conf->bom->enabled)) {
  121. $conf->bom = new stdClass();
  122. $conf->bom->enabled = 0;
  123. }
  124. // Array to add new pages in new tabs
  125. $this->tabs = array();
  126. // Example:
  127. // $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
  128. // $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.
  129. // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
  130. //
  131. // Where objecttype can be
  132. // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
  133. // 'contact' to add a tab in contact view
  134. // 'contract' to add a tab in contract view
  135. // 'group' to add a tab in group view
  136. // 'intervention' to add a tab in intervention view
  137. // 'invoice' to add a tab in customer invoice view
  138. // 'invoice_supplier' to add a tab in supplier invoice view
  139. // 'member' to add a tab in fundation member view
  140. // 'opensurveypoll' to add a tab in opensurvey poll view
  141. // 'order' to add a tab in customer order view
  142. // 'order_supplier' to add a tab in supplier order view
  143. // 'payment' to add a tab in payment view
  144. // 'payment_supplier' to add a tab in supplier payment view
  145. // 'product' to add a tab in product view
  146. // 'propal' to add a tab in propal view
  147. // 'project' to add a tab in project view
  148. // 'stock' to add a tab in stock view
  149. // 'thirdparty' to add a tab in third party view
  150. // 'user' to add a tab in user view
  151. // Dictionaries
  152. $this->dictionaries = array();
  153. /* Example:
  154. $this->dictionaries=array(
  155. 'langs'=>'mylangfile@bom',
  156. 'tabname'=>array(MAIN_DB_PREFIX."table1",MAIN_DB_PREFIX."table2",MAIN_DB_PREFIX."table3"), // List of tables we want to see into dictonnary editor
  157. 'tablib'=>array("Table1","Table2","Table3"), // Label of tables
  158. '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
  159. 'tabsqlsort'=>array("label ASC","label ASC","label ASC"), // Sort order
  160. 'tabfield'=>array("code,label","code,label","code,label"), // List of fields (result of select to show dictionary)
  161. 'tabfieldvalue'=>array("code,label","code,label","code,label"), // List of fields (list of fields to edit a record)
  162. 'tabfieldinsert'=>array("code,label","code,label","code,label"), // List of fields (list of fields for insert)
  163. 'tabrowid'=>array("rowid","rowid","rowid"), // Name of columns with primary key (try to always name it 'rowid')
  164. 'tabcond'=>array($conf->bom->enabled,$conf->bom->enabled,$conf->bom->enabled) // Condition to show each dictionary
  165. );
  166. */
  167. // Boxes/Widgets
  168. // Add here list of php file(s) stored in bom/core/boxes that contains class to show a widget.
  169. $this->boxes = array(
  170. 0=>array('file' => 'box_boms.php', 'note' => '', 'enabledbydefaulton' => 'Home')
  171. );
  172. // Cronjobs (List of cron jobs entries to add when module is enabled)
  173. // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
  174. $this->cronjobs = array(
  175. //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)
  176. );
  177. // 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),
  178. // 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)
  179. // );
  180. // Permissions provided by this module
  181. $this->rights = array(); // Permission array used by this module
  182. $r = 1;
  183. $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
  184. $this->rights[$r][1] = 'Read bom of Bom'; // Permission label
  185. $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
  186. $this->rights[$r][4] = 'read'; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
  187. $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
  188. $r++;
  189. $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
  190. $this->rights[$r][1] = 'Create/Update bom of Bom'; // Permission label
  191. $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
  192. $this->rights[$r][4] = 'write'; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
  193. $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
  194. $r++;
  195. $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
  196. $this->rights[$r][1] = 'Delete bom of Bom'; // Permission label
  197. $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
  198. $this->rights[$r][4] = 'delete'; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
  199. $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->bom->level1->level2)
  200. // Main menu entries to add
  201. $this->menu = array(); // List of menus to add
  202. $r = 0;
  203. // Add here entries to declare new menus
  204. /* BEGIN MODULEBUILDER TOPMENU */
  205. /*$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
  206. 'type'=>'top', // This is a Top menu entry
  207. 'titre'=>'Bom',
  208. 'mainmenu'=>'bom',
  209. 'leftmenu'=>'',
  210. 'url'=>'/bom/bom_list.php',
  211. 'langs'=>'mrp', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  212. 'position'=>1000+$r,
  213. '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.
  214. 'perms'=>'1', // Use 'perms'=>'$user->rights->bom->level1->level2' if you want your menu with a permission rules
  215. 'target'=>'',
  216. 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
  217. */
  218. /* END MODULEBUILDER TOPMENU */
  219. /* BEGIN MODULEBUILDER LEFTMENU BILLOFMATERIALS
  220. $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
  221. 'type'=>'left', // This is a Left menu entry
  222. 'titre'=>'List Bom',
  223. 'mainmenu'=>'bom',
  224. 'leftmenu'=>'bom_bom_list',
  225. 'url'=>'/bom/bom_list.php',
  226. 'langs'=>'mrp', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  227. 'position'=>1000+$r,
  228. '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.
  229. 'perms'=>'1', // Use 'perms'=>'$user->rights->bom->level1->level2' if you want your menu with a permission rules
  230. 'target'=>'',
  231. 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
  232. $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
  233. 'type'=>'left', // This is a Left menu entry
  234. 'titre'=>'New Bom',
  235. 'mainmenu'=>'bom',
  236. 'leftmenu'=>'bom_bom_new',
  237. 'url'=>'/bom/bom_page.php?action=create',
  238. 'langs'=>'mrp', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  239. 'position'=>1000+$r,
  240. '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.
  241. 'perms'=>'1', // Use 'perms'=>'$user->rights->bom->level1->level2' if you want your menu with a permission rules
  242. 'target'=>'',
  243. 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
  244. */
  245. /* END MODULEBUILDER LEFTMENU BILLOFMATERIALS */
  246. // Exports
  247. $r = 1;
  248. /* BEGIN MODULEBUILDER EXPORT BILLOFMATERIALS */
  249. $langs->load("mrp");
  250. $this->export_code[$r] = $this->rights_class.'_'.$r;
  251. $this->export_label[$r] = 'BomAndBomLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  252. $this->export_permission[$r] = array(array("bom", "read"));
  253. $this->export_icon[$r] = 'bom';
  254. $keyforclass = 'BOM';
  255. $keyforclassfile = '/bom/class/bom.class.php';
  256. $keyforelement = 'bom';
  257. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  258. $keyforclass = 'BOMLine';
  259. $keyforclassfile = '/bom/class/bom.class.php';
  260. $keyforelement = 'bomline';
  261. $keyforalias = 'tl';
  262. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  263. unset($this->export_fields_array[$r]['tl.fk_bom']);
  264. $keyforselect = 'bom_bom';
  265. $keyforaliasextra = 'extra';
  266. $keyforelement = 'bom';
  267. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  268. $keyforselect = 'bom_bomline';
  269. $keyforaliasextra = 'extraline';
  270. $keyforelement = 'bomline';
  271. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  272. $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)
  273. $this->export_sql_start[$r] = 'SELECT DISTINCT ';
  274. $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'bom_bom as t';
  275. $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'bom_bom_extrafields as extra on (t.rowid = extra.fk_object)';
  276. $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'bom_bomline as tl ON tl.fk_bom = t.rowid';
  277. $this->export_sql_end[$r] .= ' WHERE 1 = 1';
  278. $this->export_sql_end[$r] .= ' AND t.entity IN ('.getEntity('bom').')';
  279. $r++;
  280. /* END MODULEBUILDER EXPORT BILLOFMATERIALS */
  281. // Imports
  282. //--------
  283. $r = 0;
  284. //Import BOM Header
  285. $r++;
  286. $this->import_code[$r] = 'bom_'.$r;
  287. $this->import_label[$r] = 'BillOfMaterials';
  288. $this->import_icon[$r] = $this->picto;
  289. $this->import_entities_array[$r] = array();
  290. $this->import_tables_array[$r] = ['b' => MAIN_DB_PREFIX.'bom_bom', 'extra' => MAIN_DB_PREFIX.'bom_bom_extrafields'];
  291. $this->import_tables_creator_array[$r] = ['b' => 'fk_user_creat']; // Fields to store import user id
  292. $this->import_fields_array[$r] = [
  293. 'b.ref' => 'Document Ref*',
  294. 'b.label' => 'BomLabel*',
  295. 'b.fk_product' => 'ProductRef*',
  296. 'b.description' => 'Description',
  297. 'b.note_public' => 'Note',
  298. 'b.note_private' => 'NotePrivate',
  299. 'b.fk_warehouse' => 'WarehouseRef',
  300. 'b.qty' => 'Qty',
  301. 'b.efficiency' => 'Efficiency',
  302. 'b.duration' => 'Duration',
  303. 'b.date_creation' => 'DateCreation',
  304. 'b.date_valid' => 'DateValid',
  305. 'b.fk_user_modif' => 'ModifiedById',
  306. 'b.fk_user_valid' => 'ValidatedById',
  307. 'b.model_pdf' => 'Model',
  308. 'b.status' => 'Status*',
  309. 'b.bomtype' => 'BomType*'
  310. ];
  311. // Add extra fields
  312. $import_extrafield_sample = array();
  313. $sql = "SELECT name, label, fieldrequired FROM ".MAIN_DB_PREFIX."extrafields WHERE elementtype = 'bom_bom' AND entity IN (0, ".$conf->entity.")";
  314. $resql = $this->db->query($sql);
  315. if ($resql) {
  316. while ($obj = $this->db->fetch_object($resql)) {
  317. $fieldname = 'extra.'.$obj->name;
  318. $fieldlabel = ucfirst($obj->label);
  319. $this->import_fields_array[$r][$fieldname] = $fieldlabel.($obj->fieldrequired ? '*' : '');
  320. $import_extrafield_sample[$fieldname] = $fieldlabel;
  321. }
  322. }
  323. // End add extra fields
  324. $this->import_fieldshidden_array[$r] = ['extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'bom_bom'];
  325. $this->import_regex_array[$r] = [
  326. 'b.ref' => '(CPV\d{4}-\d{4}|BOM\d{4}-\d{4}|PROV.{1,32}$)'
  327. ];
  328. $this->import_updatekeys_array[$r] = ['b.ref' => 'Ref'];
  329. $this->import_convertvalue_array[$r] = [
  330. 'b.fk_product' => [
  331. 'rule' => 'fetchidfromref',
  332. 'file' => '/product/class/product.class.php',
  333. 'class' => 'Product',
  334. 'method' => 'fetch',
  335. 'element' => 'Product'
  336. ],
  337. 'b.fk_warehouse' => [
  338. 'rule' => 'fetchidfromref',
  339. 'file' => '/product/stock/class/entrepot.class.php',
  340. 'class' => 'Entrepot',
  341. 'method' => 'fetch',
  342. 'element' => 'Warehouse'
  343. ],
  344. 'b.fk_user_valid' => [
  345. 'rule' => 'fetchidfromref',
  346. 'file' => '/user/class/user.class.php',
  347. 'class' => 'User',
  348. 'method' => 'fetch',
  349. 'element' => 'user'
  350. ],
  351. 'b.fk_user_modif' => [
  352. 'rule' => 'fetchidfromref',
  353. 'file' => '/user/class/user.class.php',
  354. 'class' => 'User',
  355. 'method' => 'fetch',
  356. 'element' => 'user'
  357. ],
  358. ];
  359. //Import BOM Lines
  360. $r++;
  361. $this->import_code[$r] = 'bom_lines_'.$r;
  362. $this->import_label[$r] = 'BillOfMaterialsLine';
  363. $this->import_icon[$r] = $this->picto;
  364. $this->import_entities_array[$r] = array();
  365. $this->import_tables_array[$r] = ['bd' => MAIN_DB_PREFIX.'bom_bomline', 'extra' => MAIN_DB_PREFIX.'bom_bomline_extrafields'];
  366. $this->import_fields_array[$r] = [
  367. 'bd.fk_bom' => 'Document Ref*',
  368. 'bd.fk_product' => 'ProductRef',
  369. 'bd.fk_bom_child' => 'BOMChild',
  370. 'bd.description' => 'Description',
  371. 'bd.qty' => 'LineQty',
  372. 'bd.qty_frozen' => 'LineIsFrozen',
  373. 'bd.disable_stock_change' => 'Disable Stock Change',
  374. 'bd.efficiency' => 'Efficiency',
  375. 'bd.position' => 'LinePosition'
  376. ];
  377. // Add extra fields
  378. $sql = "SELECT name, label, fieldrequired FROM ".MAIN_DB_PREFIX."extrafields WHERE elementtype = 'bom_bomline' AND entity IN (0, ".$conf->entity.")";
  379. $resql = $this->db->query($sql);
  380. if ($resql) {
  381. while ($obj = $this->db->fetch_object($resql)) {
  382. $fieldname = 'extra.'.$obj->name;
  383. $fieldlabel = ucfirst($obj->label);
  384. $this->import_fields_array[$r][$fieldname] = $fieldlabel.($obj->fieldrequired ? '*' : '');
  385. }
  386. }
  387. // End add extra fields
  388. $this->import_fieldshidden_array[$r] = ['extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'bom_bomline'];
  389. $this->import_regex_array[$r] = array();
  390. $this->import_updatekeys_array[$r] = ['bd.fk_bom' => 'BOM Id'];
  391. $this->import_convertvalue_array[$r] = [
  392. 'bd.fk_bom' => [
  393. 'rule' => 'fetchidfromref',
  394. 'file' => '/bom/class/bom.class.php',
  395. 'class' => 'BOM',
  396. 'method' => 'fetch',
  397. 'element' => 'bom'
  398. ],
  399. 'bd.fk_product' => [
  400. 'rule' => 'fetchidfromref',
  401. 'file' => '/product/class/product.class.php',
  402. 'class' => 'Product',
  403. 'method' => 'fetch',
  404. 'element' => 'Product'
  405. ],
  406. ];
  407. }
  408. /**
  409. * Function called when module is enabled.
  410. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
  411. * It also creates data directories
  412. *
  413. * @param string $options Options when enabling module ('', 'noboxes')
  414. * @return int 1 if OK, 0 if KO
  415. */
  416. public function init($options = '')
  417. {
  418. global $conf, $langs;
  419. $result = $this->_load_tables('/bom/sql/');
  420. if ($result < 0) {
  421. 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')
  422. }
  423. // Create extrafields
  424. //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
  425. //$extrafields = new ExtraFields($this->db);
  426. //$result1=$extrafields->addExtraField('myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'mrp', '$conf->bom->enabled');
  427. //$result2=$extrafields->addExtraField('myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'mrp', '$conf->bom->enabled');
  428. //$result3=$extrafields->addExtraField('myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'mrp', '$conf->bom->enabled');
  429. //$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');
  430. //$result5=$extrafields->addExtraField('myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'mrp', '$conf->bom->enabled');
  431. // Permissions
  432. $this->remove($options);
  433. $sql = array();
  434. // ODT template
  435. $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/boms/template_bom.odt';
  436. $dirodt = DOL_DATA_ROOT.'/doctemplates/boms';
  437. $dest = $dirodt.'/template_bom.odt';
  438. if (file_exists($src) && !file_exists($dest)) {
  439. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  440. dol_mkdir($dirodt);
  441. $result = dol_copy($src, $dest, 0, 0);
  442. if ($result < 0) {
  443. $langs->load("errors");
  444. $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
  445. return 0;
  446. }
  447. }
  448. $sql = array(
  449. //"DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape('standard')."' AND type = 'bom' AND entity = ".$conf->entity,
  450. //"INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape('standard')."', 'bom', ".$conf->entity.")"
  451. );
  452. return $this->_init($sql, $options);
  453. }
  454. /**
  455. * Function called when module is disabled.
  456. * Remove from database constants, boxes and permissions from Dolibarr database.
  457. * Data directories are not deleted
  458. *
  459. * @param string $options Options when enabling module ('', 'noboxes')
  460. * @return int 1 if OK, 0 if KO
  461. */
  462. public function remove($options = '')
  463. {
  464. $sql = array();
  465. return $this->_remove($sql, $options);
  466. }
  467. }