dolibarr 24.0.0-beta
modPropale.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2003-2004 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3 * Copyright (C) 2004-2010 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) 2012 Juanjo Menent <jmenent@2byte.es>
8 * Copyright (C) 2020 Ahmad Jamaly Rabib <rabib@metroworks.co.jp>
9 * Copyright (C) 2024-2026 Frédéric France <frederic.france@free.fr>
10 * Copyright (C) 2026 Charlene Benke <charlene@patas-monkey.com>
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 3 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <https://www.gnu.org/licenses/>.
24 */
25
33include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
34
35
40{
46 public function __construct($db)
47 {
48 global $conf, $user, $hookmanager;
49
50 $this->db = $db;
51 $this->numero = 20;
52
53 $this->family = "crm";
54 $this->module_position = '10';
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 $this->description = "Management of quotes or commercial proposals";
58
59 // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
60 $this->version = 'dolibarr';
61
62 $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
63 $this->picto = 'propal';
64
65 // Data directories to create when module is enabled
66 $this->dirs = array("/propale/temp");
67
68 // Dependencies
69 $this->hidden = false; // A condition to hide module
70 $this->depends = array("modSociete"); // List of module class names as string that must be enabled if this module is enabled
71 $this->requiredby = array(); // List of module ids to disable if this one is disabled
72 $this->conflictwith = array(); // List of module class names as string this module is in conflict with
73 $this->phpmin = array(7, 0); // Minimum version of PHP required by module
74 $this->config_page_url = array("propal.php");
75 $this->langfiles = array("propal", "bills", "companies", "sendings", "products");
76
77 // Constants
78 include_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
79 $this->const = [
80 [
81 "PROPALE_ADDON_PDF",
82 "chaine",
83 "cyan",
84 'Name of the proposal generation manager in PDF format',
85 0,
86 ],
87 [
88 "PROPALE_ADDON",
89 "chaine",
90 "mod_propale_marbre",
91 'Name of proposal numbering manager',
92 0,
93 ],
94 [
95 "PROPALE_VALIDITY_DURATION",
96 "chaine",
97 "15",
98 'Duration of validity of business proposals',
99 0,
100 ],
101 [
102 "PROPALE_ADDON_PDF_ODT_PATH",
103 "chaine",
104 "DOL_DATA_ROOT".($conf->entity > 1 ? '/'.$conf->entity : '')."/doctemplates/proposals",
105 "",
106 0,
107 ],
108 [
109 "PROPOSAL_ALLOW_ONLINESIGN",
110 "chaine",
111 "1",
112 "",
113 0,
114 ],
115 [
116 "PROPOSAL_ONLINE_SIGNATURE_SECURITY_TOKEN",
117 "chaine",
118 getRandomPassword(true),
119 "",
120 0,
121 ],
122 ];
123
124 /*$this->const[$r][0] = "PROPALE_DRAFT_WATERMARK";
125 $this->const[$r][2] = "__(Draft)__";
126 $this->const[$r][3] = 'Watermark to show on draft proposals';
127 $this->const[$r][4] = 0;
128 $r++;*/
129
130 // Boxes
131 $this->boxes = array(
132 0=>array('file'=>'box_graph_propales_permonth.php', 'enabledbydefaulton'=>'Home'),
133 1=>array('file'=>'box_propales.php', 'enabledbydefaulton'=>'Home'),
134 );
135
136 // Permissions
137 $this->rights = array();
138 $this->rights_class = 'propale';
139 $r = 0;
140
141 $r++;
142 $this->rights[$r][0] = 21; // id de la permission
143 $this->rights[$r][1] = 'Read commercial proposals'; // libelle de la permission
144 $this->rights[$r][2] = 'r'; // type de la permission (deprecated)
145 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
146 $this->rights[$r][4] = 'lire';
147
148 $r++;
149 $this->rights[$r][0] = 22; // id de la permission
150 $this->rights[$r][1] = 'Create and update commercial proposals'; // libelle de la permission
151 $this->rights[$r][2] = 'w'; // type de la permission (deprecated)
152 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
153 $this->rights[$r][4] = 'creer';
154
155 $r++;
156 $this->rights[$r][0] = 24; // id de la permission
157 $this->rights[$r][1] = 'Validate commercial proposals'; // Validate proposal
158 $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
159 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
160 $this->rights[$r][4] = 'propal_advance';
161 $this->rights[$r][5] = 'validate';
162
163 $r++;
164 $this->rights[$r][0] = 25; // id de la permission
165 $this->rights[$r][1] = 'Send commercial proposals to customers'; // libelle de la permission
166 $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
167 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
168 $this->rights[$r][4] = 'propal_advance';
169 $this->rights[$r][5] = 'send';
170
171 $r++;
172 $this->rights[$r][0] = 26; // id de la permission
173 $this->rights[$r][1] = 'Close commercial proposals'; // Set proposal to signed or refused
174 $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
175 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
176 $this->rights[$r][4] = 'propal_advance';
177 $this->rights[$r][5] = 'close';
178
179 $r++;
180 $this->rights[$r][0] = 27; // id de la permission
181 $this->rights[$r][1] = 'Delete commercial proposals'; // libelle de la permission
182 $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
183 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
184 $this->rights[$r][4] = 'supprimer';
185
186 $r++;
187 $this->rights[$r][0] = 28; // id de la permission
188 $this->rights[$r][1] = 'Exporting commercial proposals and attributes'; // libelle de la permission
189 $this->rights[$r][2] = 'r'; // type de la permission (deprecated)
190 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
191 $this->rights[$r][4] = 'export';
192
193 $r++;
194 $this->rights[$r][0] = 29; // id de la permission
195 $this->rights[$r][1] = 'Reopen commercial proposals'; // Set proposal to signed or refused
196 $this->rights[$r][2] = 'w'; // type de la permission (deprecie a ce jour)
197 $this->rights[$r][3] = 0; // La permission est-elle une permission par default
198 $this->rights[$r][4] = 'propal_advance';
199 $this->rights[$r][5] = 'reopen';
200
201 // Menus
202 //-------
203 $this->menu = 1; // This module add menu entries. They are coded into menu manager.
204
205
206 // Exports
207 //--------
208 $r = 0;
209
210 $r++;
211 $this->export_code[$r] = $this->rights_class.'_'.$r;
212 $this->export_label[$r] = 'ProposalsAndProposalsLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
213 $this->export_permission[$r] = array(array("propale", "export"));
214 $this->export_fields_array[$r] = array(
215 's.rowid'=>"IdCompany", 's.nom'=>'CompanyName', 'ps.nom'=>'ParentCompany', 's.code_client'=>'CustomerCode', 's.address'=>'Address', 's.zip'=>'Zip', 's.town'=>'Town', 'co.code'=>'CountryCode', 's.phone'=>'Phone',
216 's.siren'=>'ProfId1', 's.siret'=>'ProfId2', 's.ape'=>'ProfId3', 's.idprof4'=>'ProfId4', 'c.rowid'=>"Id", 'c.ref'=>"Ref", 'c.ref_client'=>"RefCustomer",
217 'c.fk_soc'=>"IdCompany", 'c.datec'=>"DateCreation", 'c.datep'=>"DatePropal", 'c.fin_validite'=>"DateEndPropal",
218 'c.total_ht'=>"TotalHT", 'c.total_ttc'=>"TotalTTC",
219 'cir.label'=>'Source',
220 );
221 if (isModEnabled("multicurrency")) {
222 $this->export_fields_array[$r]['c.multicurrency_code'] = 'Currency';
223 $this->export_fields_array[$r]['c.multicurrency_tx'] = 'CurrencyRate';
224 $this->export_fields_array[$r]['c.multicurrency_total_ht'] = 'MulticurrencyAmountHT';
225 $this->export_fields_array[$r]['c.multicurrency_total_tva'] = 'MulticurrencyAmountVAT';
226 $this->export_fields_array[$r]['c.multicurrency_total_ttc'] = 'MulticurrencyAmountTTC';
227 }
228 $this->export_fields_array[$r] = array_merge($this->export_fields_array[$r], array(
229 'c.fk_statut'=>'Status', 'c.note_public'=>"NotePublic", 'c.note_private'=>"NotePrivate", 'c.date_livraison'=>'DeliveryDate',
230 'c.fk_user_author'=>'CreatedById', 'uc.login'=>'CreatedByLogin',
231 'c.fk_user_valid'=>'ValidatedById', 'uv.login'=>'ValidatedByLogin'));
232 if (isModEnabled("project")) {
233 $this->export_fields_array[$r]['pj.ref'] = 'ProjectRef';
234 }
235 $this->export_fields_array[$r] = array_merge($this->export_fields_array[$r], array(
236 'cd.rowid'=>'LineId', 'cd.description'=>"LineDescription", 'cd.product_type'=>'TypeOfLineServiceOrProduct',
237 'cd.tva_tx'=>"LineVATRate", 'cd.qty'=>"LineQty", 'cd.total_ht'=>"LineTotalHT", 'cd.total_tva'=>"LineTotalVAT", 'cd.total_ttc'=>"LineTotalTTC",
238 ));
239 $this->export_fields_array[$r] = array_merge($this->export_fields_array[$r], array(
240 'p.rowid'=>'ProductId', 'p.ref'=>'ProductRef', 'p.label'=>'ProductLabel'
241 ));
242 // Add multicompany field
243 if (getDolGlobalString('MULTICOMPANY_ENTITY_IN_EXPORT_IF_SHARED')) {
244 $nbofallowedentities = count(explode(',', getEntity('propal')));
245 if (isModEnabled('multicompany') && $nbofallowedentities > 1) {
246 $this->export_fields_array[$r]['c.entity'] = 'Entity';
247 }
248 }
249 //$this->export_TypeFields_array[$r]=array(
250 // 's.rowid'=>"Numeric",'s.nom'=>'Text','s.address'=>'Text','s.zip'=>'Text','s.town'=>'Text','co.code'=>'Text','s.phone'=>'Text',
251 // 's.siren'=>'Text','s.siret'=>'Text','s.ape'=>'Text','s.idprof4'=>'Text','c.ref'=>"Text",'c.ref_client'=>"Text",'c.datec'=>"Date",'c.datep'=>"Date",
252 // 'c.fin_validite'=>"Date",'c.total_ht'=>"Numeric",'c.total_ttc'=>"Numeric",'c.fk_statut'=>'Status','c.note_public'=>"Text",'c.note_private'=>"Text",
253 // 'c.date_livraison'=>'Date','cd.description'=>"Text",'cd.product_type'=>'Boolean','cd.tva_tx'=>"Numeric",'cd.qty'=>"Numeric",'cd.total_ht'=>"Numeric",
254 // 'cd.total_tva'=>"Numeric",'cd.total_ttc'=>"Numeric",'p.rowid'=>'List:product:label','p.ref'=>'Text','p.label'=>'Text'
255 //);
256 $this->export_TypeFields_array[$r] = array(
257 's.nom'=>'Text', 'ps.nom'=>'Text', 's.code_client'=>'Text', 's.address'=>'Text', 's.zip'=>'Text', 's.town'=>'Text', 'co.code'=>'Text', 's.phone'=>'Text', 's.siren'=>'Text', 's.siret'=>'Text',
258 's.ape'=>'Text', 's.idprof4'=>'Text', 'c.ref'=>"Text", 'c.ref_client'=>"Text", 'c.datec'=>"Date", 'c.datep'=>"Date", 'c.fin_validite'=>"Date",
259 'c.total_ht'=>"Numeric", 'c.total_ttc'=>"Numeric", 'c.fk_statut'=>'Status', 'c.note_public'=>"Text", 'c.note_private'=>"Text", 'c.date_livraison'=>'Date',
260 'pj.ref'=>'Text', 'cd.description'=>"Text", 'cd.product_type'=>'Boolean', 'cd.tva_tx'=>"Numeric", 'cd.qty'=>"Numeric", 'cd.total_ht'=>"Numeric",
261 'cd.total_tva'=>"Numeric", 'cd.total_ttc'=>"Numeric", 'p.ref'=>'Text', 'p.label'=>'Text',
262 'c.entity'=>'List:entity:label:rowid',
263 'cir.label'=>'Text',
264 );
265 $this->export_entities_array[$r] = array(
266 's.rowid'=>"company", 's.nom'=>'company', 'ps.nom'=>'company', 's.code_client'=>'company', 's.address'=>'company', 's.zip'=>'company', 's.town'=>'company', 'co.code'=>'company', 's.phone'=>'company',
267 's.siren'=>'company', 's.ape'=>'company', 's.idprof4'=>'company', 's.siret'=>'company', 'c.rowid'=>"propal", 'c.ref'=>"propal", 'c.ref_client'=>"propal",
268 'c.fk_soc'=>"propal", 'c.datec'=>"propal", 'c.datep'=>"propal", 'c.fin_validite'=>"propal", 'c.total_ht'=>"propal",
269 'c.total_ttc'=>"propal", 'c.fk_statut'=>"propal", 'c.note_public'=>"propal", 'c.note_private'=>"propal", 'c.date_livraison'=>"propal",
270 'c.fk_user_author'=>'user', 'uc.login'=>'user',
271 'c.fk_user_valid'=>'user', 'uv.login'=>'user',
272 'pj.ref'=>'project',
273 'cd.rowid'=>'propal_line',
274 'cd.description'=>"propal_line", 'cd.product_type'=>'propal_line', 'cd.tva_tx'=>"propal_line", 'cd.qty'=>"propal_line",
275 'cd.total_ht'=>"propal_line", 'cd.total_tva'=>"propal_line", 'cd.total_ttc'=>"propal_line", 'p.rowid'=>'product', 'p.ref'=>'product', 'p.label'=>'product'
276 );
277 $this->export_dependencies_array[$r] = array('propal_line'=>'cd.rowid', 'product'=>'cd.rowid'); // To add unique key if we ask a field of a child to avoid the DISTINCT to discard them
278 $keyforselect = 'propal';
279 $keyforelement = 'propal';
280 $keyforaliasextra = 'extra';
281 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
282 $keyforselect = 'propaldet';
283 $keyforelement = 'propal_line';
284 $keyforaliasextra = 'extra2';
285 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
286 $keyforselect = 'product';
287 $keyforelement = 'product';
288 $keyforaliasextra = 'extra3';
289 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
290 $keyforselect = 'societe';
291 $keyforelement = 'company';
292 $keyforaliasextra = 'extra4';
293 include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
294
295 $this->export_sql_start[$r] = 'SELECT DISTINCT ';
296 $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'societe as s ';
297 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'societe_extrafields as extra4 ON s.rowid = extra4.fk_object';
298 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'societe as ps ON ps.rowid = s.parent';
299 if (!empty($user) && !$user->hasRight('societe', 'client', 'voir')) {
300 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'societe_commerciaux as sc ON sc.fk_soc = s.rowid';
301 }
302 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_country as co ON s.fk_pays = co.rowid,';
303 $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'propal as c';
304 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_input_reason as cir ON cir.rowid = c.fk_input_reason';
305 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'projet as pj ON c.fk_projet = pj.rowid';
306 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'user as uc ON c.fk_user_author = uc.rowid';
307 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'user as uv ON c.fk_user_valid = uv.rowid';
308 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'propal_extrafields as extra ON c.rowid = extra.fk_object';
309 $this->export_sql_end[$r] .= ', '.MAIN_DB_PREFIX.'propaldet as cd';
310 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'propaldet_extrafields as extra2 on cd.rowid = extra2.fk_object';
311 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (cd.fk_product = p.rowid)';
312 $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product_extrafields as extra3 on p.rowid = extra3.fk_object';
313 $this->export_sql_end[$r] .= ' WHERE c.fk_soc = s.rowid AND c.rowid = cd.fk_propal';
314 $this->export_sql_end[$r] .= ' AND c.entity IN ('.getEntity('propal').')';
315 if (!empty($user) && !$user->hasRight('societe', 'client', 'voir')) {
316 $this->export_sql_end[$r] .= ' AND sc.fk_user = '.(empty($user) ? 0 : $user->id);
317 }
318 $parameters = array();
319 $hookmanager->executeHooks('printExportWhere', $parameters, $this); // Note that $action and $object may have been modified by hook
320 $this->export_sql_end[$r] .= $hookmanager->resPrint;
321
322 // Imports
323 //--------
324 $r = 0;
325
326 $r++;
327 $this->import_code[$r] = $this->rights_class.'_'.$r;
328 $this->import_label[$r] = 'Proposals'; // Translation key
329 $this->import_icon[$r] = $this->picto;
330 $this->import_entities_array[$r] = array(); // We define here only fields that use another icon that the one defined into import_icon
331 $this->import_tables_array[$r] = array('c' => MAIN_DB_PREFIX.'propal', 'extra' => MAIN_DB_PREFIX.'propal_extrafields');
332 $this->import_tables_creator_array[$r] = array('c'=>'fk_user_author'); // Fields to store import user id
333 $this->import_fields_array[$r] = array(
334 'c.ref' => 'Ref*',
335 'c.ref_client' => 'RefCustomer',
336 'c.fk_soc' => 'ThirdPartyName*',
337 'c.datec' => 'DateCreation',
338 'c.datep' => 'DatePropal',
339 'c.fin_validite' => 'DateEndPropal',
340 'c.total_ht' => 'TotalHT',
341 'c.total_ttc' => 'TotalTTC',
342 'c.fk_statut' => 'Status*',
343 'c.note_public' => 'NotePublic',
344 'c.note_private' => 'NotePrivate',
345 'c.date_livraison' => 'DeliveryDate',
346 'c.fk_user_valid' => 'ValidatedById'
347 );
348 if (isModEnabled("multicurrency")) {
349 $this->import_fields_array[$r]['c.multicurrency_code'] = 'Currency';
350 $this->import_fields_array[$r]['c.multicurrency_tx'] = 'CurrencyRate';
351 $this->import_fields_array[$r]['c.multicurrency_total_ht'] = 'MulticurrencyAmountHT';
352 $this->import_fields_array[$r]['c.multicurrency_total_tva'] = 'MulticurrencyAmountVAT';
353 $this->import_fields_array[$r]['c.multicurrency_total_ttc'] = 'MulticurrencyAmountTTC';
354 }
355 // Add extra fields
356 $import_extrafield_sample = array();
357 $sql = "SELECT name, label, fieldrequired FROM ".MAIN_DB_PREFIX."extrafields WHERE type <> 'separate' AND elementtype = 'propal' AND entity IN (0, ".$conf->entity.")";
358 $resql = $this->db->query($sql);
359 if ($resql) {
360 while ($obj = $this->db->fetch_object($resql)) {
361 $fieldname = 'extra.'.$obj->name;
362 $fieldlabel = ucfirst($obj->label);
363 $this->import_fields_array[$r][$fieldname] = $fieldlabel.($obj->fieldrequired ? '*' : '');
364 $import_extrafield_sample[$fieldname] = $fieldlabel;
365 }
366 }
367 // End add extra fields
368 $this->import_fieldshidden_array[$r] = ['extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'propal'];
369 $this->import_regex_array[$r] = ['c.ref' => '[^ ]'];
370 $import_sample = [
371 'c.ref' => 'PROV0077',
372 'c.ref_client' => 'Client1',
373 'c.fk_soc' => 'MyBigCompany',
374 'c.datec' => '2020-01-01',
375 'c.datep' => '2020-01-01',
376 'c.fin_validite' => '2020-01-01',
377 'c.total_ht' => '0',
378 'c.total_ttc' => '0',
379 'c.fk_statut' => '1',
380 'c.note_public' => '',
381 'c.note_private' => '',
382 'c.date_livraison' => '2020-01-01',
383 'c.fk_user_valid' => '1',
384 'c.multicurrency_code' => '',
385 'c.multicurrency_tx' => '1',
386 'c.multicurrency_total_ht' => '0',
387 'c.multicurrency_total_tva' => '0',
388 'c.multicurrency_total_ttc' => '0'
389 ];
390 $this->import_examplevalues_array[$r] = array_merge($import_sample, $import_extrafield_sample);
391 $this->import_updatekeys_array[$r] = array('c.ref'=>'Ref');
392 $this->import_convertvalue_array[$r] = array(
393 'c.ref' => array(
394 'rule'=>'getrefifauto',
395 'class'=>(!getDolGlobalString('PROPALE_ADDON') ? 'mod_propale_marbre' : $conf->global->PROPALE_ADDON),
396 'path'=>"/core/modules/propale/".(!getDolGlobalString('PROPALE_ADDON') ? 'mod_propale_marbre' : $conf->global->PROPALE_ADDON).'.php',
397 'classobject'=>'Propal',
398 'pathobject'=>'/comm/propal/class/propal.class.php',
399 ),
400 'c.fk_soc' => array(
401 'rule' => 'fetchidfromref',
402 'file' => '/societe/class/societe.class.php',
403 'class' => 'Societe',
404 'method' => 'fetch',
405 'element' => 'ThirdParty'
406 )
407 );
408
409 //Import Proposal Lines
410 $r++;
411 $this->import_code[$r] = $this->rights_class.'line_'.$r;
412 $this->import_label[$r] = "ProposalLines"; // Translation key
413 $this->import_icon[$r] = $this->picto;
414 $this->import_entities_array[$r] = array(); // We define here only fields that use another icon that the one defined into import_icon
415 $this->import_tables_array[$r] = array(
416 'cd' => MAIN_DB_PREFIX.'propaldet',
417 'extra' => MAIN_DB_PREFIX.'propaldet_extrafields'
418 );
419 $this->import_fields_array[$r] = array(
420 'cd.fk_propal' => 'Proposal*',
421 'cd.fk_parent_line' => 'ParentLine',
422 'cd.fk_product' => 'IdProduct',
423 'cd.description' => 'LineDescription',
424 'cd.product_type' => 'TypeOfLineServiceOrProduct',
425 'cd.tva_tx' => 'LineVATRate',
426 'cd.qty' => 'LineQty',
427 'cd.remise_percent' => 'Reduc. Percent',
428 'cd.price' => 'Price',
429 'cd.subprice' => 'Sub Price',
430 'cd.total_ht' => 'LineTotalHT',
431 'cd.total_tva' => 'LineTotalVAT',
432 'cd.total_ttc' => 'LineTotalTTC',
433 'cd.date_start' => 'Start Date',
434 'cd.date_end' => 'End Date',
435 'cd.buy_price_ht' => 'LineBuyPriceHT'
436 );
437 if (isModEnabled("multicurrency")) {
438 $this->import_fields_array[$r]['cd.multicurrency_code'] = 'Currency';
439 $this->import_fields_array[$r]['cd.multicurrency_subprice'] = 'CurrencyRate';
440 $this->import_fields_array[$r]['cd.multicurrency_total_ht'] = 'MulticurrencyAmountHT';
441 $this->import_fields_array[$r]['cd.multicurrency_total_tva'] = 'MulticurrencyAmountVAT';
442 $this->import_fields_array[$r]['cd.multicurrency_total_ttc'] = 'MulticurrencyAmountTTC';
443 }
444 // Add extra fields
445 $import_extrafield_sample = array();
446 $sql = "SELECT name, label, fieldrequired FROM ".MAIN_DB_PREFIX."extrafields WHERE type <> 'separate' AND elementtype = 'propaldet' AND entity IN (0, ".$conf->entity.")";
447 $resql = $this->db->query($sql);
448 if ($resql) {
449 while ($obj = $this->db->fetch_object($resql)) {
450 $fieldname = 'extra.'.$obj->name;
451 $fieldlabel = ucfirst($obj->label);
452 $this->import_fields_array[$r][$fieldname] = $fieldlabel.($obj->fieldrequired ? '*' : '');
453 $import_extrafield_sample[$fieldname] = $fieldlabel;
454 }
455 }
456 // End add extra fields
457 $this->import_fieldshidden_array[$r] = array('extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'propaldet');
458 $this->import_regex_array[$r] = array('cd.product_type' => '[0|1]$');
459 $import_sample = array(
460 'cd.fk_propal' => 'PROV(0001)',
461 'cd.fk_parent_line' => '',
462 'cd.fk_product' => '',
463 'cd.description' => 'Line description',
464 'cd.product_type' => '1',
465 'cd.tva_tx' => '0',
466 'cd.qty' => '2',
467 'cd.remise_percent' => '0',
468 'cd.price' => '',
469 'cd.subprice' => '5000',
470 'cd.total_ht' => '10000',
471 'cd.total_tva' => '0',
472 'cd.total_ttc' => '10100',
473 'cd.date_start' => '',
474 'cd.date_end' => '',
475 'cd.buy_price_ht' => '7000',
476 'cd.multicurrency_code' => 'JPY',
477 'cd.multicurrency_tx' => '1',
478 'cd.multicurrency_total_ht' => '10000',
479 'cd.multicurrency_total_tva' => '0',
480 'cd.multicurrency_total_ttc' => '10100'
481 );
482 $this->import_examplevalues_array[$r] = array_merge($import_sample, $import_extrafield_sample);
483 $this->import_updatekeys_array[$r] = array('cd.fk_propal' => 'Quotation Id', 'cd.fk_product' => 'Product Id');
484 $this->import_convertvalue_array[$r] = array(
485 'cd.fk_propal' => array(
486 'rule'=>'fetchidfromref',
487 'file'=>'/comm/propal/class/propal.class.php',
488 'class'=>'Propal',
489 'method'=>'fetch'
490 )
491 );
492 }
493
494
503 public function init($options = '')
504 {
505 global $conf, $langs;
506
507 $result = $this->_load_tables('/install/mysql/', 'propal');
508 if ($result < 0) {
509 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')
510 }
511
512 // Remove permissions and default values
513 $this->remove($options);
514
515 //ODT template
516 $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/proposals/template_proposal.odt';
517 $dirodt = DOL_DATA_ROOT.($conf->entity > 1 ? '/'.$conf->entity : '').'/doctemplates/proposals';
518 $dest = $dirodt.'/template_proposal.odt';
519
520 if (file_exists($src) && !file_exists($dest)) {
521 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
522 dol_mkdir($dirodt);
523 $result = dol_copy($src, $dest, '0', 0);
524 if ($result < 0) {
525 $langs->load("errors");
526 $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
527 return 0;
528 }
529 }
530
531 $sql = array(
532 "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[0][2])."' AND type = 'propal' AND entity = ".((int) $conf->entity),
533 "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[0][2])."','propal',".((int) $conf->entity).")",
534 );
535
536 return $this->_init($sql, $options);
537 }
538}
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
_load_tables($reldir, $onlywithsuffix='')
Create tables and keys required by module:
Class to describe and enable module Propale.
__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.
if(!isModEnabled('ai')||!getDolGlobalString('AI_ASSISTANT_ENABLED')) global $conf
The main.inc.php has been included so the following variable are now defined:
dol_copy($srcfile, $destfile, $newmask='0', $overwriteifexists=1, $testvirus=0, $indexdatabase=0)
Copy a file to another file.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
isModEnabled($module)
Is Dolibarr module enabled.
getEntity($element, $shared=1, $currentobject=null)
Get list of entity id to use.
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:133
getRandomPassword($generic=false, $replaceambiguouschars=null, $length=32)
Return a generated password using default module.