dolibarr  13.0.2
modMyModule.class.php
1 <?php
2 /* Copyright (C) 2004-2018 Laurent Destailleur <eldy@users.sourceforge.net>
3  * Copyright (C) 2018-2019 Nicolas ZABOURI <info@inovea-conseil.com>
4  * Copyright (C) 2019-2020 Frédéric France <frederic.france@netlogic.fr>
5  * Copyright (C) ---Put here your own copyright and developer email---
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 
29 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
30 
35 {
41  public function __construct($db)
42  {
43  global $langs, $conf;
44  $this->db = $db;
45 
46  // Id for module (must be unique).
47  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
48  $this->numero = 500000; // TODO Go on page https://wiki.dolibarr.org/index.php/List_of_modules_id to reserve an id number for your module
49 
50  // Key text used to identify module (for permissions, menus, etc...)
51  $this->rights_class = 'mymodule';
52 
53  // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
54  // It is used to group modules by family in module setup page
55  $this->family = "other";
56 
57  // Module position in the family on 2 digits ('01', '10', '20', ...)
58  $this->module_position = '90';
59 
60  // 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)
61  //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
62  // Module label (no space allowed), used if translation string 'ModuleMyModuleName' not found (MyModule is name of module).
63  $this->name = preg_replace('/^mod/i', '', get_class($this));
64 
65  // Module description, used if translation string 'ModuleMyModuleDesc' not found (MyModule is name of module).
66  $this->description = "MyModuleDescription";
67  // Used only if file README.md and README-LL.md not found.
68  $this->descriptionlong = "MyModuleDescription";
69 
70  // Author
71  $this->editor_name = 'Editor name';
72  $this->editor_url = 'https://www.example.com';
73 
74  // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
75  $this->version = '1.0';
76  // Url to the file with your last numberversion of this module
77  //$this->url_last_version = 'http://www.example.com/versionmodule.txt';
78 
79  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
80  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
81 
82  // Name of image file used for this module.
83  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
84  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
85  // To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
86  $this->picto = 'generic';
87 
88  // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
89  $this->module_parts = array(
90  // Set this to 1 if module has its own trigger directory (core/triggers)
91  'triggers' => 0,
92  // Set this to 1 if module has its own login method file (core/login)
93  'login' => 0,
94  // Set this to 1 if module has its own substitution function file (core/substitutions)
95  'substitutions' => 0,
96  // Set this to 1 if module has its own menus handler directory (core/menus)
97  'menus' => 0,
98  // Set this to 1 if module overwrite template dir (core/tpl)
99  'tpl' => 0,
100  // Set this to 1 if module has its own barcode directory (core/modules/barcode)
101  'barcode' => 0,
102  // Set this to 1 if module has its own models directory (core/modules/xxx)
103  'models' => 0,
104  // Set this to 1 if module has its own printing directory (core/modules/printing)
105  'printing' => 0,
106  // Set this to 1 if module has its own theme directory (theme)
107  'theme' => 0,
108  // Set this to relative path of css file if module has its own css file
109  'css' => array(
110  // '/mymodule/css/mymodule.css.php',
111  ),
112  // Set this to relative path of js file if module must load a js on all pages
113  'js' => array(
114  // '/mymodule/js/mymodule.js.php',
115  ),
116  // 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 to 'all'
117  'hooks' => array(
118  // 'data' => array(
119  // 'hookcontext1',
120  // 'hookcontext2',
121  // ),
122  // 'entity' => '0',
123  ),
124  // Set this to 1 if features of module are opened to external users
125  'moduleforexternal' => 0,
126  );
127 
128  // Data directories to create when module is enabled.
129  // Example: this->dirs = array("/mymodule/temp","/mymodule/subdir");
130  $this->dirs = array("/mymodule/temp");
131 
132  // Config pages. Put here list of php page, stored into mymodule/admin directory, to use to setup module.
133  $this->config_page_url = array("setup.php@mymodule");
134 
135  // Dependencies
136  // A condition to hide module
137  $this->hidden = false;
138  // List of module class names as string that must be enabled if this module is enabled. Example: array('always1'=>'modModuleToEnable1','always2'=>'modModuleToEnable2', 'FR1'=>'modModuleToEnableFR'...)
139  $this->depends = array();
140  $this->requiredby = array(); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
141  $this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
142 
143  // The language file dedicated to your module
144  $this->langfiles = array("mymodule@mymodule");
145 
146  // Prerequisites
147  $this->phpmin = array(5, 5); // Minimum version of PHP required by module
148  $this->need_dolibarr_version = array(11, -3); // Minimum version of Dolibarr required by module
149 
150  // Messages at activation
151  $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
152  $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
153  //$this->automatic_activation = array('FR'=>'MyModuleWasAutomaticallyActivatedBecauseOfYourCountryChoice');
154  //$this->always_enabled = true; // If true, can't be disabled
155 
156  // Constants
157  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
158  // Example: $this->const=array(1 => array('MYMODULE_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
159  // 2 => array('MYMODULE_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
160  // );
161  $this->const = array();
162 
163  // Some keys to add into the overwriting translation tables
164  /*$this->overwrite_translation = array(
165  'en_US:ParentCompany'=>'Parent company or reseller',
166  'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
167  )*/
168 
169  if (!isset($conf->mymodule) || !isset($conf->mymodule->enabled)) {
170  $conf->mymodule = new stdClass();
171  $conf->mymodule->enabled = 0;
172  }
173 
174  // Array to add new pages in new tabs
175  $this->tabs = array();
176  // Example:
177  // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
178  // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@mymodule:$user->rights->othermodule->read:/mymodule/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.
179  // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
180  //
181  // Where objecttype can be
182  // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
183  // 'contact' to add a tab in contact view
184  // 'contract' to add a tab in contract view
185  // 'group' to add a tab in group view
186  // 'intervention' to add a tab in intervention view
187  // 'invoice' to add a tab in customer invoice view
188  // 'invoice_supplier' to add a tab in supplier invoice view
189  // 'member' to add a tab in fundation member view
190  // 'opensurveypoll' to add a tab in opensurvey poll view
191  // 'order' to add a tab in customer order view
192  // 'order_supplier' to add a tab in supplier order view
193  // 'payment' to add a tab in payment view
194  // 'payment_supplier' to add a tab in supplier payment view
195  // 'product' to add a tab in product view
196  // 'propal' to add a tab in propal view
197  // 'project' to add a tab in project view
198  // 'stock' to add a tab in stock view
199  // 'thirdparty' to add a tab in third party view
200  // 'user' to add a tab in user view
201 
202  // Dictionaries
203  $this->dictionaries = array();
204  /* Example:
205  $this->dictionaries=array(
206  'langs'=>'mymodule@mymodule',
207  // List of tables we want to see into dictonnary editor
208  'tabname'=>array(MAIN_DB_PREFIX."table1", MAIN_DB_PREFIX."table2", MAIN_DB_PREFIX."table3"),
209  // Label of tables
210  'tablib'=>array("Table1", "Table2", "Table3"),
211  // Request to select fields
212  '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'),
213  // Sort order
214  'tabsqlsort'=>array("label ASC", "label ASC", "label ASC"),
215  // List of fields (result of select to show dictionary)
216  'tabfield'=>array("code,label", "code,label", "code,label"),
217  // List of fields (list of fields to edit a record)
218  'tabfieldvalue'=>array("code,label", "code,label", "code,label"),
219  // List of fields (list of fields for insert)
220  'tabfieldinsert'=>array("code,label", "code,label", "code,label"),
221  // Name of columns with primary key (try to always name it 'rowid')
222  'tabrowid'=>array("rowid", "rowid", "rowid"),
223  // Condition to show each dictionary
224  'tabcond'=>array($conf->mymodule->enabled, $conf->mymodule->enabled, $conf->mymodule->enabled)
225  );
226  */
227 
228  // Boxes/Widgets
229  // Add here list of php file(s) stored in mymodule/core/boxes that contains a class to show a widget.
230  $this->boxes = array(
231  // 0 => array(
232  // 'file' => 'mymodulewidget1.php@mymodule',
233  // 'note' => 'Widget provided by MyModule',
234  // 'enabledbydefaulton' => 'Home',
235  // ),
236  // ...
237  );
238 
239  // Cronjobs (List of cron jobs entries to add when module is enabled)
240  // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
241  $this->cronjobs = array(
242  // 0 => array(
243  // 'label' => 'MyJob label',
244  // 'jobtype' => 'method',
245  // 'class' => '/mymodule/class/myobject.class.php',
246  // 'objectname' => 'MyObject',
247  // 'method' => 'doScheduledJob',
248  // 'parameters' => '',
249  // 'comment' => 'Comment',
250  // 'frequency' => 2,
251  // 'unitfrequency' => 3600,
252  // 'status' => 0,
253  // 'test' => '$conf->mymodule->enabled',
254  // 'priority' => 50,
255  // ),
256  );
257  // Example: $this->cronjobs=array(
258  // 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->mymodule->enabled', 'priority'=>50),
259  // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'$conf->mymodule->enabled', 'priority'=>50)
260  // );
261 
262  // Permissions provided by this module
263  $this->rights = array();
264  $r = 0;
265  // Add here entries to declare new permissions
266  /* BEGIN MODULEBUILDER PERMISSIONS */
267  $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
268  $this->rights[$r][1] = 'Read objects of MyModule'; // Permission label
269  $this->rights[$r][4] = 'myobject'; // In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
270  $this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
271  $r++;
272  $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
273  $this->rights[$r][1] = 'Create/Update objects of MyModule'; // Permission label
274  $this->rights[$r][4] = 'myobject'; // In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
275  $this->rights[$r][5] = 'write'; // In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
276  $r++;
277  $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
278  $this->rights[$r][1] = 'Delete objects of MyModule'; // Permission label
279  $this->rights[$r][4] = 'myobject'; // In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
280  $this->rights[$r][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
281  $r++;
282  /* END MODULEBUILDER PERMISSIONS */
283 
284  // Main menu entries to add
285  $this->menu = array();
286  $r = 0;
287  // Add here entries to declare new menus
288  /* BEGIN MODULEBUILDER TOPMENU */
289  $this->menu[$r++] = array(
290  '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
291  'type'=>'top', // This is a Top menu entry
292  'titre'=>'ModuleMyModuleName',
293  'mainmenu'=>'mymodule',
294  'leftmenu'=>'',
295  'url'=>'/mymodule/mymoduleindex.php',
296  'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
297  'position'=>1000 + $r,
298  'enabled'=>'$conf->mymodule->enabled', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
299  'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->myobject->read' if you want your menu with a permission rules
300  'target'=>'',
301  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
302  );
303  /* END MODULEBUILDER TOPMENU */
304  /* BEGIN MODULEBUILDER LEFTMENU MYOBJECT
305  $this->menu[$r++]=array(
306  'fk_menu'=>'fk_mainmenu=mymodule', // '' 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
307  'type'=>'left', // This is a Top menu entry
308  'titre'=>'MyObject',
309  'mainmenu'=>'mymodule',
310  'leftmenu'=>'myobject',
311  'url'=>'/mymodule/mymoduleindex.php',
312  'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
313  'position'=>1000+$r,
314  'enabled'=>'$conf->mymodule->enabled', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
315  'perms'=>'$user->rights->mymodule->myobject->read', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
316  'target'=>'',
317  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
318  );
319  $this->menu[$r++]=array(
320  'fk_menu'=>'fk_mainmenu=mymodule,fk_leftmenu=myobject', // '' 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
321  'type'=>'left', // This is a Left menu entry
322  'titre'=>'List_MyObject',
323  'mainmenu'=>'mymodule',
324  'leftmenu'=>'mymodule_myobject_list',
325  'url'=>'/mymodule/myobject_list.php',
326  'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
327  'position'=>1000+$r,
328  'enabled'=>'$conf->mymodule->enabled', // 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.
329  'perms'=>'$user->rights->mymodule->myobject->read', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
330  'target'=>'',
331  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
332  );
333  $this->menu[$r++]=array(
334  'fk_menu'=>'fk_mainmenu=mymodule,fk_leftmenu=myobject', // '' 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
335  'type'=>'left', // This is a Left menu entry
336  'titre'=>'New_MyObject',
337  'mainmenu'=>'mymodule',
338  'leftmenu'=>'mymodule_myobject_new',
339  'url'=>'/mymodule/myobject_card.php?action=create',
340  'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
341  'position'=>1000+$r,
342  'enabled'=>'$conf->mymodule->enabled', // 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.
343  'perms'=>'$user->rights->mymodule->myobject->write', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
344  'target'=>'',
345  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
346  );
347  END MODULEBUILDER LEFTMENU MYOBJECT */
348  // Exports profiles provided by this module
349  $r = 1;
350  /* BEGIN MODULEBUILDER EXPORT MYOBJECT */
351  /*
352  $langs->load("mymodule@mymodule");
353  $this->export_code[$r]=$this->rights_class.'_'.$r;
354  $this->export_label[$r]='MyObjectLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
355  $this->export_icon[$r]='myobject@mymodule';
356  // Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
357  $keyforclass = 'MyObject'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobject@mymodule';
358  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
359  //$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
360  //unset($this->export_fields_array[$r]['t.fieldtoremove']);
361  //$keyforclass = 'MyObjectLine'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobjectline@mymodule'; $keyforalias='tl';
362  //include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
363  $keyforselect='myobject'; $keyforaliasextra='extra'; $keyforelement='myobject@mymodule';
364  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
365  //$keyforselect='myobjectline'; $keyforaliasextra='extraline'; $keyforelement='myobjectline@mymodule';
366  //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
367  //$this->export_dependencies_array[$r] = array('myobjectline'=>array('tl.rowid','tl.ref')); // 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)
368  //$this->export_special_array[$r] = array('t.field'=>'...');
369  //$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
370  //$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
371  $this->export_sql_start[$r]='SELECT DISTINCT ';
372  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'myobject as t';
373  //$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'myobject_line as tl ON tl.fk_myobject = t.rowid';
374  $this->export_sql_end[$r] .=' WHERE 1 = 1';
375  $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('myobject').')';
376  $r++; */
377  /* END MODULEBUILDER EXPORT MYOBJECT */
378 
379  // Imports profiles provided by this module
380  $r = 1;
381  /* BEGIN MODULEBUILDER IMPORT MYOBJECT */
382  /*
383  $langs->load("mymodule@mymodule");
384  $this->export_code[$r]=$this->rights_class.'_'.$r;
385  $this->export_label[$r]='MyObjectLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
386  $this->export_icon[$r]='myobject@mymodule';
387  $keyforclass = 'MyObject'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobject@mymodule';
388  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
389  $keyforselect='myobject'; $keyforaliasextra='extra'; $keyforelement='myobject@mymodule';
390  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
391  //$this->export_dependencies_array[$r]=array('mysubobject'=>'ts.rowid', 't.myfield'=>array('t.myfield2','t.myfield3')); // 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)
392  $this->export_sql_start[$r]='SELECT DISTINCT ';
393  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'myobject as t';
394  $this->export_sql_end[$r] .=' WHERE 1 = 1';
395  $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('myobject').')';
396  $r++; */
397  /* END MODULEBUILDER IMPORT MYOBJECT */
398  }
399 
408  public function init($options = '')
409  {
410  global $conf, $langs;
411 
412  $result = $this->_load_tables('/mymodule/sql/');
413  if ($result < 0) return -1; // Do not activate module if error 'not allowed' returned when loading module SQL queries (the _load_table run sql with run_sql with the error allowed parameter set to 'default')
414 
415  // Create extrafields during init
416  //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
417  //$extrafields = new ExtraFields($this->db);
418  //$result1=$extrafields->addExtraField('mymodule_myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', '$conf->mymodule->enabled');
419  //$result2=$extrafields->addExtraField('mymodule_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', '$conf->mymodule->enabled');
420  //$result3=$extrafields->addExtraField('mymodule_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', '$conf->mymodule->enabled');
421  //$result4=$extrafields->addExtraField('mymodule_myattr4', "New Attr 4 label", 'select', 1, 3, 'thirdparty', 0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1,'', 0, 0, '', '', 'mymodule@mymodule', '$conf->mymodule->enabled');
422  //$result5=$extrafields->addExtraField('mymodule_myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', '$conf->mymodule->enabled');
423 
424  // Permissions
425  $this->remove($options);
426 
427  $sql = array();
428 
429  // Document templates
430  $moduledir = 'mymodule';
431  $myTmpObjects = array();
432  $myTmpObjects['MyObject'] = array('includerefgeneration'=>0, 'includedocgeneration'=>0);
433 
434  foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
435  if ($myTmpObjectKey == 'MyObject') continue;
436  if ($myTmpObjectArray['includerefgeneration']) {
437  $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/mymodule/template_myobjects.odt';
438  $dirodt = DOL_DATA_ROOT.'/doctemplates/mymodule';
439  $dest = $dirodt.'/template_myobjects.odt';
440 
441  if (file_exists($src) && !file_exists($dest))
442  {
443  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
444  dol_mkdir($dirodt);
445  $result = dol_copy($src, $dest, 0, 0);
446  if ($result < 0)
447  {
448  $langs->load("errors");
449  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
450  return 0;
451  }
452  }
453 
454  $sql = array_merge($sql, array(
455  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey)."' AND type = '".strtolower($myTmpObjectKey)."' AND entity = ".$conf->entity,
456  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey)."','".strtolower($myTmpObjectKey)."',".$conf->entity.")",
457  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'generic_".strtolower($myTmpObjectKey)."_odt' AND type = '".strtolower($myTmpObjectKey)."' AND entity = ".$conf->entity,
458  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey)."_odt', '".strtolower($myTmpObjectKey)."', ".$conf->entity.")"
459  ));
460  }
461  }
462 
463  return $this->_init($sql, $options);
464  }
465 
474  public function remove($options = '')
475  {
476  $sql = array();
477  return $this->_remove($sql, $options);
478  }
479 }
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1)
Copy a file to another file.
Definition: files.lib.php:663
Class DolibarrModules.
__construct($db)
Constructor.
</td > param sortfield sortorder printFieldListOption< tdclass="liste_titremaxwidthsearchright"></td ></tr >< trclass="liste_titre">< inputtype="checkbox"onClick="toggle(this)"/> Ref p ref Label p label Duration p duration center DesiredStock p desiredstock right StockLimitShort p seuil_stock_alerte right stock_physique right stock_real_warehouse right Ordered right StockToBuy right SupplierRef right param sortfield sortorder printFieldListTitle warehouseinternal SELECT description FROM product_lang WHERE qty< br > qty qty qty StockTooLow StockTooLow help help help< trclass="oddeven">< td >< inputtype="checkbox"class="check"name="choose'.$i.'"></td >< tdclass="nowrap"> stock</td >< td >< inputtype="hidden"name="desc'.$i.'"value="'.dol_escape_htmltag($objp-> description
Only used if Module[ID]Desc translation string is not found.
Definition: replenish.php:750
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:108
$conf db
API class for accounts.
Definition: inc.php:54
_remove($array_sql, $options= '')
Disable function.
init($options= '')
Function called when module is enabled.
_init($array_sql, $options= '')
Enables a module.
Description and activation class for module MyModule.
dol_mkdir($dir, $dataroot= '', $newmask=null)
Creation of a directory (this can create recursive subdir)
_load_tables($reldir)
Create tables and keys required by module.