dolibarr 20.0.0
modSalaries.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3 * Copyright (C) 2004-2014 Laurent Destailleur <eldy@users.sourceforge.net>
4 * Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
5 * Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
6 * Copyright (C) 2005-2012 Regis Houssin <regis.houssin@inodbox.com>
7 * Copyright (C) 2014 Juanjo Menent <jmenent@2byte.es>
8 * Copyright (C) 2014-2019 Alexandre Spangaro <aspangaro@open-dsi.fr>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 * or see https://www.gnu.org/
23 */
24
32include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
33
34
39{
45 public function __construct($db)
46 {
47 global $conf;
48
49 $this->db = $db;
50 $this->numero = 510; // Perms from 501..519
51
52 // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
53 // It is used to group modules by family in module setup page
54 $this->family = "financial";
55 // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
56 $this->name = preg_replace('/^mod/i', '', get_class($this));
57 // Module description used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
58 $this->description = "Payment of salaries";
59
60 // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
61 $this->version = 'dolibarr';
62
63 $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
64 $this->picto = 'payment';
65
66 // Data directories to create when module is enabled
67 $this->dirs = array("/salaries/temp");
68
69 // Config pages
70 $this->config_page_url = array('salaries.php@salaries');
71
72 // Dependencies
73 $this->hidden = false; // A condition to hide module
74 $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
75 $this->requiredby = array(); // List of module ids to disable if this one is disabled
76 $this->conflictwith = array(); // List of module class names as string this module is in conflict with
77 $this->phpmin = array(7, 0); // Minimum version of PHP required by module
78 $this->langfiles = array("salaries", "bills");
79
80 // Constants
81 $this->const = array();
82 $this->const[0] = array(
83 "SALARIES_ACCOUNTING_ACCOUNT_PAYMENT",
84 "chaine",
85 "421"
86 );
87 $this->const[1] = array(
88 "SALARIES_ACCOUNTING_ACCOUNT_CHARGE",
89 "chaine",
90 "641"
91 );
92
93 // Boxes
94 $this->boxes = array();
95
96 // Permissions
97 $this->rights = array();
98 $this->rights_class = 'salaries';
99 $r = 0;
100
101 $r++;
102 $this->rights[$r][0] = 511;
103 $this->rights[$r][1] = 'Read employee salaries and payments (yours and your subordinates)';
104 $this->rights[$r][2] = 'r';
105 $this->rights[$r][3] = 0;
106 $this->rights[$r][4] = 'read';
107 $this->rights[$r][5] = '';
108
109 $r++;
110 $this->rights[$r][0] = 512;
111 $this->rights[$r][1] = 'Create/modify payments of empoyee salaries';
112 $this->rights[$r][2] = 'w';
113 $this->rights[$r][3] = 0;
114 $this->rights[$r][4] = 'write';
115 $this->rights[$r][5] = '';
116
117 $r++;
118 $this->rights[$r][0] = 514;
119 $this->rights[$r][1] = 'Delete payments of employee salary';
120 $this->rights[$r][2] = 'd';
121 $this->rights[$r][3] = 0;
122 $this->rights[$r][4] = 'delete';
123 $this->rights[$r][5] = '';
124
125 $r++;
126 $this->rights[$r][0] = 517;
127 $this->rights[$r][1] = 'Read salaries and payments of all employees';
128 $this->rights[$r][2] = 'r';
129 $this->rights[$r][3] = 0;
130 $this->rights[$r][4] = 'readall';
131
132 $r++;
133 $this->rights[$r][0] = 519;
134 $this->rights[$r][1] = 'Export payments of employee salaries';
135 $this->rights[$r][2] = 'r';
136 $this->rights[$r][3] = 0;
137 $this->rights[$r][4] = 'export';
138 $this->rights[$r][5] = '';
139
140
141
142 // Menus
143 //-------
144 $this->menu = 1; // This module add menu entries. They are coded into menu manager.
145
146
147 // Exports
148 //--------
149 $r = 0;
150
151 $r++;
152 $this->export_code[$r] = $this->rights_class.'_'.$r;
153 $this->export_label[$r] = 'SalariesAndPayments';
154 $this->export_permission[$r] = array(array("salaries", "export"));
155 $this->export_fields_array[$r] = array('u.firstname'=>"Firstname", 'u.lastname'=>"Lastname", 'u.login'=>"Login", 'u.salary'=>'CurrentSalary', 'p.datep'=>'DatePayment', 'p.datesp'=>'DateStartPeriod', 'p.dateep'=>'DateEndPeriod', 'p.amount'=>'AmountPayment', 'p.num_payment'=>'Numero', 'p.label'=>'Label', 'p.note'=>'Note');
156 $this->export_TypeFields_array[$r] = array('u.firstname'=>"Text", 'u.lastname'=>"Text", 'u.login'=>'Text', 'u.salary'=>"Numeric", 'p.datep'=>'Date', 'p.datesp'=>'Date', 'p.dateep'=>'Date', 'p.amount'=>'Numeric', 'p.num_payment'=>'Numeric', 'p.label'=>'Text');
157 $this->export_entities_array[$r] = array('u.firstname'=>'user', 'u.lastname'=>'user', 'u.login'=>'user', 'u.salary'=>'user', 'p.datep'=>'payment', 'p.datesp'=>'payment', 'p.dateep'=>'payment', 'p.amount'=>'payment', 'p.label'=>'payment', 'p.note'=>'payment', 'p.num_payment'=>'payment');
158
159 $this->export_sql_start[$r] = 'SELECT DISTINCT ';
160 $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'user as u';
161 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'payment_salary as p ON p.fk_user = u.rowid';
162 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_paiement as cp ON p.fk_typepayment = cp.id';
163 $this->export_sql_end[$r] .= ' AND u.entity IN ('.getEntity('user').')';
164 }
165
166
175 public function init($options = '')
176 {
177 global $conf;
178
179 // Clean before activation
180 $this->remove($options);
181
182 $sql = array();
183
184 return $this->_init($sql, $options);
185 }
186}
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
Class to manage salaries module.
__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.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:140