dolibarr  16.0.5
modHoliday.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2011 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2005-2010 Regis Houssin <regis.houssin@inodbox.com>
5  * Copyright (C) 2011 Dimitri Mouillard <dmouillard@teclib.com>
6  * Copyright (C) 2013 Juanjo Menent <jmenent@2byte.es>
7  * Copyright (C) 2018 Charlene Benke <charlie@patas-monkey.com>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <https://www.gnu.org/licenses/>.
21  * or see https://www.gnu.org/
22  */
23 
31 include_once DOL_DOCUMENT_ROOT."/core/modules/DolibarrModules.class.php";
32 
33 
38 {
44  public function __construct($db)
45  {
46  global $conf, $user; // Required by some include code
47 
48  $this->db = $db;
49 
50  // Id for module (must be unique).
51  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
52  $this->numero = 20000;
53  // Key text used to identify module (for permissions, menus, etc...)
54  $this->rights_class = 'holiday';
55 
56  // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
57  // It is used to group modules in module setup page
58  $this->family = "hr";
59  $this->module_position = '42';
60  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
61  $this->name = preg_replace('/^mod/i', '', get_class($this));
62  // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
63  $this->description = "Leave requests";
64  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
65  $this->version = 'dolibarr';
66  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
67  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
68  // Name of image file used for this module.
69  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
70  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
71  $this->picto = 'holiday';
72 
73  // Data directories to create when module is enabled.
74  // Example: this->dirs = array("/mymodule/temp");
75  $this->dirs = array("/holiday/temp");
76  $r = 0;
77 
78  // Config pages
79  $this->config_page_url = array("holiday.php");
80 
81 
82  // Config pages. Put here list of php page names stored in admmin directory used to setup module.
83  // $this->config_page_url = array("holiday.php?leftmenu=setup@holiday");
84 
85  // Dependencies
86  $this->hidden = false; // A condition to hide module
87  $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
88  $this->requiredby = array(); // List of module ids to disable if this one is disabled
89  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
90  $this->phpmin = array(5, 6); // Minimum version of PHP required by module
91  $this->need_dolibarr_version = array(3, 0); // Minimum version of Dolibarr required by module
92  $this->langfiles = array("holiday");
93 
94  // Constants
95  // Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',0),
96  // 1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0) );
97  // 2=>array('MAIN_MODULE_MYMODULE_NEEDSMARTY','chaine',1,'Constant to say module need smarty',0)
98  $this->const = array(); // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 0 or 'allentities')
99  $r = 0;
100 
101  $this->const[$r][0] = "HOLIDAY_ADDON";
102  $this->const[$r][1] = "chaine";
103  $this->const[$r][2] = "mod_holiday_madonna";
104  $this->const[$r][3] = 'Nom du gestionnaire de numerotation des cong├ęs';
105  $this->const[$r][4] = 0;
106  $r++;
107 
108  $this->const[$r][0] = "HOLIDAY_ADDON_PDF";
109  $this->const[$r][1] = "chaine";
110  $this->const[$r][2] = "celebrate";
111  $this->const[$r][3] = 'Name of PDF model of holiday';
112  $this->const[$r][4] = 0;
113  $r++;
114 
115  $this->const[$r][0] = "HOLIDAY_ADDON_PDF_ODT_PATH";
116  $this->const[$r][1] = "chaine";
117  $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/holiday";
118  $this->const[$r][3] = "";
119  $this->const[$r][4] = 0;
120  $r++;
121 
122  // Array to add new pages in new tabs
123  //$this->tabs[] = array('data'=>'user:+paidholidays:CPTitreMenu:holiday:$user->rights->holiday->read:/holiday/list.php?mainmenu=hrm&id=__ID__'); // We avoid to get one tab for each module. RH data are already in RH tab.
124  $this->tabs[] = array(); // To add a new tab identified by code tabname1
125 
126  // Boxes
127  $this->boxes = array(); // List of boxes
128  $r = 0;
129 
130  // Add here list of php file(s) stored in includes/boxes that contains class to show a box.
131  // Example:
132  //$this->boxes[$r][1] = "myboxa.php";
133  //$r++;
134  //$this->boxes[$r][1] = "myboxb.php";
135  //$r++;
136 
137 
138  // Cronjobs
139  $arraydate = dol_getdate(dol_now());
140  $datestart = dol_mktime(4, 0, 0, $arraydate['mon'], $arraydate['mday'], $arraydate['year']);
141  $this->cronjobs = array(
142  0 => array(
143  'label' => 'HolidayBalanceMonthlyUpdate',
144  'jobtype' => 'method',
145  'class' => 'holiday/class/holiday.class.php',
146  'objectname' => 'Holiday',
147  'method' => 'updateBalance',
148  'parameters' => '',
149  'comment' => 'Update holiday balance every month',
150  'frequency' => 1,
151  'unitfrequency' => 3600 * 24,
152  'priority' => 50,
153  'status' => 1,
154  'test' => '$conf->holiday->enabled',
155  'datestart' => $datestart
156  )
157  );
158 
159 
160  // Permissions
161  $this->rights = array(); // Permission array used by this module
162  $r = 0;
163 
164  $this->rights[$r][0] = 20001; // Permission id (must not be already used)
165  $this->rights[$r][1] = 'Read leave requests (yours and your subordinates)'; // Permission label
166  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
167  $this->rights[$r][4] = 'read'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
168  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
169  $r++;
170 
171  $this->rights[$r][0] = 20002; // Permission id (must not be already used)
172  $this->rights[$r][1] = 'Create/modify leave requests'; // Permission label
173  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
174  $this->rights[$r][4] = 'write'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
175  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
176  $r++;
177 
178  $this->rights[$r][0] = 20003; // Permission id (must not be already used)
179  $this->rights[$r][1] = 'Delete leave requests'; // Permission label
180  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
181  $this->rights[$r][4] = 'delete'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
182  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
183  $r++;
184 
185  $this->rights[$r][0] = 20007;
186  $this->rights[$r][1] = 'Approve leave requests';
187  $this->rights[$r][2] = 'w';
188  $this->rights[$r][3] = 0;
189  $this->rights[$r][4] = 'approve';
190  $r++;
191 
192  $this->rights[$r][0] = 20004; // Permission id (must not be already used)
193  $this->rights[$r][1] = 'Read leave requests for everybody'; // Permission label
194  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
195  $this->rights[$r][4] = 'readall'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
196  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
197  $r++;
198 
199  $this->rights[$r][0] = 20005; // Permission id (must not be already used)
200  $this->rights[$r][1] = 'Create/modify leave requests for everybody'; // Permission label
201  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
202  $this->rights[$r][4] = 'writeall'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
203  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
204  $r++;
205 
206  $this->rights[$r][0] = 20006; // Permission id (must not be already used)
207  $this->rights[$r][1] = 'Setup leave requests of users (setup and update balance)'; // Permission label
208  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
209  $this->rights[$r][4] = 'define_holiday'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
210  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
211  $r++;
212 
213 
214  // Menus
215  //-------
216  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
217 
218 
219  // Exports
220  $r = 0;
221 
222  $r++;
223  $this->export_code[$r] = 'leaverequest_'.$r;
224  $this->export_label[$r] = 'ListeCP';
225  $this->export_icon[$r] = 'holiday';
226  $this->export_permission[$r] = array(array("holiday", "readall"));
227  $this->export_fields_array[$r] = array(
228  'd.rowid'=>"LeaveId", 'd.fk_type'=>'TypeOfLeaveId', 't.code'=>'TypeOfLeaveCode', 't.label'=>'TypeOfLeaveLabel', 'd.fk_user'=>'UserID',
229  'd.date_debut'=>'DateStart', 'd.date_fin'=>'DateEnd', 'd.halfday'=>'HalfDay', 'none.num_open_days'=>'NbUseDaysCP',
230  'd.date_valid'=>'DateApprove', 'd.fk_validator'=>"UserForApprovalID",
231  'u.lastname'=>'Lastname', 'u.firstname'=>'Firstname', 'u.login'=>"Login",
232  'ua.lastname'=>"UserForApprovalLastname", 'ua.firstname'=>"UserForApprovalFirstname",
233  'ua.login'=>"UserForApprovalLogin", 'd.description'=>'Description', 'd.statut'=>'Status'
234  );
235  $this->export_TypeFields_array[$r] = array(
236  'd.rowid'=>"Numeric", 't.code'=>'Text', 't.label'=>'Text', 'd.fk_user'=>'Numeric',
237  'd.date_debut'=>'Date', 'd.date_fin'=>'Date', 'none.num_open_days'=>'NumericCompute',
238  'd.date_valid'=>'Date', 'd.fk_validator'=>"Numeric",
239  'u.lastname'=>'Text', 'u.firstname'=>'Text', 'u.login'=>"Text",
240  'ua.lastname'=>"Text", 'ua.firstname'=>"Text",
241  'ua.login'=>"Text", 'd.description'=>'Text', 'd.statut'=>'Numeric'
242  );
243  $this->export_entities_array[$r] = array(
244  'u.lastname'=>'user', 'u.firstname'=>'user', 'u.login'=>'user', 'ua.lastname'=>'user', 'ua.firstname'=>'user', 'ua.login'=>'user'
245  );
246  $this->export_alias_array[$r] = array('d.rowid'=>"idholiday");
247  $this->export_special_array[$r] = array('none.num_open_days'=>'getNumOpenDays');
248  $this->export_dependencies_array[$r] = array(); // To add unique key if we ask a field of a child to avoid the DISTINCT to discard them
249 
250  $keyforselect = 'holiday';
251  $keyforelement = 'holiday';
252  $keyforaliasextra = 'extra';
253  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
254  $keyforselect = 'user'; $keyforelement = 'user'; $keyforaliasextra = 'extrau';
255  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
256 
257  $this->export_sql_start[$r] = 'SELECT DISTINCT ';
258  $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'holiday as d';
259  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'holiday_extrafields as extra on d.rowid = extra.fk_object';
260  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_holiday_types as t ON t.rowid = d.fk_type';
261  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'user as ua ON ua.rowid = d.fk_validator,';
262  $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'user as u';
263  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'user_extrafields as extrau ON u.rowid = extrau.fk_object';
264  $this->export_sql_end[$r] .= ' WHERE d.fk_user = u.rowid';
265  $this->export_sql_end[$r] .= ' AND d.entity IN ('.getEntity('holiday').')';
266 
267  // Example:
268  // $this->export_code[$r]=$this->rights_class.'_'.$r;
269  // $this->export_label[$r]='CustomersInvoicesAndInvoiceLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
270  // $this->export_permission[$r]=array(array("facture","facture","export"));
271  // $this->export_fields_array[$r]=array(
272  // 's.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone',
273  // 's.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode',
274  // 's.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.ref'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",
275  // 'f.datef'=>"DateInvoice",'f.total_ht'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.total_tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus',
276  // 'f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",
277  // 'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",
278  // 'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef'
279  //);
280  // $this->export_entities_array[$r]=array(
281  // 's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company',
282  // 's.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company',
283  // 'f.rowid'=>"invoice",'f.ref'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total_ht'=>"invoice",'f.total_ttc'=>"invoice",'f.total_tva'=>"invoice",
284  // 'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",'fd.price'=>"invoice_line",
285  // 'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",'fd.qty'=>"invoice_line",
286  // 'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product'
287  //);
288  // $this->export_alias_array[$r]=array(
289  // 's.rowid'=>"socid",'s.nom'=>'soc_name','s.address'=>'soc_adres','s.zip'=>'soc_zip','s.town'=>'soc_town','s.fk_pays'=>'soc_pays','s.phone'=>'soc_tel',
290  // 's.siren'=>'soc_siren','s.siret'=>'soc_siret','s.ape'=>'soc_ape','s.idprof4'=>'soc_idprof4','s.code_compta'=>'soc_customer_accountancy',
291  // 's.code_compta_fournisseur'=>'soc_supplier_accountancy','f.rowid'=>"invoiceid",'f.ref'=>"ref",'f.datec'=>"datecreation",'f.datef'=>"dateinvoice",
292  // 'f.total_ht'=>"totalht",'f.total_ttc'=>"totalttc",'f.total_tva'=>"totalvat",'f.paye'=>"paid",'f.fk_statut'=>'status','f.note'=>"note",'fd.rowid'=>'lineid',
293  // 'fd.description'=>"linedescription",'fd.price'=>"lineprice",'fd.total_ht'=>"linetotalht",'fd.total_tva'=>"linetotaltva",'fd.total_ttc'=>"linetotalttc",
294  // 'fd.tva_tx'=>"linevatrate",'fd.qty'=>"lineqty",'fd.date_start'=>"linedatestart",'fd.date_end'=>"linedateend",'fd.fk_product'=>'productid',
295  // 'p.ref'=>'productref'
296  //);
297  // $this->export_sql_start[$r]='SELECT DISTINCT ';
298  // $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
299  // $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
300  // $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
301  // $r++;
302  }
303 
312  public function init($options = '')
313  {
314  global $conf;
315 
316  // Permissions
317  $this->remove($options);
318 
319  //ODT template
320  /*$src=DOL_DOCUMENT_ROOT.'/install/doctemplates/holiday/template_holiday.odt';
321  $dirodt=DOL_DATA_ROOT.'/doctemplates/holiday';
322  $dest=$dirodt.'/template_order.odt';
323 
324  if (file_exists($src) && ! file_exists($dest))
325  {
326  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
327  dol_mkdir($dirodt);
328  $result=dol_copy($src, $dest, 0, 0);
329  if ($result < 0)
330  {
331  $langs->load("errors");
332  $this->error=$langs->trans('ErrorFailToCopyFile', $src, $dest);
333  return 0;
334  }
335  }
336  */
337 
338  $sql = array(
339  // "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[0][2])."' AND type = 'holiday' AND entity = ".((int) $conf->entity),
340  // "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[0][2])."','holiday',".((int) $conf->entity).")"
341  );
342 
343  return $this->_init($sql, $options);
344  }
345 }
modHoliday
Description and activation class for module holiday.
Definition: modHoliday.class.php:37
dol_getdate
dol_getdate($timestamp, $fast=false, $forcetimezone='')
Return an array with locale date info.
Definition: functions.lib.php:2713
db
$conf db
API class for accounts.
Definition: inc.php:41
description
print *****$script_file(".$version.") pid cd cd cd description as description
Definition: email_expire_services_to_customers.php:83
modHoliday\init
init($options='')
Function called when module is enabled.
Definition: modHoliday.class.php:312
name
$conf db name
Definition: repair.php:122
modHoliday\__construct
__construct($db)
Constructor.
Definition: modHoliday.class.php:44
DolibarrModules\_init
_init($array_sql, $options='')
Enables a module.
Definition: DolibarrModules.class.php:383
dol_now
dol_now($mode='auto')
Return date for now.
Definition: functions.lib.php:2845
dol_mktime
dol_mktime($hour, $minute, $second, $month, $day, $year, $gm='auto', $check=1)
Return a timestamp date built from detailed informations (by default a local PHP server timestamp) Re...
Definition: functions.lib.php:2757
DolibarrModules
Class DolibarrModules.
Definition: DolibarrModules.class.php:37