dolibarr  19.0.0-dev
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', 'experimental_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 that must be enabled if this module is enabled. Example: array('always'=>array('modModuleToEnable1','modModuleToEnable2'), 'FR'=>array('modModuleToEnableFR')...)
139  $this->depends = array();
140  // List of module class names to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
141  $this->requiredby = array();
142  // List of module class names this module is in conflict with. Example: array('modModuleToDisable1', ...)
143  $this->conflictwith = array();
144 
145  // The language file dedicated to your module
146  $this->langfiles = array("mymodule@mymodule");
147 
148  // Prerequisites
149  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
150  $this->need_dolibarr_version = array(11, -3); // Minimum version of Dolibarr required by module
151  $this->need_javascript_ajax = 0;
152 
153  // Messages at activation
154  $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
155  $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
156  //$this->automatic_activation = array('FR'=>'MyModuleWasAutomaticallyActivatedBecauseOfYourCountryChoice');
157  //$this->always_enabled = true; // If true, can't be disabled
158 
159  // Constants
160  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
161  // Example: $this->const=array(1 => array('MYMODULE_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
162  // 2 => array('MYMODULE_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
163  // );
164  $this->const = array();
165 
166  // Some keys to add into the overwriting translation tables
167  /*$this->overwrite_translation = array(
168  'en_US:ParentCompany'=>'Parent company or reseller',
169  'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
170  )*/
171 
172  if (!isset($conf->mymodule) || !isset($conf->mymodule->enabled)) {
173  $conf->mymodule = new stdClass();
174  $conf->mymodule->enabled = 0;
175  }
176 
177  // Array to add new pages in new tabs
178  $this->tabs = array();
179  // Example:
180  // $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
181  // $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.
182  // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
183  //
184  // Where objecttype can be
185  // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
186  // 'contact' to add a tab in contact view
187  // 'contract' to add a tab in contract view
188  // 'group' to add a tab in group view
189  // 'intervention' to add a tab in intervention view
190  // 'invoice' to add a tab in customer invoice view
191  // 'invoice_supplier' to add a tab in supplier invoice view
192  // 'member' to add a tab in fundation member view
193  // 'opensurveypoll' to add a tab in opensurvey poll view
194  // 'order' to add a tab in sale order view
195  // 'order_supplier' to add a tab in supplier order view
196  // 'payment' to add a tab in payment view
197  // 'payment_supplier' to add a tab in supplier payment view
198  // 'product' to add a tab in product view
199  // 'propal' to add a tab in propal view
200  // 'project' to add a tab in project view
201  // 'stock' to add a tab in stock view
202  // 'thirdparty' to add a tab in third party view
203  // 'user' to add a tab in user view
204 
205  // Dictionaries
206  $this->dictionaries = array();
207  /* Example:
208  $this->dictionaries=array(
209  'langs'=>'mymodule@mymodule',
210  // List of tables we want to see into dictonnary editor
211  'tabname'=>array("table1", "table2", "table3"),
212  // Label of tables
213  'tablib'=>array("Table1", "Table2", "Table3"),
214  // Request to select fields
215  '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'),
216  // Sort order
217  'tabsqlsort'=>array("label ASC", "label ASC", "label ASC"),
218  // List of fields (result of select to show dictionary)
219  'tabfield'=>array("code,label", "code,label", "code,label"),
220  // List of fields (list of fields to edit a record)
221  'tabfieldvalue'=>array("code,label", "code,label", "code,label"),
222  // List of fields (list of fields for insert)
223  'tabfieldinsert'=>array("code,label", "code,label", "code,label"),
224  // Name of columns with primary key (try to always name it 'rowid')
225  'tabrowid'=>array("rowid", "rowid", "rowid"),
226  // Condition to show each dictionary
227  'tabcond'=>array(isModEnabled('mymodule'), isModEnabled('mymodule'), isModEnabled('mymodule')),
228  // Tooltip for every fields of dictionaries: DO NOT PUT AN EMPTY ARRAY
229  'tabhelp'=>array(array('code'=>$langs->trans('CodeTooltipHelp'), 'field2' => 'field2tooltip'), array('code'=>$langs->trans('CodeTooltipHelp'), 'field2' => 'field2tooltip'), ...),
230  );
231  */
232 
233  // Boxes/Widgets
234  // Add here list of php file(s) stored in mymodule/core/boxes that contains a class to show a widget.
235  $this->boxes = array(
236  // 0 => array(
237  // 'file' => 'mymodulewidget1.php@mymodule',
238  // 'note' => 'Widget provided by MyModule',
239  // 'enabledbydefaulton' => 'Home',
240  // ),
241  // ...
242  );
243 
244  // Cronjobs (List of cron jobs entries to add when module is enabled)
245  // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
246  $this->cronjobs = array(
247  // 0 => array(
248  // 'label' => 'MyJob label',
249  // 'jobtype' => 'method',
250  // 'class' => '/mymodule/class/myobject.class.php',
251  // 'objectname' => 'MyObject',
252  // 'method' => 'doScheduledJob',
253  // 'parameters' => '',
254  // 'comment' => 'Comment',
255  // 'frequency' => 2,
256  // 'unitfrequency' => 3600,
257  // 'status' => 0,
258  // 'test' => 'isModEnabled("mymodule")',
259  // 'priority' => 50,
260  // ),
261  );
262  // Example: $this->cronjobs=array(
263  // 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'=>'isModEnabled("mymodule")', 'priority'=>50),
264  // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'isModEnabled("mymodule")', 'priority'=>50)
265  // );
266 
267  // Permissions provided by this module
268  $this->rights = array();
269  $r = 0;
270  // Add here entries to declare new permissions
271  /* BEGIN MODULEBUILDER PERMISSIONS */
272  /*
273  $o = 1;
274  $this->rights[$r][0] = $this->numero . sprintf("%02d", ($o * 10) + 1); // Permission id (must not be already used)
275  $this->rights[$r][1] = 'Read objects of MyModule'; // Permission label
276  $this->rights[$r][4] = 'myobject';
277  $this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->hasRight('mymodule', 'myobject', 'read'))
278  $r++;
279  $this->rights[$r][0] = $this->numero . sprintf("%02d", ($o * 10) + 2); // Permission id (must not be already used)
280  $this->rights[$r][1] = 'Create/Update objects of MyModule'; // Permission label
281  $this->rights[$r][4] = 'myobject';
282  $this->rights[$r][5] = 'write'; // In php code, permission will be checked by test if ($user->hasRight('mymodule', 'myobject', 'write'))
283  $r++;
284  $this->rights[$r][0] = $this->numero . sprintf("%02d", ($o * 10) + 3); // Permission id (must not be already used)
285  $this->rights[$r][1] = 'Delete objects of MyModule'; // Permission label
286  $this->rights[$r][4] = 'myobject';
287  $this->rights[$r][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->mymodule->myobject->delete)
288  $r++;
289  */
290  /* END MODULEBUILDER PERMISSIONS */
291 
292  // Main menu entries to add
293  $this->menu = array();
294  $r = 0;
295  // Add here entries to declare new menus
296  /* BEGIN MODULEBUILDER TOPMENU */
297  $this->menu[$r++] = array(
298  '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
299  'type'=>'top', // This is a Top menu entry
300  'titre'=>'ModuleMyModuleName',
301  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
302  'mainmenu'=>'mymodule',
303  'leftmenu'=>'',
304  'url'=>'/mymodule/mymoduleindex.php',
305  'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
306  'position'=>1000 + $r,
307  'enabled'=>'isModEnabled("mymodule")', // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
308  'perms'=>'1', // Use 'perms'=>'$user->hasRight("mymodule", "myobject", "read")' if you want your menu with a permission rules
309  'target'=>'',
310  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
311  );
312  /* END MODULEBUILDER TOPMENU */
313  /* BEGIN MODULEBUILDER LEFTMENU MYOBJECT */
314  /*$this->menu[$r++]=array(
315  '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
316  'type'=>'left', // This is a Left menu entry
317  'titre'=>'MyObject',
318  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
319  'mainmenu'=>'mymodule',
320  'leftmenu'=>'myobject',
321  'url'=>'/mymodule/mymoduleindex.php',
322  'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
323  'position'=>1000+$r,
324  'enabled'=>'isModEnabled("mymodule")', // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
325  'perms'=>'$user->hasRight("mymodule", "myobject", "read")',
326  'target'=>'',
327  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
328  );
329  $this->menu[$r++]=array(
330  '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
331  'type'=>'left', // This is a Left menu entry
332  'titre'=>'List_MyObject',
333  'mainmenu'=>'mymodule',
334  'leftmenu'=>'mymodule_myobject_list',
335  'url'=>'/mymodule/myobject_list.php',
336  'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
337  'position'=>1000+$r,
338  'enabled'=>'isModEnabled("mymodule")', // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
339  'perms'=>'$user->hasRight("mymodule", "myobject", "read")'
340  'target'=>'',
341  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
342  );
343  $this->menu[$r++]=array(
344  '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
345  'type'=>'left', // This is a Left menu entry
346  'titre'=>'New_MyObject',
347  'mainmenu'=>'mymodule',
348  'leftmenu'=>'mymodule_myobject_new',
349  'url'=>'/mymodule/myobject_card.php?action=create',
350  'langs'=>'mymodule@mymodule', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
351  'position'=>1000+$r,
352  'enabled'=>'isModEnabled("mymodule")', // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
353  'perms'=>'$user->hasRight("mymodule", "myobject", "write")'
354  'target'=>'',
355  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
356  );*/
357  /* END MODULEBUILDER LEFTMENU MYOBJECT */
358  // Exports profiles provided by this module
359  $r = 1;
360  /* BEGIN MODULEBUILDER EXPORT MYOBJECT */
361  /*
362  $langs->load("mymodule@mymodule");
363  $this->export_code[$r]=$this->rights_class.'_'.$r;
364  $this->export_label[$r]='MyObjectLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
365  $this->export_icon[$r]='myobject@mymodule';
366  // Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
367  $keyforclass = 'MyObject'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobject@mymodule';
368  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
369  //$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
370  //unset($this->export_fields_array[$r]['t.fieldtoremove']);
371  //$keyforclass = 'MyObjectLine'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobjectline@mymodule'; $keyforalias='tl';
372  //include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
373  $keyforselect='myobject'; $keyforaliasextra='extra'; $keyforelement='myobject@mymodule';
374  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
375  //$keyforselect='myobjectline'; $keyforaliasextra='extraline'; $keyforelement='myobjectline@mymodule';
376  //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
377  //$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)
378  //$this->export_special_array[$r] = array('t.field'=>'...');
379  //$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
380  //$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
381  $this->export_sql_start[$r]='SELECT DISTINCT ';
382  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'myobject as t';
383  //$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'myobject_line as tl ON tl.fk_myobject = t.rowid';
384  $this->export_sql_end[$r] .=' WHERE 1 = 1';
385  $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('myobject').')';
386  $r++; */
387  /* END MODULEBUILDER EXPORT MYOBJECT */
388 
389  // Imports profiles provided by this module
390  $r = 1;
391  /* BEGIN MODULEBUILDER IMPORT MYOBJECT */
392  /*
393  $langs->load("mymodule@mymodule");
394  $this->import_code[$r]=$this->rights_class.'_'.$r;
395  $this->import_label[$r]='MyObjectLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
396  $this->import_icon[$r]='myobject@mymodule';
397  $this->import_tables_array[$r] = array('t' => MAIN_DB_PREFIX.'mymodule_myobject', 'extra' => MAIN_DB_PREFIX.'mymodule_myobject_extrafields');
398  $this->import_tables_creator_array[$r] = array('t' => 'fk_user_author'); // Fields to store import user id
399  $import_sample = array();
400  $keyforclass = 'MyObject'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobject@mymodule';
401  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinimport.inc.php';
402  $import_extrafield_sample = array();
403  $keyforselect='myobject'; $keyforaliasextra='extra'; $keyforelement='myobject@mymodule';
404  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinimport.inc.php';
405  $this->import_fieldshidden_array[$r] = array('extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'mymodule_myobject');
406  $this->import_regex_array[$r] = array();
407  $this->import_examplevalues_array[$r] = array_merge($import_sample, $import_extrafield_sample);
408  $this->import_updatekeys_array[$r] = array('t.ref' => 'Ref');
409  $this->import_convertvalue_array[$r] = array(
410  't.ref' => array(
411  'rule'=>'getrefifauto',
412  'class'=>(empty(getDolGlobalString('MYMODULE_MYOBJECT_ADDON')) ? 'mod_myobject_standard' : getDolGlobalString('MYMODULE_MYOBJECT_ADDON')),
413  'path'=>"/core/modules/commande/".(empty(getDolGlobalString('MYMODULE_MYOBJECT_ADDON')) ? 'mod_myobject_standard' : getDolGlobalString('MYMODULE_MYOBJECT_ADDON')).'.php'
414  'classobject'=>'MyObject',
415  'pathobject'=>'/mymodule/class/myobject.class.php',
416  ),
417  't.fk_soc' => array('rule' => 'fetchidfromref', 'file' => '/societe/class/societe.class.php', 'class' => 'Societe', 'method' => 'fetch', 'element' => 'ThirdParty'),
418  't.fk_user_valid' => array('rule' => 'fetchidfromref', 'file' => '/user/class/user.class.php', 'class' => 'User', 'method' => 'fetch', 'element' => 'user'),
419  't.fk_mode_reglement' => array('rule' => 'fetchidfromcodeorlabel', 'file' => '/compta/paiement/class/cpaiement.class.php', 'class' => 'Cpaiement', 'method' => 'fetch', 'element' => 'cpayment'),
420  );
421  $this->import_run_sql_after_array[$r] = array();
422  $r++; */
423  /* END MODULEBUILDER IMPORT MYOBJECT */
424  }
425 
434  public function init($options = '')
435  {
436  global $conf, $langs;
437 
438  //$result = $this->_load_tables('/install/mysql/', 'mymodule');
439  $result = $this->_load_tables('/mymodule/sql/');
440  if ($result < 0) {
441  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')
442  }
443 
444  // Create extrafields during init
445  //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
446  //$extrafields = new ExtraFields($this->db);
447  //$result1=$extrafields->addExtraField('mymodule_myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
448  //$result2=$extrafields->addExtraField('mymodule_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
449  //$result3=$extrafields->addExtraField('mymodule_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
450  //$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', 'isModEnabled("mymodule")');
451  //$result5=$extrafields->addExtraField('mymodule_myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
452 
453  // Permissions
454  $this->remove($options);
455 
456  $sql = array();
457 
458  // Document templates
459  $moduledir = dol_sanitizeFileName('mymodule');
460  $myTmpObjects = array();
461  $myTmpObjects['MyObject'] = array('includerefgeneration'=>0, 'includedocgeneration'=>0);
462 
463  foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
464  if ($myTmpObjectKey == 'MyObject') {
465  continue;
466  }
467  if ($myTmpObjectArray['includerefgeneration']) {
468  $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/'.$moduledir.'/template_myobjects.odt';
469  $dirodt = DOL_DATA_ROOT.'/doctemplates/'.$moduledir;
470  $dest = $dirodt.'/template_myobjects.odt';
471 
472  if (file_exists($src) && !file_exists($dest)) {
473  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
474  dol_mkdir($dirodt);
475  $result = dol_copy($src, $dest, 0, 0);
476  if ($result < 0) {
477  $langs->load("errors");
478  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
479  return 0;
480  }
481  }
482 
483  $sql = array_merge($sql, array(
484  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey)."' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
485  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey)."', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")",
486  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'generic_".strtolower($myTmpObjectKey)."_odt' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
487  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey)."_odt', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")"
488  ));
489  }
490  }
491 
492  return $this->_init($sql, $options);
493  }
494 
503  public function remove($options = '')
504  {
505  $sql = array();
506  return $this->_remove($sql, $options);
507  }
508 }
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
_remove($array_sql, $options='')
Disable function.
_load_tables($reldir, $onlywithsuffix='')
Create tables and keys required by module:
Description and activation class for module MyModule.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
if(isModEnabled('facture') && $user->hasRight('facture', 'lire')) if((isModEnabled('fournisseur') &&empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD) && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') && $user->hasRight('don', 'lire')) if(isModEnabled('tax') &&!empty($user->rights->tax->charges->lire)) if(isModEnabled('facture') &&isModEnabled('commande') && $user->hasRight("commande", "lire") &&empty($conf->global->WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER)) $sql
Social contributions to pay.
Definition: index.php:746
print *****$script_file(".$version.") pid cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1, $testvirus=0, $indexdatabase=0)
Copy a file to another file.
Definition: files.lib.php:717
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:123