dolibarr  17.0.4
modTax.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2012 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  *
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  * or see https://www.gnu.org/
21  */
22 
30 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
31 
32 
36 class modTax extends DolibarrModules
37 {
38 
44  public function __construct($db)
45  {
46  global $conf;
47 
48  $this->db = $db;
49  $this->numero = 500;
50 
51  $this->family = "financial";
52  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
53  $this->name = preg_replace('/^mod/i', '', get_class($this));
54  // Module description used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
55  $this->description = "Gestion des taxes, charges sociales et dividendes";
56 
57  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
58  $this->version = 'dolibarr';
59 
60  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
61  $this->picto = 'bill';
62 
63  // Data directories to create when module is enabled
64  $this->dirs = array("/tax/temp");
65 
66  // Config pages
67  $this->config_page_url = array("taxes.php");
68 
69  // Dependencies
70  $this->hidden = false; // A condition to hide module
71  $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
72  $this->requiredby = array(); // List of module ids to disable if this one is disabled
73  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
74  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
75  $this->langfiles = array("compta", "bills");
76 
77  // Constants
78  $this->const = array();
79 
80  // Boxes
81  $this->boxes = array();
82 
83  // Permissions
84  $this->rights = array();
85  $this->rights_class = 'tax';
86  $r = 0;
87 
88  $r++;
89  $this->rights[$r][0] = 91;
90  $this->rights[$r][1] = 'Lire les charges';
91  $this->rights[$r][2] = 'r';
92  $this->rights[$r][3] = 0;
93  $this->rights[$r][4] = 'charges';
94  $this->rights[$r][5] = 'lire';
95 
96  $r++;
97  $this->rights[$r][0] = 92;
98  $this->rights[$r][1] = 'Creer/modifier les charges';
99  $this->rights[$r][2] = 'w';
100  $this->rights[$r][3] = 0;
101  $this->rights[$r][4] = 'charges';
102  $this->rights[$r][5] = 'creer';
103 
104  $r++;
105  $this->rights[$r][0] = 93;
106  $this->rights[$r][1] = 'Supprimer les charges';
107  $this->rights[$r][2] = 'd';
108  $this->rights[$r][3] = 0;
109  $this->rights[$r][4] = 'charges';
110  $this->rights[$r][5] = 'supprimer';
111 
112  $r++;
113  $this->rights[$r][0] = 94;
114  $this->rights[$r][1] = 'Exporter les charges';
115  $this->rights[$r][2] = 'r';
116  $this->rights[$r][3] = 0;
117  $this->rights[$r][4] = 'charges';
118  $this->rights[$r][5] = 'export';
119 
120 
121  // Menus
122  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
123 
124 
125  // Exports
126  $r = 0;
127 
128  $r++;
129  $this->export_code[$r] = $this->rights_class.'_'.$r;
130  $this->export_label[$r] = 'Taxes et charges sociales, et leurs reglements';
131  $this->export_permission[$r] = array(array("tax", "charges", "export"));
132  $this->export_fields_array[$r] = array('cc.libelle'=>"Type", 'c.rowid'=>"IdSocialContribution", 'c.libelle'=>"Label", 'c.date_ech'=>'DateDue', 'c.periode'=>'Period', 'c.amount'=>"AmountExpected", "c.paye"=>"Status", 'p.rowid'=>'PaymentId', 'p.datep'=>'DatePayment', 'p.amount'=>'AmountPayment', 'p.num_paiement'=>'Numero');
133  $this->export_TypeFields_array[$r] = array('cc.libelle'=>"List:c_chargesociales:libelle:id", 'c.libelle'=>"Text", 'c.date_ech'=>'Date', 'c.periode'=>'Period', 'c.amount'=>"Numeric", "c.paye"=>"Boolean", 'p.datep'=>'Date', 'p.amount'=>'Numeric', 'p.num_paiement'=>'Numeric');
134  $this->export_entities_array[$r] = array('cc.libelle'=>"tax_type", 'c.rowid'=>"tax", 'c.libelle'=>'tax', 'c.date_ech'=>'tax', 'c.periode'=>'tax', 'c.amount'=>"tax", "c.paye"=>"tax", 'p.rowid'=>'payment', 'p.datep'=>'payment', 'p.amount'=>'payment', 'p.num_paiement'=>'payment');
135 
136  $this->export_sql_start[$r] = 'SELECT DISTINCT ';
137  $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'c_chargesociales as cc, '.MAIN_DB_PREFIX.'chargesociales as c';
138  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'paiementcharge as p ON p.fk_charge = c.rowid';
139  $this->export_sql_end[$r] .= ' WHERE c.fk_type = cc.id';
140  $this->export_sql_end[$r] .= ' AND c.entity IN ('.getEntity('tax').')';
141 
142  // Import social contributions
143  $r++;
144  $this->import_code[$r] = $this->rights_class.'_'.$r;
145  $this->import_label[$r] = "ImportDataset_tax_contrib"; // Translation key
146  $this->import_icon[$r] = 'tax';
147  $this->import_entities_array[$r] = array(); // We define here only fields that use another icon that the one defined into import_icon
148  $this->import_tables_array[$r] = array('t'=>MAIN_DB_PREFIX.'chargesociales');
149  $this->import_fields_array[$r] = array('t.libelle'=>"Label*", 't.fk_type'=>"Type",
150  't.amount'=>"Amount*", 't.date_ech'=>"DateDue*", 't.periode'=>"PeriodEndDate*"
151  );
152 
153  $this->import_convertvalue_array[$r] = array(
154  't.fk_type'=>array('rule'=>'fetchidfromref', 'classfile'=>'/compta/sociales/class/cchargesociales.class.php', 'class'=>'Cchargesociales', 'method'=>'fetch', 'element'=>'Cchargesociales')
155  );
156  $this->import_examplevalues_array[$r] = array('t.libelle'=>"Social/fiscal contribution", 't.fk_type'=>"TAXPRO (must be id or code found into dictionary)",
157  't.date_ech'=>"2016-01-01", 't.periode'=>"2016-01-01"
158  );
159 
160  // Import Taxes
161  $r++;
162  $this->import_code[$r] = $this->rights_class.'_'.$r;
163  $this->import_label[$r] = "ImportDataset_tax_vat"; // Translation key
164  $this->import_icon[$r] = 'tax';
165  $this->import_entities_array[$r] = array(); // We define here only fields that use another icon that the one defined into import_icon
166  $this->import_tables_array[$r] = array('t'=>MAIN_DB_PREFIX.'tva');
167  $this->import_fields_array[$r] = array('t.datep'=>"DatePayment*", 't.datev'=>"DateValue*", 't.label'=>"Label*", 't.fk_typepayment'=>"PaymentMode*",
168  't.amount'=>"Amount*", 't.num_payment'=>'Numero'
169  );
170 
171  $this->import_convertvalue_array[$r] = array(
172  't.fk_typepayment'=>array('rule'=>'fetchidfromref', 'classfile'=>'/compta/paiement/class/cpaiement.class.php', 'class'=>'Cpaiement', 'method'=>'fetch', 'element'=>'Cpaiement')
173  );
174  $this->import_examplevalues_array[$r] = array('t.label'=>"VAT Payment 1st quarter 2016", 't.fk_typepayment'=>"CHQ (must be id or code found into dictionary)",
175  't.datep'=>"2016-04-02", 't.datev'=>"2016-03-31", 't.amount'=>1000, 't.num_payment'=>'123456'
176  );
177  }
178 
179 
188  public function init($options = '')
189  {
190  global $conf;
191 
192  // Nettoyage avant activation
193  $this->remove($options);
194 
195  $sql = array();
196 
197  return $this->_init($sql, $options);
198  }
199 }
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
Class to describe and enable module Tax.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
print *****$script_file(".$version.") pid 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:122
$conf db
API class for accounts.
Definition: inc.php:41