dolibarr  9.0.0
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 <http://www.gnu.org/licenses/>.
21  * or see http://www.gnu.org/
22  */
23 
31 include_once DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php";
32 
33 
38 {
44  function __construct($db)
45  {
46  $this->db = $db;
47 
48  // Id for module (must be unique).
49  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
50  $this->numero = 20000;
51  // Key text used to identify module (for permissions, menus, etc...)
52  $this->rights_class = 'holiday';
53 
54  // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
55  // It is used to group modules in module setup page
56  $this->family = "hr";
57  $this->module_position = '30';
58  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
59  $this->name = preg_replace('/^mod/i','',get_class($this));
60  // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
61  $this->description = "Leave requests";
62  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
63  $this->version = 'dolibarr';
64  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
65  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
66  // Name of image file used for this module.
67  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
68  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
69  $this->picto='holiday';
70 
71  // Data directories to create when module is enabled.
72  // Example: this->dirs = array("/mymodule/temp");
73  $this->dirs = array("/holiday/temp");
74  $r=0;
75 
76  // Config pages
77  $this->config_page_url = array("holiday.php");
78 
79 
80  // Config pages. Put here list of php page names stored in admmin directory used to setup module.
81  // $this->config_page_url = array("holiday.php?leftmenu=setup@holiday");
82 
83  // Dependencies
84  $this->hidden = false; // A condition to hide module
85  $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
86  $this->requiredby = array(); // List of module ids to disable if this one is disabled
87  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
88  $this->phpmin = array(5,4); // Minimum version of PHP required by module
89  $this->need_dolibarr_version = array(3,0); // Minimum version of Dolibarr required by module
90  $this->langfiles = array("holiday");
91 
92  // Constants
93  // Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',0),
94  // 1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0) );
95  // 2=>array('MAIN_MODULE_MYMODULE_NEEDSMARTY','chaine',1,'Constant to say module need smarty',0)
96  $this->const = array(); // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 0 or 'allentities')
97  $r=0;
98 
99  $this->const[$r][0] = "HOLIDAY_ADDON";
100  $this->const[$r][1] = "chaine";
101  $this->const[$r][2] = "mod_holiday_madonna";
102  $this->const[$r][3] = 'Nom du gestionnaire de numerotation des cong├ęs';
103  $this->const[$r][4] = 0;
104  $r++;
105 
106  $this->const[$r][0] = "HOLIDAY_ADDON_PDF";
107  $this->const[$r][1] = "chaine";
108  $this->const[$r][2] = "celebrate";
109  $this->const[$r][3] = 'Name of PDF model of holiday';
110  $this->const[$r][4] = 0;
111  $r++;
112 
113  $this->const[$r][0] = "HOLIDAY_ADDON_PDF_ODT_PATH";
114  $this->const[$r][1] = "chaine";
115  $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/holiday";
116  $this->const[$r][3] = "";
117  $this->const[$r][4] = 0;
118  $r++;
119 
120  // Array to add new pages in new tabs
121  //$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.
122  $this->tabs[] = array(); // To add a new tab identified by code tabname1
123 
124  // Boxes
125  $this->boxes = array(); // List of boxes
126  $r=0;
127 
128  // Add here list of php file(s) stored in includes/boxes that contains class to show a box.
129  // Example:
130  //$this->boxes[$r][1] = "myboxa.php";
131  //$r++;
132  //$this->boxes[$r][1] = "myboxb.php";
133  //$r++;
134 
135 
136  // Permissions
137  $this->rights = array(); // Permission array used by this module
138  $r=0;
139 
140  $this->rights[$r][0] = 20001; // Permission id (must not be already used)
141  $this->rights[$r][1] = 'Read your own leave requests'; // Permission label
142  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
143  $this->rights[$r][4] = 'read'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
144  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
145  $r++;
146 
147  $this->rights[$r][0] = 20002; // Permission id (must not be already used)
148  $this->rights[$r][1] = 'Create/modify your own leave requests'; // Permission label
149  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
150  $this->rights[$r][4] = 'write'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
151  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
152  $r++;
153 
154  $this->rights[$r][0] = 20003; // Permission id (must not be already used)
155  $this->rights[$r][1] = 'Delete leave requests'; // Permission label
156  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
157  $this->rights[$r][4] = 'delete'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
158  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
159  $r++;
160 
161  $this->rights[$r][0] = 20007;
162  $this->rights[$r][1] = 'Approve leave requests';
163  $this->rights[$r][2] = 'w';
164  $this->rights[$r][3] = 0;
165  $this->rights[$r][4] = 'approve';
166  $r++;
167 
168  $this->rights[$r][0] = 20004; // Permission id (must not be already used)
169  $this->rights[$r][1] = 'Read leave requests for everybody'; // Permission label
170  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
171  $this->rights[$r][4] = 'read_all'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
172  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
173  $r++;
174 
175  $this->rights[$r][0] = 20005; // Permission id (must not be already used)
176  $this->rights[$r][1] = 'Create/modify leave requests for everybody'; // Permission label
177  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
178  $this->rights[$r][4] = 'write_all'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
179  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
180  $r++;
181 
182  $this->rights[$r][0] = 20006; // Permission id (must not be already used)
183  $this->rights[$r][1] = 'Setup leave requests of users (setup and update balance)'; // Permission label
184  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
185  $this->rights[$r][4] = 'define_holiday'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
186  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
187  $r++;
188 
189 
190  // Menus
191  //-------
192  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
193 
194 
195  // Exports
196  $r=0;
197 
198  $r++;
199  $this->export_code[$r]='leaverequest_'.$r;
200  $this->export_label[$r]='ListeCP';
201  $this->export_icon[$r]='holiday';
202  $this->export_permission[$r]=array(array("holiday","read_all"));
203  $this->export_fields_array[$r]=array(
204  'd.rowid'=>"LeaveId",'d.fk_type'=>'TypeOfLeaveId','t.code'=>'TypeOfLeaveCode','t.label'=>'TypeOfLeaveLabel','d.fk_user'=>'UserID',
205  'u.lastname'=>'Lastname','u.firstname'=>'Firstname','u.login'=>"Login",'d.date_debut'=>'DateStart','d.date_fin'=>'DateEnd','d.halfday'=>'HalfDay',
206  'd.date_valid'=>'DateApprove','d.fk_validator'=>"UserForApprovalID",'ua.lastname'=>"UserForApprovalLastname",'ua.firstname'=>"UserForApprovalFirstname",
207  'ua.login'=>"UserForApprovalLogin",'d.description'=>'Description','d.statut'=>'Status'
208  );
209  $this->export_entities_array[$r]=array(
210  'u.lastname'=>'user','u.firstname'=>'user','u.login'=>'user','ua.lastname'=>'user','ua.firstname'=>'user','ua.login'=>'user'
211  );
212  $this->export_alias_array[$r]=array('d.rowid'=>"idholiday");
213  $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
214 
215  $this->export_sql_start[$r]='SELECT DISTINCT ';
216  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'holiday as d';
217  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'c_holiday_types as t ON t.rowid = d.fk_type';
218  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'user as ua ON ua.rowid = d.fk_validator,';
219  $this->export_sql_end[$r] .=' '.MAIN_DB_PREFIX.'user as u';
220  $this->export_sql_end[$r] .=' WHERE d.fk_user = u.rowid';
221  $this->export_sql_end[$r] .=' AND d.entity IN ('.getEntity('holiday').')';
222 
223  // Example:
224  // $this->export_code[$r]=$this->rights_class.'_'.$r;
225  // $this->export_label[$r]='CustomersInvoicesAndInvoiceLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
226  // $this->export_permission[$r]=array(array("facture","facture","export"));
227  // $this->export_fields_array[$r]=array(
228  // 's.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone',
229  // 's.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode',
230  // 's.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.facnumber'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",
231  // 'f.datef'=>"DateInvoice",'f.total'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus',
232  // 'f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",
233  // 'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",
234  // 'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef'
235  //);
236  // $this->export_entities_array[$r]=array(
237  // 's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company',
238  // 's.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company',
239  // 'f.rowid'=>"invoice",'f.facnumber'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total'=>"invoice",'f.total_ttc'=>"invoice",'f.tva'=>"invoice",
240  // 'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",'fd.price'=>"invoice_line",
241  // 'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",'fd.qty'=>"invoice_line",
242  // 'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product'
243  //);
244  // $this->export_alias_array[$r]=array(
245  // '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',
246  // 's.siren'=>'soc_siren','s.siret'=>'soc_siret','s.ape'=>'soc_ape','s.idprof4'=>'soc_idprof4','s.code_compta'=>'soc_customer_accountancy',
247  // 's.code_compta_fournisseur'=>'soc_supplier_accountancy','f.rowid'=>"invoiceid",'f.facnumber'=>"ref",'f.datec'=>"datecreation",'f.datef'=>"dateinvoice",
248  // 'f.total'=>"totalht",'f.total_ttc'=>"totalttc",'f.tva'=>"totalvat",'f.paye'=>"paid",'f.fk_statut'=>'status','f.note'=>"note",'fd.rowid'=>'lineid',
249  // 'fd.description'=>"linedescription",'fd.price'=>"lineprice",'fd.total_ht'=>"linetotalht",'fd.total_tva'=>"linetotaltva",'fd.total_ttc'=>"linetotalttc",
250  // 'fd.tva_tx'=>"linevatrate",'fd.qty'=>"lineqty",'fd.date_start'=>"linedatestart",'fd.date_end'=>"linedateend",'fd.fk_product'=>'productid',
251  // 'p.ref'=>'productref'
252  //);
253  // $this->export_sql_start[$r]='SELECT DISTINCT ';
254  // $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
255  // $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
256  // $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
257  // $r++;
258  }
259 }
260 
Class DolibarrModules.
</td >< td class="liste_titre" align="right"></td ></tr >< tr class="liste_titre">< input type="checkbox" onClick="toggle(this)"/> Ref p ref Label p label Duration p duration warehouseinternal SELECT description FROM product_lang WHERE qty< br > qty qty qty StockTooLow img yes disabled img no img no< tr class="oddeven">< td >< input type="checkbox" class="check" name="' . $i . '"' . $disabled . '></td >< td >< input type="checkbox" class="check" name="choose'.$i.'"></td >< td class="nowrap"></td >< td >< input type="hidden" name="desc' . $i . '" value="' . dol_escape_htmltag($objp-> description
Only used if Module[ID]Desc translation string is not found.
Definition: replenish.php:573
Description and activation class for module holiday.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:103
__construct($db)
Constructor.