dolibarr  20.0.0-beta
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  * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
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 
45  $this->db = $db;
46 
47  // Id for module (must be unique).
48  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
49  $this->numero = 2430;
50 
51  // Key text used to identify module (for permissions, menus, etc...)
52  $this->rights_class = 'bookcal';
53 
54  // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
55  // It is used to group modules by family in module setup page
56  $this->family = "projects";
57 
58  // Module position in the family on 2 digits ('01', '10', '20', ...)
59  $this->module_position = '50';
60 
61  // 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)
62  //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
63  // Module label (no space allowed), used if translation string 'ModuleBookCalName' not found (BookCal is name of module).
64  $this->name = preg_replace('/^mod/i', '', get_class($this));
65 
66  // Module description, used if translation string 'ModuleBookCalDesc' not found (BookCal is name of module).
67  $this->description = "BookCalDescription";
68  // Used only if file README.md and README-LL.md not found.
69  $this->descriptionlong = "BookCalDescription";
70 
71  // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
72  $this->version = 'experimental';
73 
74  // Key used in llx_const table to save module status enabled/disabled (where BOOKCAL is value of property name of module in uppercase)
75  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
76 
77  // Name of image file used for this module.
78  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
79  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
80  // To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
81  $this->picto = 'bookcal';
82 
83  // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
84  $this->module_parts = array(
85  // Set this to 1 if module has its own trigger directory (core/triggers)
86  'triggers' => 0,
87  // Set this to 1 if module has its own login method file (core/login)
88  'login' => 0,
89  // Set this to 1 if module has its own substitution function file (core/substitutions)
90  'substitutions' => 0,
91  // Set this to 1 if module has its own menus handler directory (core/menus)
92  'menus' => 0,
93  // Set this to 1 if module overwrite template dir (core/tpl)
94  'tpl' => 0,
95  // Set this to 1 if module has its own barcode directory (core/modules/barcode)
96  'barcode' => 0,
97  // Set this to 1 if module has its own models directory (core/modules/xxx)
98  'models' => 0,
99  // Set this to 1 if module has its own printing directory (core/modules/printing)
100  'printing' => 0,
101  // Set this to 1 if module has its own theme directory (theme)
102  'theme' => 0,
103  // Set this to relative path of css file if module has its own css file
104  'css' => array(
105  // '/bookcal/css/bookcal.css.php',
106  ),
107  // Set this to relative path of js file if module must load a js on all pages
108  'js' => array(
109  // '/bookcal/js/bookcal.js.php',
110  ),
111  // 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'
112  'hooks' => array(
113  // 'data' => array(
114  // 'hookcontext1',
115  // 'hookcontext2',
116  // ),
117  // 'entity' => '0',
118  ),
119  // Set this to 1 if features of module are opened to external users
120  'moduleforexternal' => 0,
121  );
122 
123  // Data directories to create when module is enabled.
124  // Example: this->dirs = array("/bookcal/temp","/bookcal/subdir");
125  $this->dirs = array("/bookcal/temp");
126 
127  // Config pages. Put here list of php page, stored into bookcal/admin directory, to use to setup module.
128  $this->config_page_url = array("setup.php@bookcal");
129 
130  // Dependencies
131  // A condition to hide module
132  $this->hidden = false;
133  // 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'...))
134  $this->depends = array();
135  $this->requiredby = array(); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
136  $this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
137 
138  // The language file dedicated to your module
139  $this->langfiles = array("agenda");
140 
141  // Prerequisites
142  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
143 
144  // Messages at activation
145  $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
146  $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
147  //$this->automatic_activation = array('FR'=>'BookCalWasAutomaticallyActivatedBecauseOfYourCountryChoice');
148  //$this->always_enabled = true; // If true, can't be disabled
149 
150  // Constants
151  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
152  // Example: $this->const=array(1 => array('BOOKCAL_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
153  // 2 => array('BOOKCAL_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
154  // );
155  $this->const = array();
156 
157  // Some keys to add into the overwriting translation tables
158  /*$this->overwrite_translation = array(
159  'en_US:ParentCompany'=>'Parent company or reseller',
160  'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
161  )*/
162 
163  if (!isset($conf->bookcal) || !isset($conf->bookcal->enabled)) {
164  $conf->bookcal = new stdClass();
165  $conf->bookcal->enabled = 0;
166  }
167 
168  // Array to add new pages in new tabs
169  $this->tabs = array();
170  // Example:
171  // $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
172  // $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.
173  // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
174  //
175  // Where objecttype can be
176  // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
177  // 'contact' to add a tab in contact view
178  // 'contract' to add a tab in contract view
179  // 'group' to add a tab in group view
180  // 'intervention' to add a tab in intervention view
181  // 'invoice' to add a tab in customer invoice view
182  // 'invoice_supplier' to add a tab in supplier invoice view
183  // 'member' to add a tab in foundation member view
184  // 'opensurveypoll' to add a tab in opensurvey poll view
185  // 'order' to add a tab in customer order view
186  // 'order_supplier' to add a tab in supplier order view
187  // 'payment' to add a tab in payment view
188  // 'payment_supplier' to add a tab in supplier payment view
189  // 'product' to add a tab in product view
190  // 'propal' to add a tab in propal view
191  // 'project' to add a tab in project view
192  // 'stock' to add a tab in stock view
193  // 'thirdparty' to add a tab in third party view
194  // 'user' to add a tab in user view
195 
196  // Dictionaries
197  $this->dictionaries = array();
198  /* Example:
199  $this->dictionaries=array(
200  'langs'=>'bookcal@bookcal',
201  // List of tables we want to see into dictonnary editor
202  'tabname'=>array("table1", "table2", "table3"),
203  // Label of tables
204  'tablib'=>array("Table1", "Table2", "Table3"),
205  // Request to select fields
206  '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'),
207  // Sort order
208  'tabsqlsort'=>array("label ASC", "label ASC", "label ASC"),
209  // List of fields (result of select to show dictionary)
210  'tabfield'=>array("code,label", "code,label", "code,label"),
211  // List of fields (list of fields to edit a record)
212  'tabfieldvalue'=>array("code,label", "code,label", "code,label"),
213  // List of fields (list of fields for insert)
214  'tabfieldinsert'=>array("code,label", "code,label", "code,label"),
215  // Name of columns with primary key (try to always name it 'rowid')
216  'tabrowid'=>array("rowid", "rowid", "rowid"),
217  // Condition to show each dictionary
218  'tabcond'=>array($conf->bookcal->enabled, $conf->bookcal->enabled, $conf->bookcal->enabled)
219  // Help tooltip for each fields of the dictionary
220  'tabhelp'=>array(array('code'=>$langs->trans('CodeTooltipHelp')))
221  );
222  */
223 
224  // Boxes/Widgets
225  // Add here list of php file(s) stored in bookcal/core/boxes that contains a class to show a widget.
226  $this->boxes = array(
227  // 0 => array(
228  // 'file' => 'bookcalwidget1.php@bookcal',
229  // 'note' => 'Widget provided by BookCal',
230  // 'enabledbydefaulton' => 'Home',
231  // ),
232  // ...
233  );
234 
235  // Cronjobs (List of cron jobs entries to add when module is enabled)
236  // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
237  $this->cronjobs = array(
238  // 0 => array(
239  // 'label' => 'MyJob label',
240  // 'jobtype' => 'method',
241  // 'class' => '/bookcal/class/availabilities.class.php',
242  // 'objectname' => 'Availabilities',
243  // 'method' => 'doScheduledJob',
244  // 'parameters' => '',
245  // 'comment' => 'Comment',
246  // 'frequency' => 2,
247  // 'unitfrequency' => 3600,
248  // 'status' => 0,
249  // 'test' => '$conf->bookcal->enabled',
250  // 'priority' => 50,
251  // ),
252  );
253  // Example: $this->cronjobs=array(
254  // 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),
255  // 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)
256  // );
257 
258  // Permissions provided by this module
259  $this->rights = array();
260  $r = 0;
261  // Add here entries to declare new permissions
262  /* BEGIN MODULEBUILDER PERMISSIONS */
263  $this->rights[$r][0] = $this->numero . sprintf('%02d', (0 * 10) + 1);
264  $this->rights[$r][1] = 'Read objects of BookCal';
265  $this->rights[$r][4] = 'availabilities';
266  $this->rights[$r][5] = 'read';
267  $r++;
268  $this->rights[$r][0] = $this->numero . sprintf('%02d', (0 * 10) + 2);
269  $this->rights[$r][1] = 'Create/Update objects of BookCal';
270  $this->rights[$r][4] = 'availabilities';
271  $this->rights[$r][5] = 'write';
272  $r++;
273  $this->rights[$r][0] = $this->numero . sprintf('%02d', (0 * 10) + 3);
274  $this->rights[$r][1] = 'Delete objects of BookCal';
275  $this->rights[$r][4] = 'availabilities';
276  $this->rights[$r][5] = 'delete';
277  $r++;
278  $this->rights[$r][0] = $this->numero . sprintf('%02d', (1 * 10) + 1);
279  $this->rights[$r][1] = 'Read Calendar object of BookCal';
280  $this->rights[$r][4] = 'calendar';
281  $this->rights[$r][5] = 'read';
282  $r++;
283  $this->rights[$r][0] = $this->numero . sprintf('%02d', (1 * 10) + 2);
284  $this->rights[$r][1] = 'Create/Update Calendar object of BookCal';
285  $this->rights[$r][4] = 'calendar';
286  $this->rights[$r][5] = 'write';
287  $r++;
288  $this->rights[$r][0] = $this->numero . sprintf('%02d', (1 * 10) + 3);
289  $this->rights[$r][1] = 'Delete Calendar object of BookCal';
290  $this->rights[$r][4] = 'calendar';
291  $this->rights[$r][5] = 'delete';
292  $r++;
293 
294  /* END MODULEBUILDER PERMISSIONS */
295 
296  // Main menu entries to add
297  $this->menu = array();
298  $r = 0;
299  // Add here entries to declare new menus
300  /* BEGIN MODULEBUILDER TOPMENU */
301  /*$this->menu[$r++] = array(
302  '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
303  'type'=>'top', // This is a Top menu entry
304  'titre'=>'ModuleBookCalName',
305  'prefix' => img_picto('', $this->picto, 'class="pictofixedwidth valignmiddle"'),
306  'mainmenu'=>'bookcal',
307  'leftmenu'=>'',
308  'url'=>'/bookcal/bookcalindex.php',
309  'langs'=>'bookcal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
310  'position'=>1000 + $r,
311  '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.
312  'perms'=>'$user->rights->bookcal->availabilities->read', // Use 'perms'=>'$user->rights->bookcal->availabilities->read' if you want your menu with a permission rules
313  'target'=>'',
314  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
315  );*/
316  /* END MODULEBUILDER TOPMENU */
317 
318  /* BEGIN MODULEBUILDER LEFTMENU CALENDAR */
319  $this->menu[$r++] = array(
320  'fk_menu' => 'fk_mainmenu=agenda',
321  'type' => 'left',
322  'titre' => 'MenuBookcalIndex',
323  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth em92"'),
324  'mainmenu' => 'agenda',
325  'leftmenu' => 'bookcal',
326  'url' => '/bookcal/bookcalindex.php',
327  'langs' => 'bookcal',
328  'position' => 1100 + $r,
329  'enabled' => '1',
330  'perms' => '$user->rights->bookcal->calendar->read',
331  'user' => 0
332  );
333 
334  $this->menu[$r++] = array(
335  // '' 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
336  'fk_menu' => 'fk_mainmenu=agenda,fk_leftmenu=bookcal',
337  // This is a Left menu entry
338  'type' => 'left',
339  'titre' => 'Calendar',
340  'mainmenu' => 'agenda',
341  'leftmenu' => 'bookcal_calendar_list',
342  'url' => '/bookcal/calendar_list.php',
343  // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
344  'langs' => 'bookcal',
345  'position' => 1100 + $r,
346  // 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.
347  'enabled' => '$conf->bookcal->enabled',
348  // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
349  'perms' => '$user->rights->bookcal->calendar->read',
350  'target' => '',
351  // 0=Menu for internal users, 1=external users, 2=both
352  'user' => 2,
353  );
354  $this->menu[$r++] = array(
355  // '' 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
356  'fk_menu' => 'fk_mainmenu=agenda,fk_leftmenu=bookcal_calendar_list',
357  // This is a Left menu entry
358  'type' => 'left',
359  'titre' => 'NewCalendar',
360  'mainmenu' => 'agenda',
361  'leftmenu' => 'bookcal_new',
362  'url' => '/bookcal/calendar_card.php?action=create',
363  // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
364  'langs' => 'bookcal',
365  'position' => 1100 + $r,
366  // 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.
367  'enabled' => '$conf->bookcal->enabled',
368  // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
369  'perms' => '$user->rights->bookcal->calendar->read',
370  'target' => '',
371  // 0=Menu for internal users, 1=external users, 2=both
372  'user' => 2
373  );
374  /* END MODULEBUILDER LEFTMENU CALENDAR */
375 
376  /* BEGIN MODULEBUILDER LEFTMENU AVAILABILITIES
377  $this->menu[$r++]=array(
378  '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
379  'type'=>'left', // This is a Left menu entry
380  'titre'=>'Availabilities',
381  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
382  'mainmenu'=>'bookcal',
383  'leftmenu'=>'availabilities',
384  'url'=>'/bookcal/bookcalindex.php',
385  'langs'=>'bookcal@bookcal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
386  'position'=>1000+$r,
387  '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.
388  'perms'=>'$user->rights->bookcal->availabilities->read', // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
389  'target'=>'',
390  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
391  );
392  $this->menu[$r++]=array(
393  '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
394  'type'=>'left', // This is a Left menu entry
395  'titre'=>'List_Availabilities',
396  'mainmenu'=>'bookcal',
397  'leftmenu'=>'bookcal_availabilities_list',
398  'url'=>'/bookcal/availabilities_list.php',
399  'langs'=>'bookcal@bookcal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
400  'position'=>1000+$r,
401  '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.
402  'perms'=>'$user->rights->bookcal->availabilities->read', // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
403  'target'=>'',
404  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
405  );
406  $this->menu[$r++]=array(
407  '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
408  'type'=>'left', // This is a Left menu entry
409  'titre'=>'New_Availabilities',
410  'mainmenu'=>'bookcal',
411  'leftmenu'=>'bookcal_availabilities_new',
412  'url'=>'/bookcal/availabilities_card.php?action=create',
413  'langs'=>'bookcal@bookcal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
414  'position'=>1000+$r,
415  '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.
416  'perms'=>'$user->rights->bookcal->availabilities->write', // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
417  'target'=>'',
418  'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
419  );
420  */
421 
422  $this->menu[$r++] = array(
423  // '' 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
424  'fk_menu' => 'fk_mainmenu=agenda,fk_leftmenu=bookcal',
425  // This is a Left menu entry
426  'type' => 'left',
427  'titre' => 'Availabilities',
428  'mainmenu' => 'agenda',
429  'leftmenu' => 'bookcal_availabilities',
430  'url' => '/bookcal/availabilities_list.php',
431  // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
432  'langs' => 'bookcal',
433  'position' => 1200 + $r,
434  // 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.
435  'enabled' => '$conf->bookcal->enabled',
436  // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
437  'perms' => '$user->rights->bookcal->availabilities->read',
438  'target' => '',
439  // 0=Menu for internal users, 1=external users, 2=both
440  'user' => 2,
441  );
442  $this->menu[$r++] = array(
443  // '' 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
444  'fk_menu' => 'fk_mainmenu=agenda,fk_leftmenu=bookcal_availabilities',
445  // This is a Left menu entry
446  'type' => 'left',
447  'titre' => 'NewAvailabilities',
448  'mainmenu' => 'agenda',
449  'leftmenu' => 'bookcal_availabilities',
450  'url' => '/bookcal/availabilities_card.php?action=create',
451  // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
452  'langs' => 'bookcal',
453  'position' => 1200 + $r,
454  // 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.
455  'enabled' => '$conf->bookcal->enabled',
456  // Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
457  'perms' => '$user->rights->bookcal->availabilities->read',
458  'target' => '',
459  // 0=Menu for internal users, 1=external users, 2=both
460  'user' => 2
461  );
462 
463  /* END MODULEBUILDER LEFTMENU AVAILABILITIES */
464  // Exports profiles provided by this module
465  $r = 1;
466  /* BEGIN MODULEBUILDER EXPORT AVAILABILITIES */
467  /*
468  $langs->load("agenda");
469  $this->export_code[$r]=$this->rights_class.'_'.$r;
470  $this->export_label[$r]='AvailabilitiesLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
471  $this->export_icon[$r]='availabilities@bookcal';
472  // Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
473  $keyforclass = 'Availabilities'; $keyforclassfile='/bookcal/class/availabilities.class.php'; $keyforelement='availabilities@bookcal';
474  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
475  //$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
476  //unset($this->export_fields_array[$r]['t.fieldtoremove']);
477  //$keyforclass = 'AvailabilitiesLine'; $keyforclassfile='/bookcal/class/availabilities.class.php'; $keyforelement='availabilitiesline@bookcal'; $keyforalias='tl';
478  //include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
479  $keyforselect='availabilities'; $keyforaliasextra='extra'; $keyforelement='availabilities@bookcal';
480  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
481  //$keyforselect='availabilitiesline'; $keyforaliasextra='extraline'; $keyforelement='availabilitiesline@bookcal';
482  //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
483  //$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)
484  //$this->export_special_array[$r] = array('t.field'=>'...');
485  //$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
486  //$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
487  $this->export_sql_start[$r]='SELECT DISTINCT ';
488  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'availabilities as t';
489  //$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'availabilities_line as tl ON tl.fk_availabilities = t.rowid';
490  $this->export_sql_end[$r] .=' WHERE 1 = 1';
491  $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('availabilities').')';
492  $r++; */
493  /* END MODULEBUILDER EXPORT AVAILABILITIES */
494 
495  // Imports profiles provided by this module
496 
497  $r = 1;
498  /* BEGIN MODULEBUILDER IMPORT AVAILABILITIES */
499  /*
500  $langs->load("agenda");
501  $this->import_code[$r]=$this->rights_class.'_'.$r;
502  $this->import_label[$r]='AvailabilitiesLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
503  $this->import_icon[$r]='availabilities@bookcal';
504  $this->import_tables_array[$r] = array('t' => MAIN_DB_PREFIX.'bookcal_availabilities', 'extra' => MAIN_DB_PREFIX.'bookcal_availabilities_extrafields');
505  $this->import_tables_creator_array[$r] = array('t' => 'fk_user_author'); // Fields to store import user id
506  $import_sample = array();
507  $keyforclass = 'Availabilities'; $keyforclassfile='/bookcal/class/availabilities.class.php'; $keyforelement='availabilities@bookcal';
508  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinimport.inc.php';
509  $import_extrafield_sample = array();
510  $keyforselect='availabilities'; $keyforaliasextra='extra'; $keyforelement='availabilities@bookcal';
511  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinimport.inc.php';
512  $this->import_fieldshidden_array[$r] = array('extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'bookcal_availabilities');
513  $this->import_regex_array[$r] = array();
514  $this->import_examplevalues_array[$r] = array_merge($import_sample, $import_extrafield_sample);
515  $this->import_updatekeys_array[$r] = array('t.ref' => 'Ref');
516  $this->import_convertvalue_array[$r] = array(
517  't.ref' => array(
518  'rule'=>'getrefifauto',
519  'class'=>(empty($conf->global->BOOKCAL_AVAILABILITIES_ADDON) ? 'mod_availabilities_standard' : $conf->global->BOOKCAL_AVAILABILITIES_ADDON),
520  'path'=>"/core/modules/commande/".(empty($conf->global->BOOKCAL_AVAILABILITIES_ADDON) ? 'mod_availabilities_standard' : $conf->global->BOOKCAL_AVAILABILITIES_ADDON).'.php'
521  'classobject'=>'Availabilities',
522  'pathobject'=>'/bookcal/class/availabilities.class.php',
523  ),
524  't.fk_soc' => array('rule' => 'fetchidfromref', 'file' => '/societe/class/societe.class.php', 'class' => 'Societe', 'method' => 'fetch', 'element' => 'ThirdParty'),
525  't.fk_user_valid' => array('rule' => 'fetchidfromref', 'file' => '/user/class/user.class.php', 'class' => 'User', 'method' => 'fetch', 'element' => 'user'),
526  't.fk_mode_reglement' => array('rule' => 'fetchidfromcodeorlabel', 'file' => '/compta/paiement/class/cpaiement.class.php', 'class' => 'Cpaiement', 'method' => 'fetch', 'element' => 'cpayment'),
527  );
528  $r++; */
529  /* END MODULEBUILDER IMPORT AVAILABILITIES */
530  }
531 
540  public function init($options = '')
541  {
542  global $conf, $langs;
543 
544  $result = $this->_load_tables('/install/mysql/', 'bookcal');
545  if ($result < 0) {
546  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')
547  }
548 
549  // Create extrafields during init
550  //include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
551  //$extrafields = new ExtraFields($this->db);
552  //$result1=$extrafields->addExtraField('bookcal_myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
553  //$result2=$extrafields->addExtraField('bookcal_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
554  //$result3=$extrafields->addExtraField('bookcal_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
555  //$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');
556  //$result5=$extrafields->addExtraField('bookcal_myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'bookcal@bookcal', '$conf->bookcal->enabled');
557 
558  // Permissions
559  $this->remove($options);
560 
561  $sql = array();
562 
563  // Document templates
564  $moduledir = dol_sanitizeFileName('bookcal');
565  $myTmpObjects = array();
566  $myTmpObjects['Availabilities'] = array('includerefgeneration' => 0, 'includedocgeneration' => 0);
567 
568  foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
569  if ($myTmpObjectKey == 'Availabilities') {
570  continue;
571  }
572  if ($myTmpObjectArray['includerefgeneration']) {
573  $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/'.$moduledir.'/template_availabilitiess.odt';
574  $dirodt = DOL_DATA_ROOT.'/doctemplates/'.$moduledir;
575  $dest = $dirodt.'/template_availabilitiess.odt';
576 
577  if (file_exists($src) && !file_exists($dest)) {
578  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
579  dol_mkdir($dirodt);
580  $result = dol_copy($src, $dest, 0, 0);
581  if ($result < 0) {
582  $langs->load("errors");
583  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
584  return 0;
585  }
586  }
587 
588  $sql = array_merge($sql, array(
589  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".$this->db->escape(strtolower($myTmpObjectKey))."' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
590  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".$this->db->escape(strtolower($myTmpObjectKey))."', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")",
591  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'generic_".$this->db->escape(strtolower($myTmpObjectKey))."_odt' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
592  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".$this->db->escape(strtolower($myTmpObjectKey))."_odt', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")"
593  ));
594  }
595  }
596 
597  return $this->_init($sql, $options);
598  }
599 
608  public function remove($options = '')
609  {
610  $sql = array();
611  return $this->_remove($sql, $options);
612  }
613 }
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 BookCal.
__construct($db)
Constructor.
init($options='')
Function called when module is enabled.
if(isModEnabled('invoice') && $user->hasRight('facture', 'lire')) if((isModEnabled('fournisseur') &&!getDolGlobalString('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') && $user->hasRight('tax', 'charges', 'lire')) if(isModEnabled('invoice') &&isModEnabled('order') && $user->hasRight("commande", "lire") &&!getDolGlobalString('WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER')) $sql
Social contributions to pay.
Definition: index.php:745
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:767
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $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:126