dolibarr  19.0.0-dev
modContrat.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2005 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2014 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2005-2010 Regis Houssin <regis.houssin@inodbox.com>
5  * Copyright (C) 2011 Juanjo Menent <jmenent@2byte.es>
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <https://www.gnu.org/licenses/>.
18  */
19 
28 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
29 
30 
35 {
41  public function __construct($db)
42  {
43  global $conf, $langs;
44 
45  $this->db = $db;
46  $this->numero = 54;
47 
48  $this->family = "crm";
49  $this->module_position = '41';
50  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
51  $this->name = preg_replace('/^mod/i', '', get_class($this));
52  $this->description = "Gestion des contrats de services";
53 
54  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
55  $this->version = 'dolibarr';
56 
57  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
58  $this->picto = 'contract';
59 
60  // Data directories to create when module is enabled
61  $this->dirs = array("/contract/temp");
62 
63  // Dependencies
64  $this->depends = array("modSociete");
65  $this->requiredby = array();
66 
67  // Config pages
68  $this->config_page_url = array("contract.php");
69 
70  // Constants
71  $this->const = array();
72  $r = 0;
73 
74  $this->const[$r][0] = "CONTRACT_ADDON";
75  $this->const[$r][1] = "chaine";
76  $this->const[$r][2] = "mod_contract_serpis";
77  $this->const[$r][3] = 'Nom du gestionnaire de numerotation des contrats';
78  $this->const[$r][4] = 0;
79  $r++;
80 
81  $this->const[$r][0] = "CONTRACT_ADDON_PDF";
82  $this->const[$r][1] = "chaine";
83  $this->const[$r][2] = "strato";
84  $this->const[$r][3] = 'Name of PDF model of contract';
85  $this->const[$r][4] = 0;
86  $r++;
87 
88  $this->const[$r][0] = "CONTRACT_ADDON_PDF_ODT_PATH";
89  $this->const[$r][1] = "chaine";
90  $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/contracts";
91  $this->const[$r][3] = "";
92  $this->const[$r][4] = 0;
93  $r++;
94 
95  // Boxes
96  $this->boxes = array(
97  0=>array('file'=>'box_contracts.php', 'enabledbydefaulton'=>'Home'),
98  1=>array('file'=>'box_services_expired.php', 'enabledbydefaulton'=>'Home')
99  );
100 
101  // Permissions
102  $this->rights = array();
103  $this->rights_class = 'contrat';
104  $r = 0;
105 
106  $r++;
107  $this->rights[$r][0] = 161;
108  $this->rights[$r][1] = 'Lire les contrats';
109  $this->rights[$r][2] = 'r';
110  $this->rights[$r][3] = 0;
111  $this->rights[$r][4] = 'lire';
112 
113  $r++;
114  $this->rights[$r][0] = 162;
115  $this->rights[$r][1] = 'Creer / modifier les contrats';
116  $this->rights[$r][2] = 'w';
117  $this->rights[$r][3] = 0;
118  $this->rights[$r][4] = 'creer';
119 
120  $r++;
121  $this->rights[$r][0] = 163;
122  $this->rights[$r][1] = 'Activer un service d\'un contrat';
123  $this->rights[$r][2] = 'w';
124  $this->rights[$r][3] = 0;
125  $this->rights[$r][4] = 'activer';
126 
127  $r++;
128  $this->rights[$r][0] = 164;
129  $this->rights[$r][1] = 'Desactiver un service d\'un contrat';
130  $this->rights[$r][2] = 'w';
131  $this->rights[$r][3] = 0;
132  $this->rights[$r][4] = 'desactiver';
133 
134  $r++;
135  $this->rights[$r][0] = 165;
136  $this->rights[$r][1] = 'Supprimer un contrat';
137  $this->rights[$r][2] = 'd';
138  $this->rights[$r][3] = 0;
139  $this->rights[$r][4] = 'supprimer';
140 
141  $r++;
142  $this->rights[$r][0] = 167;
143  $this->rights[$r][1] = 'Export contracts';
144  $this->rights[$r][2] = 'r';
145  $this->rights[$r][3] = 0;
146  $this->rights[$r][4] = 'export';
147 
148 
149  // Menus
150  //-------
151  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
152 
153 
154  // Exports
155  //--------
156  $langs->load("contracts");
157 
158  $r = 1;
159 
160  $this->export_code[$r] = $this->rights_class.'_'.$r;
161  $this->export_label[$r] = 'ContractsAndLine'; // Translation key (used only if key ExportDataset_xxx_z not found)
162  $this->export_icon[$r] = 'contract';
163  $this->export_permission[$r] = array(array("contrat", "export"));
164  $this->export_fields_array[$r] = array('s.rowid'=>"IdCompany", 's.nom'=>'CompanyName', 's.address'=>'Address', 's.zip'=>'Zip', 's.town'=>'Town', 'c.code'=>'CountryCode',
165  's.email'=>'Email', 's.phone'=>'Phone', 's.siren'=>'ProfId1', 's.siret'=>'ProfId2', 's.ape'=>'ProfId3', 's.idprof4'=>'ProfId4', 's.code_compta'=>'CustomerAccountancyCode',
166  's.code_compta_fournisseur'=>'SupplierAccountancyCode', 's.tva_intra'=>'VATIntra',
167  'co.rowid'=>"Id", 'co.ref'=>"Ref", 'co.datec'=>"DateCreation", 'co.date_contrat'=>"DateContract",
168  'co.fin_validite'=>"ContractEndDate", 'co.date_cloture'=>"DateClosing", 'co.note_private'=>"NotePrivate", 'co.note_public'=>"NotePublic",
169  'cod.rowid'=>'LineId', 'cod.label'=>"LineLabel", 'cod.description'=>"LineDescription", 'cod.price_ht'=>"LineUnitPrice", 'cod.tva_tx'=>"LineVATRate",
170  'cod.qty'=>"LineQty", 'cod.total_ht'=>"LineTotalHT", 'cod.total_tva'=>"LineTotalVAT", 'cod.total_ttc'=>"LineTotalTTC",
171  'cod.date_ouverture'=>"DateStart", 'cod.date_ouverture_prevue'=>"DateStartPlanned", 'cod.date_fin_validite'=>"DateEndPlanned", 'cod.date_cloture'=>"DateEnd",
172  'p.rowid'=>'ProductId', 'p.ref'=>'ProductRef', 'p.label'=>'ProductLabel');
173 
174  $this->export_entities_array[$r] = array('s.rowid'=>"company", 's.nom'=>'company', 's.address'=>'company', 's.zip'=>'company',
175  's.town'=>'company', 'c.code'=>'company', 's.email'=>'company', 's.phone'=>'company', 's.siren'=>'company', 's.siret'=>'company', 's.ape'=>'company',
176  's.idprof4'=>'company', 's.code_compta'=>'company', 's.code_compta_fournisseur'=>'company', 's.tva_intra'=>'company',
177  'co.rowid'=>"contract", 'co.ref'=>"contract", 'co.datec'=>"contract", 'co.date_contrat'=>"contract",
178  'co.fin_validite'=>"contract", 'co.date_cloture'=>"contract", 'co.note_private'=>"contract", 'co.note_public'=>"contract",
179  'cod.rowid'=>'contract_line', 'cod.label'=>"contract_line", 'cod.description'=>"contract_line", 'cod.price_ht'=>"contract_line", 'cod.tva_tx'=>"contract_line",
180  'cod.qty'=>"contract_line", 'cod.total_ht'=>"contract_line", 'cod.total_tva'=>"contract_line", 'cod.total_ttc'=>"contract_line",
181  'cod.date_ouverture'=>"contract_line", 'cod.date_ouverture_prevue'=>"contract_line", 'cod.date_fin_validite'=>"contract_line", 'cod.date_cloture'=>"contract_line",
182  'p.rowid'=>'product', 'p.ref'=>'product', 'p.label'=>'product');
183 
184  $this->export_TypeFields_array[$r] = array('s.rowid'=>"Numeric", 's.nom'=>'Text', 's.address'=>'Text', 's.zip'=>'Text', 's.town'=>'Text', 'c.code'=>'Text',
185  's.email'=>'Text', 's.phone'=>'Text', 's.siren'=>'Text', 's.siret'=>'Text', 's.ape'=>'Text', 's.idprof4'=>'Text', 's.code_compta'=>'Text',
186  's.code_compta_fournisseur'=>'Text', 's.tva_intra'=>'Text',
187  'co.ref'=>"Text", 'co.datec'=>"Date", 'co.date_contrat'=>"Date",
188  'co.fin_validite'=>"Date", 'co.date_cloture'=>"Date", 'co.note_private'=>"Text", 'co.note_public'=>"Text",
189  'cod.label'=>"Text", 'cod.description'=>"Text", 'cod.price_ht'=>"Numeric", 'cod.tva_tx'=>"Numeric",
190  'cod.qty'=>"Numeric", 'cod.total_ht'=>"Numeric", 'cod.total_tva'=>"Numeric", 'cod.total_ttc'=>"Numeric",
191  'cod.date_ouverture'=>"Date", 'cod.date_ouverture_prevue'=>"Date", 'cod.date_fin_validite'=>"Date", 'cod.date_cloture'=>"Date",
192  'p.rowid'=>'List:product:label', 'p.ref'=>'Text', 'p.label'=>'Text');
193 
194 
195  $keyforselect = 'contrat';
196  $keyforelement = 'contract';
197  $keyforaliasextra = 'coextra';
198  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
199  $keyforselect = 'contratdet';
200  $keyforelement = 'contract_line';
201  $keyforaliasextra = 'codextra';
202  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
203 
204  $this->export_sql_start[$r] = 'SELECT DISTINCT ';
205  $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'societe as s';
206  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_country as c on s.fk_pays = c.rowid';
207  $this->export_sql_end[$r] .= ' INNER JOIN '.MAIN_DB_PREFIX.'contrat as co ON co.fk_soc = s.rowid';
208  $this->export_sql_end[$r] .= ' INNER JOIN '.MAIN_DB_PREFIX.'contratdet as cod ON co.rowid = cod.fk_contrat';
209  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product as p ON (cod.fk_product = p.rowid)';
210  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'contrat_extrafields as coextra on (co.rowid = coextra.fk_object)';
211  $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'contratdet_extrafields as codextra on (cod.rowid = codextra.fk_object)';
212  $this->export_sql_end[$r] .= ' WHERE co.entity IN ('.getEntity('contract').')';
213  }
214 
215 
224  public function init($options = '')
225  {
226  global $conf, $langs;
227 
228  // Nettoyage avant activation
229  $this->remove($options);
230 
231  //ODT template
232  $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/contracts/template_contract.odt';
233  $dirodt = DOL_DATA_ROOT.'/doctemplates/contracts';
234  $dest = $dirodt.'/template_contract.odt';
235 
236  if (file_exists($src) && !file_exists($dest)) {
237  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
238  dol_mkdir($dirodt);
239  $result = dol_copy($src, $dest, 0, 0);
240  if ($result < 0) {
241  $langs->load("errors");
242  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
243  return 0;
244  }
245  }
246 
247  $sql = array(
248  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[1][2])."' AND type = 'contract' AND entity = ".((int) $conf->entity),
249  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[1][2])."', 'contract', ".((int) $conf->entity).")"
250  );
251 
252  return $this->_init($sql, $options);
253  }
254 }
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
Class to describe and enable module Contrat.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
if(isModEnabled('facture') && $user->hasRight('facture', 'lire')) if((isModEnabled('fournisseur') &&empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD) && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') && $user->hasRight('don', 'lire')) if(isModEnabled('tax') &&!empty($user->rights->tax->charges->lire)) if(isModEnabled('facture') &&isModEnabled('commande') && $user->hasRight("commande", "lire") &&empty($conf->global->WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER)) $sql
Social contributions to pay.
Definition: index.php:746
print *****$script_file(".$version.") pid cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1, $testvirus=0, $indexdatabase=0)
Copy a file to another file.
Definition: files.lib.php:717
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:123