dolibarr 25.0.0-alpha
modExpenseReport.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2011 Dimitri Mouillard <dmouillard@teclib.com>
3 * Copyright (C) 2015 Laurent Destailleur <eldy@users.sourceforge.net>
4 * Copyright (C) 2023 Alexandre Spangaro <aspangaro@easya.solutions>
5 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
6 * Copyright (C) 2024-2026 Frédéric France <frederic.france@free.fr>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
29include_once DOL_DOCUMENT_ROOT."/core/modules/DolibarrModules.class.php";
30
31
36{
42 public function __construct($db)
43 {
44 global $conf, $user; // Required by the extrafieldsinexport.inc.php
45
46 $this->db = $db;
47 $this->numero = 770;
48
49 $this->family = "hr";
50 $this->module_position = '42';
51 // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
52 $this->name = preg_replace('/^mod/i', '', get_class($this));
53 // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
54 $this->description = "Manage and claim expense reports (transportation, meal, ...)";
55 $this->version = 'dolibarr';
56 $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
57 $this->picto = 'trip';
58
59 // Data directories to create when module is enabled.
60 $this->dirs = ["/expensereport/temp"];
61
62 // Config pages. Put here list of php page names stored in admmin directory used to setup module.
63 $this->config_page_url = ['expensereport.php'];
64
65 // Dependencies
66 $this->hidden = false; // A condition to hide module
67 $this->depends = []; // List of module class names as string that must be enabled if this module is enabled
68 $this->requiredby = []; // List of modules id to disable if this one is disabled
69 $this->langfiles = ["companies", "trips"];
70
71 // Constants
72 $this->const = [ // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 0 or 'allentities')
73 [
74 "EXPENSEREPORT_ADDON_PDF",
75 "chaine",
76 "standard",
77 'Name of manager to build PDF expense reports documents',
78 0,
79 ],
80 [
81 "EXPENSEREPORT_ADDON",
82 "chaine",
83 "mod_expensereport_jade",
84 'Name of manager to generate expense report ref number',
85 0,
86 ],
87 [
88 "MAIN_DELAY_EXPENSEREPORTS",
89 "chaine",
90 "15",
91 'Tolerance delay (in days) before alert for expense reports to approve',
92 0,
93 ],
94 [
95 "MAIN_DELAY_EXPENSEREPORTS_TO_PAY",
96 "chaine",
97 "15",
98 'Tolerance delay (in days) before alert for expense reports to pay',
99 0,
100 ],
101 ];
102
103 // Array to add new pages in new tabs
104 $this->tabs[] = [];
105
106 // Boxes
107 $this->boxes = [
108 ['file' => 'box_expensereports_to_approve.php', 'enabledbydefaulton' => 'Home'],
109 ];
110 $r = 0;
111
112 // Permissions
113 $this->rights = []; // Permission array used by this module
114 $this->rights_class = 'expensereport';
115
116 $this->rights[$r][0] = 771;
117 $this->rights[$r][1] = 'Read expense reports (yours and your subordinates)';
118 $this->rights[$r][2] = 'r';
119 $this->rights[$r][3] = 0;
120 $this->rights[$r][4] = 'lire';
121 $r++;
122
123 $this->rights[$r][0] = 772;
124 $this->rights[$r][1] = 'Create/modify expense reports';
125 $this->rights[$r][2] = 'w';
126 $this->rights[$r][3] = 0;
127 $this->rights[$r][4] = 'creer';
128 $r++;
129
130 $this->rights[$r][0] = 773;
131 $this->rights[$r][1] = 'Delete expense reports';
132 $this->rights[$r][2] = 'd';
133 $this->rights[$r][3] = 0;
134 $this->rights[$r][4] = 'supprimer';
135 $r++;
136
137 $this->rights[$r][0] = 775;
138 $this->rights[$r][1] = 'Approve expense reports';
139 $this->rights[$r][2] = 'w';
140 $this->rights[$r][3] = 0;
141 $this->rights[$r][4] = 'approve';
142 $r++;
143
144 $this->rights[$r][0] = 776;
145 $this->rights[$r][1] = 'Pay expense reports';
146 $this->rights[$r][2] = 'w';
147 $this->rights[$r][3] = 0;
148 $this->rights[$r][4] = 'to_paid';
149 $r++;
150
151 $this->rights[$r][0] = 777;
152 $this->rights[$r][1] = 'Read expense reports of everybody';
153 $this->rights[$r][2] = 'r';
154 $this->rights[$r][3] = 0;
155 $this->rights[$r][4] = 'readall';
156 $r++;
157
158 $this->rights[$r][0] = 778;
159 $this->rights[$r][1] = 'Create expense reports for everybody';
160 $this->rights[$r][2] = 'w';
161 $this->rights[$r][3] = 0;
162 $this->rights[$r][4] = 'writeall_advance';
163 $r++;
164
165 $this->rights[$r][0] = 779;
166 $this->rights[$r][1] = 'Export expense reports';
167 $this->rights[$r][2] = 'r';
168 $this->rights[$r][3] = 0;
169 $this->rights[$r][4] = 'export';
170 $r++;
171
172 // Menus
173 //-------
174 $this->menu = 1; // This module add menu entries. They are coded into menu manager.
175
176 // Exports
177 $r = 0;
178
179 $r++;
180 $this->export_code[$r] = 'expensereport_'.$r;
181 $this->export_label[$r] = 'ListTripsAndExpenses';
182 $this->export_icon[$r] = 'trip';
183 $this->export_permission[$r] = array(array("expensereport", "export"));
184 $this->export_fields_array[$r] = array(
185 'd.rowid' => "TripId", 'd.ref' => 'Ref', 'd.date_debut' => 'DateStart', 'd.date_fin' => 'DateEnd', 'd.date_create' => 'DateCreation', 'd.date_approve' => 'DateApprove',
186 'd.total_ht' => "TotalHT", 'd.total_tva' => 'TotalVAT', 'd.total_ttc' => 'TotalTTC',
187 'd.fk_statut' => 'Status', 'd.paid' => 'Paid',
188 'd.note_private' => 'NotePrivate', 'd.note_public' => 'NotePublic', 'd.detail_cancel' => 'MOTIF_CANCEL', 'd.detail_refuse' => 'MOTIF_REFUS',
189 'ed.rowid' => 'LineId', 'tf.code' => 'Type', 'ed.date' => 'Date', 'ed.tva_tx' => 'VATRate',
190 'ed.qty' => "Quantity", 'ed.value_unit' => "UnitPriceHT",
191 'ed.total_ht' => 'TotalHT', 'ed.total_tva' => 'TotalVAT', 'ed.total_ttc' => 'TotalTTC', 'ed.comments' => 'Comment', 'p.rowid' => 'ProjectId', 'p.ref' => 'Ref',
192 'u.lastname' => 'Lastname', 'u.firstname' => 'Firstname', 'u.login' => "Login",
193 'user_rib.iban_prefix' => 'IBAN', 'user_rib.bic' => 'BIC', 'user_rib.code_banque' => 'BankCode', 'user_rib.bank' => 'BankName', 'user_rib.proprio' => 'BankAccountOwner',
194 'user_rib.owner_address' => 'BankAccountOwnerAddress'
195 );
196 $this->export_TypeFields_array[$r] = array(
197 'd.rowid' => 'Numeric', 'd.ref' => 'Text', 'd.date_debut' => 'Date', 'd.date_fin' => 'Date', 'd.date_create' => 'Date', 'd.date_approve' => 'Date',
198 'd.total_ht' => "Numeric", 'd.total_tva' => 'Numeric', 'd.total_ttc' => 'Numeric',
199 'd.fk_statut' => "Numeric", 'd.paid' => 'Numeric',
200 'd.note_private' => 'Text', 'd.note_public' => 'Text', 'd.detail_cancel' => 'Text', 'd.detail_refuse' => 'Text',
201 'ed.rowid' => 'Numeric', 'tf.code' => 'Code', 'ed.date' => 'Date', 'ed.tva_tx' => 'Numeric',
202 'ed.qty' => 'Numeric', 'ed.value_unit' => 'Numeric',
203 'ed.total_ht' => 'Numeric', 'ed.total_tva' => 'Numeric', 'ed.total_ttc' => 'Numeric', 'ed.comments' => 'Text', 'p.rowid' => 'Numeric', 'p.ref' => 'Text',
204 'u.lastname' => 'Text', 'u.firstname' => 'Text', 'u.login' => "Text",
205 'user_rib.iban_prefix' => 'Text', 'user_rib.bic' => 'Text', 'user_rib.code_banque' => 'Text', 'user_rib.bank' => 'Text', 'user_rib.proprio' => 'Text',
206 'user_rib.owner_address' => 'Text'
207 );
208 $this->export_entities_array[$r] = array(
209 'ed.rowid' => 'expensereport_line', 'ed.date' => 'expensereport_line',
210 'ed.qty' => 'expensereport_line', 'ed.value_unit' => 'expensereport_line',
211 'ed.tva_tx' => 'expensereport_line', 'ed.total_ht' => 'expensereport_line', 'ed.total_tva' => 'expensereport_line', 'ed.total_ttc' => 'expensereport_line',
212 'ed.comments' => 'expensereport_line', 'tf.code' => 'expensereport_line', 'p.project_ref' => 'expensereport_line', 'p.rowid' => 'project', 'p.ref' => 'project',
213 'u.lastname' => 'user', 'u.firstname' => 'user', 'u.login' => 'user',
214 'user_rib.iban_prefix' => 'user', 'user_rib.bic' => 'user', 'user_rib.code_banque' => 'user', 'user_rib.bank' => 'user', 'user_rib.proprio' => 'user',
215 'user_rib.owner_address' => 'user'
216
217 );
218 //$this->export_alias_array[$r] = array('d.rowid'=>"idtrip", 'd.type'=>"type", 'd.note_private'=>'note_private', 'd.note_public'=>'note_public', 'u.lastname'=>'name', 'u.firstname'=>'firstname', 'u.login'=>'login');
219 $this->export_dependencies_array[$r] = array('expensereport_line' => 'ed.rowid', 'type_fees' => 'tf.rowid'); // To add unique key if we ask a field of a child to avoid the DISTINCT to discard them
220
221 $keyforselect = 'expensereport';
222 $keyforelement = 'expensereport';
223 $keyforaliasextra = 'extra';
224 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
225 $keyforselect = 'user';
226 $keyforelement = 'user';
227 $keyforaliasextra = 'extrau';
228 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
229
230 $this->export_sql_start[$r] = 'SELECT DISTINCT ';
231 $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'expensereport as d';
232 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'expensereport_extrafields as extra on d.rowid = extra.fk_object';
233 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'user_rib as user_rib ON user_rib.fk_user = d.fk_user_author,';
234 $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'user as u';
235 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'user_extrafields as extrau ON u.rowid = extrau.fk_object,';
236 $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'expensereport_det as ed LEFT JOIN '.MAIN_DB_PREFIX.'c_type_fees as tf ON ed.fk_c_type_fees = tf.id';
237 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'projet as p ON ed.fk_projet = p.rowid';
238 $this->export_sql_end[$r] .= ' WHERE ed.fk_expensereport = d.rowid AND d.fk_user_author = u.rowid';
239 $this->export_sql_end[$r] .= ' AND d.entity IN ('.getEntity('expensereport').')';
240 if (is_object($user) && !$user->hasRight('expensereport', 'readall') && !$user->hasRight('expensereport', 'lire_tous')
241 && (!getDolGlobalString('MAIN_USE_ADVANCED_PERMS') || !$user->hasRight('expensereport', 'writeall_advance'))) {
242 $childids = $user->getAllChildIds(1);
243 $this->export_sql_end[$r] .= ' AND d.fk_user_author IN ('.$this->db->sanitize(implode(',', $childids)).')';
244 }
245 }
246
255 public function init($options = '')
256 {
257 global $conf;
258
259 $result = $this->_load_tables('/install/mysql/', 'expensereport');
260 if ($result < 0) {
261 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')
262 }
263
264 // Remove permissions and default values
265 $this->remove($options);
266
267 $sql = [
268 "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_expensereport' AND type='expensereport' AND entity = ".((int) $conf->entity),
269 "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_expensereport','expensereport',".((int) $conf->entity).")"
270 ];
271
272 return $this->_init($sql, $options);
273 }
274}
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
_load_tables($reldir, $onlywithsuffix='')
Create tables and keys required by module:
Description and activation class for module ExpenseReport.
__construct($db)
Constructor.
init($options='')
Function called when module is enabled.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
$conf browser version
Definition main.inc.php:229
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:165