dolibarr  7.0.0-beta
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  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  */
18 
26 include_once(DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php");
27 
28 
33 {
39  function __construct($db)
40  {
41  global $conf;
42 
43  $this->db = $db;
44  $this->numero = 770;
45 
46  $this->family = "hr";
47  $this->module_position = 40;
48  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
49  $this->name = preg_replace('/^mod/i','',get_class($this));
50  // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
51  $this->description = "Manage and claim expense reports (transportation, meal, ...)";
52  $this->version = 'dolibarr';
53  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
54  $this->special = 0;
55  $this->picto='trip';
56 
57  // Data directories to create when module is enabled.
58  $this->dirs = array("/expensereport/temp");
59  $r=0;
60 
61  // Config pages. Put here list of php page names stored in admmin directory used to setup module.
62  $this->config_page_url = array('expensereport.php');
63 
64  // Dependencies
65  $this->depends = array(); // List of modules id that must be enabled if this module is enabled
66  // $this->conflictwith = array("modDeplacement"); // Deactivate for access on old information
67  $this->requiredby = array(); // List of modules id to disable if this one is disabled
68  $this->phpmin = array(4,3); // Minimum version of PHP required by module
69  $this->need_dolibarr_version = array(3,7); // Minimum version of Dolibarr required by module
70  $this->langfiles = array("companies","trips");
71 
72  // Constants
73  $this->const = array(); // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 0 or 'allentities')
74  $r=0;
75 
76  $this->const[$r][0] = "EXPENSEREPORT_ADDON_PDF";
77  $this->const[$r][1] = "chaine";
78  $this->const[$r][2] = "standard";
79  $this->const[$r][3] = 'Name of manager to build PDF expense reports documents';
80  $this->const[$r][4] = 0;
81  $r++;
82 
83  $this->const[$r][0] = "EXPENSEREPORT_ADDON";
84  $this->const[$r][1] = "chaine";
85  $this->const[$r][2] = "mod_expensereport_jade";
86  $this->const[$r][3] = 'Name of manager to generate expense report ref number';
87  $this->const[$r][4] = 0;
88  $r++;
89 
90  $this->const[$r][0] = "MAIN_DELAY_EXPENSEREPORTS";
91  $this->const[$r][1] = "chaine";
92  $this->const[$r][2] = "15";
93  $this->const[$r][3] = 'Tolerance delay (in days) before alert for expense reports to approve';
94  $this->const[$r][4] = 0;
95  $r++;
96 
97  $this->const[$r][0] = "MAIN_DELAY_EXPENSEREPORTS_TO_PAY";
98  $this->const[$r][1] = "chaine";
99  $this->const[$r][2] = "15";
100  $this->const[$r][3] = 'Tolerance delay (in days) before alert for expense reports to pay';
101  $this->const[$r][4] = 0;
102  $r++;
103 
104  // Array to add new pages in new tabs
105  $this->tabs[] = array('data'=>'user:+expensereport:ExpenseReport:expensereport:$user->rights->expensereport->lire:/expensereport/list.php?mainmenu=hrm&id=__ID__'); // To add a new tab identified by code tabname1
106 
107  // Boxes
108  $this->boxes = array(); // List of boxes
109  $r=0;
110 
111  // Permissions
112  $this->rights = array(); // Permission array used by this module
113  $this->rights_class = 'expensereport';
114 
115  $this->rights[$r][0] = 771;
116  $this->rights[$r][1] = 'Read expense reports (yours and your subordinates)';
117  $this->rights[$r][2] = 'r';
118  $this->rights[$r][3] = 0;
119  $this->rights[$r][4] = 'lire';
120  $r++;
121 
122  $this->rights[$r][0] = 772;
123  $this->rights[$r][1] = 'Create/modify expense reports';
124  $this->rights[$r][2] = 'w';
125  $this->rights[$r][3] = 0;
126  $this->rights[$r][4] = 'creer';
127  $r++;
128 
129  $this->rights[$r][0] = 773;
130  $this->rights[$r][1] = 'Delete expense reports';
131  $this->rights[$r][2] = 'd';
132  $this->rights[$r][3] = 0;
133  $this->rights[$r][4] = 'supprimer';
134  $r++;
135 
136  $this->rights[$r][0] = 775;
137  $this->rights[$r][1] = 'Approve expense reports';
138  $this->rights[$r][2] = 'w';
139  $this->rights[$r][3] = 0;
140  $this->rights[$r][4] = 'approve';
141  $r++;
142 
143  $this->rights[$r][0] = 776;
144  $this->rights[$r][1] = 'Pay expense reports';
145  $this->rights[$r][2] = 'w';
146  $this->rights[$r][3] = 0;
147  $this->rights[$r][4] = 'to_paid';
148  $r++;
149 
150  $this->rights[$r][0] = 777;
151  $this->rights[$r][1] = 'Read expense reports of everybody';
152  $this->rights[$r][2] = 'r';
153  $this->rights[$r][3] = 1;
154  $this->rights[$r][4] = 'readall';
155  $r++;
156 
157  $this->rights[$r][0] = 778;
158  $this->rights[$r][1] = 'Create expense reports for everybody';
159  $this->rights[$r][2] = 'w';
160  $this->rights[$r][3] = 0;
161  $this->rights[$r][4] = 'writeall_advance';
162  $r++;
163 
164  $this->rights[$r][0] = 779;
165  $this->rights[$r][1] = 'Export expense reports';
166  $this->rights[$r][2] = 'r';
167  $this->rights[$r][3] = 0;
168  $this->rights[$r][4] = 'export';
169  $r++;
170 
171  // Menus
172  //-------
173  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
174 
175  // Exports
176  $r=0;
177 
178  $r++;
179  $this->export_code[$r]='expensereport_'.$r;
180  $this->export_label[$r]='ListTripsAndExpenses';
181  $this->export_icon[$r]='trip';
182  $this->export_permission[$r]=array(array("expensereport","export"));
183  $this->export_fields_array[$r]=array('d.rowid'=>"TripId",'d.ref'=>'Ref','d.date_debut'=>'DateStart','d.date_fin'=>'DateEnd','d.date_create'=>'DateCreation','d.date_approve'=>'DateApprove','d.total_ht'=>"TotalHT",'d.total_tva'=>'TotalVAT','d.total_ttc'=>'TotalTTC','d.note_private'=>'NotePrivate','d.note_public'=>'NotePublic','u.lastname'=>'Lastname','u.firstname'=>'Firstname','u.login'=>"Login",'ed.rowid'=>'LineId','tf.code'=>'Type','ed.date'=>'Date','ed.tva_tx'=>'VATRate','ed.total_ht'=>'TotalHT','ed.total_tva'=>'TotalVAT','ed.total_ttc'=>'TotalTTC','ed.comments'=>'Comment','p.rowid'=>'ProjectId','p.ref'=>'Ref');
184  $this->export_entities_array[$r]=array('u.lastname'=>'user','u.firstname'=>'user','u.login'=>'user','ed.rowid'=>'expensereport_line','ed.date'=>'expensereport_line','ed.tva_tx'=>'expensereport_line','ed.total_ht'=>'expensereport_line','ed.total_tva'=>'expensereport_line','ed.total_ttc'=>'expensereport_line','ed.comments'=>'expensereport_line','tf.code'=>'expensereport_line','p.project_ref'=>'expensereport_line','p.rowid'=>'project','p.ref'=>'project');
185  $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');
186  $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
187 
188  $this->export_sql_start[$r]='SELECT DISTINCT ';
189  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'expensereport as d, '.MAIN_DB_PREFIX.'user as u,';
190  $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';
191  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'projet as p ON ed.fk_projet = p.rowid';
192  $this->export_sql_end[$r] .=' WHERE ed.fk_expensereport = d.rowid AND d.fk_user_author = u.rowid';
193  $this->export_sql_end[$r] .=' AND d.entity IN ('.getEntity('expensereport').')';
194  }
195 
204  function init($options='')
205  {
206  global $conf;
207 
208  // Remove permissions and default values
209  $this->remove($options);
210 
211  $sql = array(
212  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard' AND type='expensereport' AND entity = ".$conf->entity,
213  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard','expensereport',".$conf->entity.")"
214  );
215 
216  return $this->_init($sql,$options);
217  }
218 }
Class DolibarrModules.
</td >< tdclass="liste_titre"align="right"></td ></tr >< trclass="liste_titre">< inputtype="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< trclass="oddeven">< td >< inputtype="checkbox"class="check"name="'.$i.'"'.$disabled.'></td >< td >< inputtype="checkbox"class="check"name="choose'.$i.'"></td >< tdclass="nowrap"></td >< td >< inputtype="hidden"name="desc'.$i.'"value="'.dol_escape_htmltag($objp-> description
Only used if Module[ID]Desc translation string is not found.
Definition: replenish.php:554
Description and activation class for module ExpenseReport.
init($options='')
Function called when module is enabled.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:104
_init($array_sql, $options='')
Enables a module.
__construct($db)
Constructor.