dolibarr  19.0.0-dev
modBookCal.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-2022 Frédéric France <frederic.france@netlogic.fr>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <https://www.gnu.org/licenses/>.
18  */
19 
28 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
29 
34 {
40  public function __construct($db)
41  {
42  global $langs, $conf;
43 
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 = 2430;
49 
50  // Key text used to identify module (for permissions, menus, etc...)
51  $this->rights_class = 'bookcal';
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 = "projects";
56 
57  // Module position in the family on 2 digits ('01', '10', '20', ...)
58  $this->module_position = '50';
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 'ModuleBookCalName' not found (BookCal is name of module).
63  $this->name = preg_replace('/^mod/i', '', get_class($this));
64 
65  // Module description, used if translation string 'ModuleBookCalDesc' not found (BookCal is name of module).
66  $this->description = "BookCalDescription";
67  // Used only if file README.md and README-LL.md not found.
68  $this->descriptionlong = "BookCalDescription";
69 
70  // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
71  $this->version = 'development';
72 
73  // Key used in llx_const table to save module status enabled/disabled (where BOOKCAL is value of property name of module in uppercase)
74  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
75 
76  // Name of image file used for this module.
77  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
78  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
79  // To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
80  $this->picto = 'fa-calendar-check';
81 
82  // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
83  $this->module_parts = array(
84  // Set this to 1 if module has its own trigger directory (core/triggers)
85  'triggers' => 0,
86  // Set this to 1 if module has its own login method file (core/login)
87  'login' => 0,
88  // Set this to 1 if module has its own substitution function file (core/substitutions)
89  'substitutions' => 0,
90  // Set this to 1 if module has its own menus handler directory (core/menus)
91  'menus' => 0,
92  // Set this to 1 if module overwrite template dir (core/tpl)
93  'tpl' => 0,
94  // Set this to 1 if module has its own barcode directory (core/modules/barcode)
95  'barcode' => 0,
96  // Set this to 1 if module has its own models directory (core/modules/xxx)
97  'models' => 0,
98  // Set this to 1 if module has its own printing directory (core/modules/printing)
99  'printing' => 0,
100  // Set this to 1 if module has its own theme directory (theme)
101  'theme' => 0,
102  // Set this to relative path of css file if module has its own css file
103  'css' => array(
104  // '/bookcal/css/bookcal.css.php',
105  ),
106  // Set this to relative path of js file if module must load a js on all pages
107  'js' => array(
108  // '/bookcal/js/bookcal.js.php',
109  ),
110  // 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'
111  'hooks' => array(
112  // 'data' => array(
113  // 'hookcontext1',
114  // 'hookcontext2',
115  // ),
116  // 'entity' => '0',
117  ),
118  // Set this to 1 if features of module are opened to external users
119  'moduleforexternal' => 0,
120  );
121 
122  // Data directories to create when module is enabled.
123  // Example: this->dirs = array("/bookcal/temp","/bookcal/subdir");
124  $this->dirs = array("/bookcal/temp");
125 
126  // Config pages. Put here list of php page, stored into bookcal/admin directory, to use to setup module.
127  $this->config_page_url = array("setup.php@bookcal");
128 
129  // Dependencies
130  // A condition to hide module
131  $this->hidden = false;
132  // List of module class names as string that must be enabled if this module is enabled. Example: array('always'=>array('modModuleToEnable1','modModuleToEnable2'), 'FR'=>array('modModuleToEnableFR'...))
133  $this->depends = array();
134  $this->requiredby = array(); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
135  $this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
136 
137  // The language file dedicated to your module
138  $this->langfiles = array("bookcal@bookcal");
139 
140  // Prerequisites
141  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
142 
143  // Messages at activation
144  $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
145  $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
146  //$this->automatic_activation = array('FR'=>'BookCalWasAutomaticallyActivatedBecauseOfYourCountryChoice');
147  //$this->always_enabled = true; // If true, can't be disabled
148 
149  // Constants
150  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
151  // Example: $this->const=array(1 => array('BOOKCAL_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
152  // 2 => array('BOOKCAL_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
153  // );
154  $this->const = array();
155 
156  // Some keys to add into the overwriting translation tables
157  /*$this->overwrite_translation = array(
158  'en_US:ParentCompany'=>'Parent company or reseller',
159  'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
160  )*/
161 
162  if (!isset($conf->bookcal) || !isset($conf->bookcal->enabled)) {
163  $conf->bookcal = new stdClass();
164  $conf->bookcal->enabled = 0;
165  }
166 
167  // Array to add new pages in new tabs
168  $this->tabs = array();
169  // Example:
170  // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@bookcal:$user->rights->bookcal->read:/bookcal/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
171  // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@bookcal:$user->rights->othermodule->read:/bookcal/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.
172  // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
173  //
174  // Where objecttype can be
175  // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
176  // 'contact' to add a tab in contact view
177  // 'contract' to add a tab in contract view
178  // 'group' to add a tab in group view
179  // 'intervention' to add a tab in intervention view
180  // 'invoice' to add a tab in customer invoice view
181  // 'invoice_supplier' to add a tab in supplier invoice view
182  // 'member' to add a tab in fundation member view
183  // 'opensurveypoll' to add a tab in opensurvey poll view
184  // 'order' to add a tab in customer order view
185  // 'order_supplier' to add a tab in supplier order view
186  // 'payment' to add a tab in payment view
187  // 'payment_supplier' to add a tab in supplier payment view
188  // 'product' to add a tab in product view
189  // 'propal' to add a tab in propal view
190  // 'project' to add a tab in project view
191  // 'stock' to add a tab in stock view
192  // 'thirdparty' to add a tab in third party view
193  // 'user' to add a tab in user view
194 
195  // Dictionaries
196  $this->dictionaries = array();
197  /* Example:
198  $this->dictionaries=array(
199  'langs'=>'bookcal@bookcal',
200  // List of tables we want to see into dictonnary editor
201  'tabname'=>array("table1", "table2", "table3"),
202  // Label of tables
203  'tablib'=>array("Table1", "Table2", "Table3"),
204  // Request to select fields
205  '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'),
206  // Sort order
207  'tabsqlsort'=>array("label ASC", "label ASC", "label ASC"),
208  // List of fields (result of select to show dictionary)
209  'tabfield'=>array("code,label", "code,label", "code,label"),
210  // List of fields (list of fields to edit a record)
211  'tabfieldvalue'=>array("code,label", "code,label", "code,label"),
212  // List of fields (list of fields for insert)
213  'tabfieldinsert'=>array("code,label", "code,label", "code,label"),
214  // Name of columns with primary key (try to always name it 'rowid')
215  'tabrowid'=>array("rowid", "rowid", "rowid"),
216  // Condition to show each dictionary
217  'tabcond'=>array($conf->bookcal->enabled, $conf->bookcal->enabled, $conf->bookcal->enabled)
218  // Help tooltip for each fields of the dictionary
219  'tabhelp'=>array(array('code'=>$langs->trans('CodeTooltipHelp')))
220  );
221  */
222 
223  // Boxes/Widgets
224  // Add here list of php file(s) stored in bookcal/core/boxes that contains a class to show a widget.
225  $this->boxes = array(
226  // 0 => array(
227  // 'file' => 'bookcalwidget1.php@bookcal',
228  // 'note' => 'Widget provided by BookCal',
229  // 'enabledbydefaulton' => 'Home',
230  // ),
231  // ...
232  );
233 
234  // Cronjobs (List of cron jobs entries to add when module is enabled)
235  // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
236  $this->cronjobs = array(
237  // 0 => array(
238  // 'label' => 'MyJob label',
239  // 'jobtype' => 'method',
240  // 'class' => '/bookcal/class/availabilities.class.php',
241  // 'objectname' => 'Availabilities',
242  // 'method' => 'doScheduledJob',
243  // 'parameters' => '',
244  // 'comment' => 'Comment',
245  // 'frequency' => 2,
246  // 'unitfrequency' => 3600,
247  // 'status' => 0,
248  // 'test' => '$conf->bookcal->enabled',
249  // 'priority' => 50,
250  // ),
251  );
252  // Example: $this->cronjobs=array(
253  // 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->bookcal->enabled', 'priority'=>50),
254  // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'$conf->bookcal->enabled', 'priority'=>50)
255  // );
256 
257  // Permissions provided by this module
258  $this->rights = array();
259  $r = 0;
260  // Add here entries to declare new permissions
261  /* BEGIN MODULEBUILDER PERMISSIONS */
262  $this->rights[$r][0] = $this->numero . sprintf('%02d', (0 * 10) + 1);
263  $this->rights[$r][1] = 'Read objects of BookCal';
264  $this->rights[$r][4] = 'availabilities';
265  $this->rights[$r][5] = 'read';
266  $r++;
267  $this->rights[$r][0] = $this->numero . sprintf('%02d', (0 * 10) + 2);
268  $this->rights[$r][1] = 'Create/Update objects of BookCal';
269  $this->rights[$r][4] = 'availabilities';
270  $this->rights[$r][5] = 'write';
271  $r++;
272  $this->rights[$r][0] = $this->numero . sprintf('%02d', (0 * 10) + 3);
273  $this->rights[$r][1] = 'Delete objects of BookCal';
274  $this->rights[$r][4] = 'availabilities';
275  $this->rights[$r][5] = 'delete';
276  $r++;
277  $this->rights[$r][0] = $this->numero . sprintf('%02d', (1 * 10) + 1);
278  $this->rights[$r][1] = 'Read Calendar object of BookCal';
279  $this->rights[$r][4] = 'calendar';
280  $this->rights[$r][5] = 'read';
281  $r++;
282  $this->rights[$r][0] = $this->numero . sprintf('%02d', (1 * 10) + 2);
283  $this->rights[$r][1] = 'Create/Update Calendar object of BookCal';
284  $this->rights[$r][4] = 'calendar';
285  $this->rights[$r][5] = 'write';
286  $r++;
287  $this->rights[$r][0] = $this->numero . sprintf('%02d', (1 * 10) + 3);
288  $this->rights[$r][1] = 'Delete Calendar object of BookCal';
289  $this->rights[$r][4] = 'calendar';
290  $this->rights[$r][5] = 'delete';
291  $r++;
292 
293  /* END MODULEBUILDER PERMISSIONS */
294 
295  // Main menu entries to add
296  $this->menu = array();
297  $r = 0;
298  // Add here entries to declare new menus
299  /* BEGIN MODULEBUILDER TOPMENU */
300  $this->menu[$r++] = array(
301  '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
302  'type'=>'top', // This is a Top menu entry
303  'titre'=>'ModuleBookCalName',
304  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
305  'mainmenu'=>'bookcal',
306  'leftmenu'=>'',
307  'url'=>'/bookcal/bookcalindex.php',
308  'langs'=>'bookcal@bookcal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
309  'position'=>1000 + $r,
310  'enabled'=>'$conf->bookcal->enabled', // Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled.
311  'perms'=>'1', // Use 'perms'=>'$user->rights->bookcal->availabilities->read' if you want your menu with a permission rules
312  'target'=>'',
313  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
314  );
315  /* END MODULEBUILDER TOPMENU */
316  /* BEGIN MODULEBUILDER LEFTMENU AVAILABILITIES
317  $this->menu[$r++]=array(
318  'fk_menu'=>'fk_mainmenu=bookcal', // '' 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
319  'type'=>'left', // This is a Left menu entry
320  'titre'=>'Availabilities',
321  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
322  'mainmenu'=>'bookcal',
323  'leftmenu'=>'availabilities',
324  'url'=>'/bookcal/bookcalindex.php',
325  'langs'=>'bookcal@bookcal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
326  'position'=>1000+$r,
327  'enabled'=>'$conf->bookcal->enabled', // Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled.
328  'perms'=>'$user->rights->bookcal->availabilities->read', // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
329  'target'=>'',
330  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
331  );
332  $this->menu[$r++]=array(
333  'fk_menu'=>'fk_mainmenu=bookcal,fk_leftmenu=availabilities', // '' 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
334  'type'=>'left', // This is a Left menu entry
335  'titre'=>'List_Availabilities',
336  'mainmenu'=>'bookcal',
337  'leftmenu'=>'bookcal_availabilities_list',
338  'url'=>'/bookcal/availabilities_list.php',
339  'langs'=>'bookcal@bookcal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
340  'position'=>1000+$r,
341  'enabled'=>'$conf->bookcal->enabled', // Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
342  'perms'=>'$user->rights->bookcal->availabilities->read', // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
343  'target'=>'',
344  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
345  );
346  $this->menu[$r++]=array(
347  'fk_menu'=>'fk_mainmenu=bookcal,fk_leftmenu=availabilities', // '' 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
348  'type'=>'left', // This is a Left menu entry
349  'titre'=>'New_Availabilities',
350  'mainmenu'=>'bookcal',
351  'leftmenu'=>'bookcal_availabilities_new',
352  'url'=>'/bookcal/availabilities_card.php?action=create',
353  'langs'=>'bookcal@bookcal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
354  'position'=>1000+$r,
355  'enabled'=>'$conf->bookcal->enabled', // Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
356  'perms'=>'$user->rights->bookcal->availabilities->write', // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
357  'target'=>'',
358  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
359  );
360  */
361 
362  $this->menu[$r++]=array(
363  // '' 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
364  'fk_menu'=>'fk_mainmenu=bookcal',
365  // This is a Left menu entry
366  'type'=>'left',
367  'titre'=>'List Availabilities',
368  'mainmenu'=>'bookcal',
369  'leftmenu'=>'bookcal_availabilities',
370  'url'=>'/bookcal/availabilities_list.php',
371  // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
372  'langs'=>'bookcal@bookcal',
373  'position'=>1100+$r,
374  // Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
375  'enabled'=>'$conf->bookcal->enabled',
376  // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
377  'perms'=>'1',
378  'target'=>'',
379  // 0=Menu for internal users, 1=external users, 2=both
380  'user'=>2,
381  );
382  $this->menu[$r++]=array(
383  // '' 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
384  'fk_menu'=>'fk_mainmenu=bookcal,fk_leftmenu=bookcal_availabilities',
385  // This is a Left menu entry
386  'type'=>'left',
387  'titre'=>'New Availabilities',
388  'mainmenu'=>'bookcal',
389  'leftmenu'=>'bookcal_availabilities',
390  'url'=>'/bookcal/availabilities_card.php?action=create',
391  // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
392  'langs'=>'bookcal@bookcal',
393  'position'=>1100+$r,
394  // Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
395  'enabled'=>'$conf->bookcal->enabled',
396  // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
397  'perms'=>'1',
398  'target'=>'',
399  // 0=Menu for internal users, 1=external users, 2=both
400  'user'=>2
401  );
402 
403  /* END MODULEBUILDER LEFTMENU AVAILABILITIES */
404  // Exports profiles provided by this module
405  $r = 1;
406  /* BEGIN MODULEBUILDER EXPORT AVAILABILITIES */
407  /*
408  $langs->load("bookcal@bookcal");
409  $this->export_code[$r]=$this->rights_class.'_'.$r;
410  $this->export_label[$r]='AvailabilitiesLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
411  $this->export_icon[$r]='availabilities@bookcal';
412  // Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
413  $keyforclass = 'Availabilities'; $keyforclassfile='/bookcal/class/availabilities.class.php'; $keyforelement='availabilities@bookcal';
414  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
415  //$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
416  //unset($this->export_fields_array[$r]['t.fieldtoremove']);
417  //$keyforclass = 'AvailabilitiesLine'; $keyforclassfile='/bookcal/class/availabilities.class.php'; $keyforelement='availabilitiesline@bookcal'; $keyforalias='tl';
418  //include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
419  $keyforselect='availabilities'; $keyforaliasextra='extra'; $keyforelement='availabilities@bookcal';
420  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
421  //$keyforselect='availabilitiesline'; $keyforaliasextra='extraline'; $keyforelement='availabilitiesline@bookcal';
422  //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
423  //$this->export_dependencies_array[$r] = array('availabilitiesline'=>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)
424  //$this->export_special_array[$r] = array('t.field'=>'...');
425  //$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
426  //$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
427  $this->export_sql_start[$r]='SELECT DISTINCT ';
428  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'availabilities as t';
429  //$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'availabilities_line as tl ON tl.fk_availabilities = t.rowid';
430  $this->export_sql_end[$r] .=' WHERE 1 = 1';
431  $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('availabilities').')';
432  $r++; */
433  /* END MODULEBUILDER EXPORT AVAILABILITIES */
434 
435  // Imports profiles provided by this module
436  $r = 1;
437  /* BEGIN MODULEBUILDER IMPORT AVAILABILITIES */
438  /*
439  $langs->load("bookcal@bookcal");
440  $this->import_code[$r]=$this->rights_class.'_'.$r;
441  $this->import_label[$r]='AvailabilitiesLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
442  $this->import_icon[$r]='availabilities@bookcal';
443  $this->import_tables_array[$r] = array('t' => MAIN_DB_PREFIX.'bookcal_availabilities', 'extra' => MAIN_DB_PREFIX.'bookcal_availabilities_extrafields');
444  $this->import_tables_creator_array[$r] = array('t' => 'fk_user_author'); // Fields to store import user id
445  $import_sample = array();
446  $keyforclass = 'Availabilities'; $keyforclassfile='/bookcal/class/availabilities.class.php'; $keyforelement='availabilities@bookcal';
447  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinimport.inc.php';
448  $import_extrafield_sample = array();
449  $keyforselect='availabilities'; $keyforaliasextra='extra'; $keyforelement='availabilities@bookcal';
450  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinimport.inc.php';
451  $this->import_fieldshidden_array[$r] = array('extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'bookcal_availabilities');
452  $this->import_regex_array[$r] = array();
453  $this->import_examplevalues_array[$r] = array_merge($import_sample, $import_extrafield_sample);
454  $this->import_updatekeys_array[$r] = array('t.ref' => 'Ref');
455  $this->import_convertvalue_array[$r] = array(
456  't.ref' => array(
457  'rule'=>'getrefifauto',
458  'class'=>(empty($conf->global->BOOKCAL_AVAILABILITIES_ADDON) ? 'mod_availabilities_standard' : $conf->global->BOOKCAL_AVAILABILITIES_ADDON),
459  'path'=>"/core/modules/commande/".(empty($conf->global->BOOKCAL_AVAILABILITIES_ADDON) ? 'mod_availabilities_standard' : $conf->global->BOOKCAL_AVAILABILITIES_ADDON).'.php'
460  'classobject'=>'Availabilities',
461  'pathobject'=>'/bookcal/class/availabilities.class.php',
462  ),
463  't.fk_soc' => array('rule' => 'fetchidfromref', 'file' => '/societe/class/societe.class.php', 'class' => 'Societe', 'method' => 'fetch', 'element' => 'ThirdParty'),
464  't.fk_user_valid' => array('rule' => 'fetchidfromref', 'file' => '/user/class/user.class.php', 'class' => 'User', 'method' => 'fetch', 'element' => 'user'),
465  't.fk_mode_reglement' => array('rule' => 'fetchidfromcodeorlabel', 'file' => '/compta/paiement/class/cpaiement.class.php', 'class' => 'Cpaiement', 'method' => 'fetch', 'element' => 'cpayment'),
466  );
467  $r++; */
468  /* END MODULEBUILDER IMPORT AVAILABILITIES */
469  }
470 
479  public function init($options = '')
480  {
481  global $conf, $langs;
482 
483  $result = $this->_load_tables('/install/mysql/', 'bookcal');
484  if ($result < 0) {
485  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')
486  }
487 
488  // Create extrafields during init
489  //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
490  //$extrafields = new ExtraFields($this->db);
491  //$result1=$extrafields->addExtraField('bookcal_myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
492  //$result2=$extrafields->addExtraField('bookcal_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
493  //$result3=$extrafields->addExtraField('bookcal_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
494  //$result4=$extrafields->addExtraField('bookcal_myattr4', "New Attr 4 label", 'select', 1, 3, 'thirdparty', 0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1,'', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
495  //$result5=$extrafields->addExtraField('bookcal_myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
496 
497  // Permissions
498  $this->remove($options);
499 
500  $sql = array();
501 
502  // Document templates
503  $moduledir = dol_sanitizeFileName('bookcal');
504  $myTmpObjects = array();
505  $myTmpObjects['Availabilities'] = array('includerefgeneration'=>0, 'includedocgeneration'=>0);
506 
507  foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
508  if ($myTmpObjectKey == 'Availabilities') {
509  continue;
510  }
511  if ($myTmpObjectArray['includerefgeneration']) {
512  $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/'.$moduledir.'/template_availabilitiess.odt';
513  $dirodt = DOL_DATA_ROOT.'/doctemplates/'.$moduledir;
514  $dest = $dirodt.'/template_availabilitiess.odt';
515 
516  if (file_exists($src) && !file_exists($dest)) {
517  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
518  dol_mkdir($dirodt);
519  $result = dol_copy($src, $dest, 0, 0);
520  if ($result < 0) {
521  $langs->load("errors");
522  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
523  return 0;
524  }
525  }
526 
527  $sql = array_merge($sql, array(
528  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey)."' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
529  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey)."', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")",
530  "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),
531  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey)."_odt', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")"
532  ));
533  }
534  }
535 
536  return $this->_init($sql, $options);
537  }
538 
547  public function remove($options = '')
548  {
549  $sql = array();
550  return $this->_remove($sql, $options);
551  }
552 }
dol_sanitizeFileName
dol_sanitizeFileName($str, $newstr='_', $unaccent=1)
Clean a string to use it as a file name.
Definition: functions.lib.php:1323
description
print *****$script_file(".$version.") pid cd cd cd description as description
Definition: email_expire_services_to_customers.php:83
DolibarrModules\_load_tables
_load_tables($reldir, $onlywithsuffix='')
Create tables and keys required by module:
Definition: DolibarrModules.class.php:1126
name
$conf db name
Definition: repair.php:123
DolibarrModules\_remove
_remove($array_sql, $options='')
Disable function.
Definition: DolibarrModules.class.php:535
dol_copy
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
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
Definition: functions.lib.php:4135
modBookCal
Description and activation class for module BookCal.
Definition: modBookCal.class.php:33
DolibarrModules\_init
_init($array_sql, $options='')
Enables a module.
Definition: DolibarrModules.class.php:436
$sql
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
modBookCal\init
init($options='')
Function called when module is enabled.
Definition: modBookCal.class.php:479
dol_mkdir
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
Definition: functions.lib.php:6936
modBookCal\__construct
__construct($db)
Constructor.
Definition: modBookCal.class.php:40
DolibarrModules
Class DolibarrModules.
Definition: DolibarrModules.class.php:37