dolibarr  9.0.0
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  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <http://www.gnu.org/licenses/>.
21  */
22 
30 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
31 
32 
37 {
38 
44  function __construct($db)
45  {
46  global $conf, $user;
47 
48  $this->db = $db;
49  $this->numero = 20;
50 
51  $this->family = "crm";
52  $this->module_position = '20';
53  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
54  $this->name = preg_replace('/^mod/i','',get_class($this));
55  $this->description = "Gestion des propositions commerciales";
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='propal';
62 
63  // Data directories to create when module is enabled
64  $this->dirs = array("/propale/temp");
65 
66  // Dependencies
67  $this->hidden = false; // A condition to hide module
68  $this->depends = array("modSociete"); // List of module class names as string that must be enabled if this module is enabled
69  $this->requiredby = array(); // List of module ids to disable if this one is disabled
70  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
71  $this->phpmin = array(5,4); // Minimum version of PHP required by module
72  $this->config_page_url = array("propal.php");
73  $this->langfiles = array("propal","bills","companies","deliveries","products");
74 
75  // Constants
76  $this->const = array();
77  $r=0;
78 
79  $this->const[$r][0] = "PROPALE_ADDON_PDF";
80  $this->const[$r][1] = "chaine";
81  $this->const[$r][2] = "azur";
82  $this->const[$r][3] = 'Name of the proposal generation manager in PDF format';
83  $this->const[$r][4] = 0;
84  $r++;
85 
86  $this->const[$r][0] = "PROPALE_ADDON";
87  $this->const[$r][1] = "chaine";
88  $this->const[$r][2] = "mod_propale_marbre";
89  $this->const[$r][3] = 'Name of proposal numbering manager';
90  $this->const[$r][4] = 0;
91  $r++;
92 
93  $this->const[$r][0] = "PROPALE_VALIDITY_DURATION";
94  $this->const[$r][1] = "chaine";
95  $this->const[$r][2] = "15";
96  $this->const[$r][3] = 'Duration of validity of business proposals';
97  $this->const[$r][4] = 0;
98  $r++;
99 
100  $this->const[$r][0] = "PROPALE_ADDON_PDF_ODT_PATH";
101  $this->const[$r][1] = "chaine";
102  $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/proposals";
103  $this->const[$r][3] = "";
104  $this->const[$r][4] = 0;
105  $r++;
106 
107  /*$this->const[$r][0] = "PROPALE_DRAFT_WATERMARK";
108  $this->const[$r][2] = "__(Draft)__";
109  $this->const[$r][3] = 'Watermark to show on draft proposals';
110  $this->const[$r][4] = 0;
111  $r++;*/
112 
113  // Boxes
114  $this->boxes = array(
115  0=>array('file'=>'box_graph_propales_permonth.php','enabledbydefaulton'=>'Home'),
116  1=>array('file'=>'box_propales.php','enabledbydefaulton'=>'Home'),
117  );
118 
119  // Permissions
120  $this->rights = array();
121  $this->rights_class = 'propale';
122  $r=0;
123 
124  $r++;
125  $this->rights[$r][0] = 21; // id de la permission
126  $this->rights[$r][1] = 'Read commercial proposals'; // libelle de la permission
127  $this->rights[$r][2] = 'r'; // type de la permission (deprecie a ce jour)
128  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
129  $this->rights[$r][4] = 'lire';
130 
131  $r++;
132  $this->rights[$r][0] = 22; // id de la permission
133  $this->rights[$r][1] = 'Create and update commercial proposals'; // libelle de la permission
134  $this->rights[$r][2] = 'w'; // type de la permission (deprecie a ce jour)
135  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
136  $this->rights[$r][4] = 'creer';
137 
138  $r++;
139  $this->rights[$r][0] = 24; // id de la permission
140  $this->rights[$r][1] = 'Validate commercial proposals'; // libelle de la permission
141  $this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
142  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
143  $this->rights[$r][4] = 'propal_advance';
144  $this->rights[$r][5] = 'validate';
145 
146  $r++;
147  $this->rights[$r][0] = 25; // id de la permission
148  $this->rights[$r][1] = 'Send commercial proposals to customers'; // libelle de la permission
149  $this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
150  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
151  $this->rights[$r][4] = 'propal_advance';
152  $this->rights[$r][5] = 'send';
153 
154  $r++;
155  $this->rights[$r][0] = 26; // id de la permission
156  $this->rights[$r][1] = 'Close commercial proposals'; // libelle de la permission
157  $this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
158  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
159  $this->rights[$r][4] = 'cloturer';
160 
161  $r++;
162  $this->rights[$r][0] = 27; // id de la permission
163  $this->rights[$r][1] = 'Delete commercial proposals'; // libelle de la permission
164  $this->rights[$r][2] = 'd'; // type de la permission (deprecie a ce jour)
165  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
166  $this->rights[$r][4] = 'supprimer';
167 
168  $r++;
169  $this->rights[$r][0] = 28; // id de la permission
170  $this->rights[$r][1] = 'Exporting commercial proposals and attributes'; // libelle de la permission
171  $this->rights[$r][2] = 'r'; // type de la permission (deprecie a ce jour)
172  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
173  $this->rights[$r][4] = 'export';
174 
175 
176  // Menus
177  //-------
178  $this->menu = 1; // This module add menu entries. They are coded into menu manager.
179 
180 
181  // Exports
182  //--------
183  $r=0;
184 
185  $r++;
186  $this->export_code[$r]=$this->rights_class.'_'.$r;
187  $this->export_label[$r]='ProposalsAndProposalsLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
188  $this->export_permission[$r]=array(array("propale","export"));
189  $this->export_fields_array[$r]=array(
190  's.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','co.code'=>'CountryCode','s.phone'=>'Phone',
191  's.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','c.rowid'=>"Id",'c.ref'=>"Ref",'c.ref_client'=>"RefCustomer",
192  'c.fk_soc'=>"IdCompany",'c.datec'=>"DateCreation",'c.datep'=>"DatePropal",'c.fin_validite'=>"DateEndPropal",'c.remise_percent'=>"GlobalDiscount",
193  'c.total_ht'=>"TotalHT",'c.total'=>"TotalTTC",'c.fk_statut'=>'Status','c.note_public'=>"Note",'c.date_livraison'=>'DeliveryDate',
194  'c.fk_user_author'=>'CreatedById','uc.login'=>'CreatedByLogin','c.fk_user_valid'=>'ValidatedById','uv.login'=>'ValidatedByLogin',
195  'pj.ref'=>'ProjectRef', 'cd.rowid'=>'LineId','cd.label'=>"Label",'cd.description'=>"LineDescription",'cd.product_type'=>'TypeOfLineServiceOrProduct',
196  'cd.tva_tx'=>"LineVATRate",'cd.qty'=>"LineQty",'cd.total_ht'=>"LineTotalHT",'cd.total_tva'=>"LineTotalVAT",'cd.total_ttc'=>"LineTotalTTC",
197  'p.rowid'=>'ProductId','p.ref'=>'ProductRef','p.label'=>'ProductLabel'
198  );
199  if (! empty($conf->multicurrency->enabled))
200  {
201  $this->export_fields_array[$r]['c.multicurrency_code'] = 'Currency';
202  $this->export_fields_array[$r]['c.multicurrency_tx'] = 'CurrencyRate';
203  $this->export_fields_array[$r]['c.multicurrency_total_ht'] = 'MulticurrencyAmountHT';
204  $this->export_fields_array[$r]['c.multicurrency_total_tva'] = 'MulticurrencyAmountVAT';
205  $this->export_fields_array[$r]['c.multicurrency_total_ttc'] = 'MulticurrencyAmountTTC';
206  }
207  //$this->export_TypeFields_array[$r]=array(
208  // 's.rowid'=>"List:societe:nom",'s.nom'=>'Text','s.address'=>'Text','s.zip'=>'Text','s.town'=>'Text','co.code'=>'Text','s.phone'=>'Text',
209  // '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",
210  // 'c.fin_validite'=>"Date",'c.remise_percent'=>"Numeric",'c.total_ht'=>"Numeric",'c.total'=>"Numeric",'c.fk_statut'=>'Status','c.note_public'=>"Text",
211  // 'c.date_livraison'=>'Date','cd.description'=>"Text",'cd.product_type'=>'Boolean','cd.tva_tx'=>"Numeric",'cd.qty'=>"Numeric",'cd.total_ht'=>"Numeric",
212  // 'cd.total_tva'=>"Numeric",'cd.total_ttc'=>"Numeric",'p.rowid'=>'List:product:label','p.ref'=>'Text','p.label'=>'Text'
213  //);
214  $this->export_TypeFields_array[$r]=array(
215  's.nom'=>'Text','s.address'=>'Text','s.zip'=>'Text','s.town'=>'Text','co.code'=>'Text','s.phone'=>'Text','s.siren'=>'Text','s.siret'=>'Text',
216  's.ape'=>'Text','s.idprof4'=>'Text','c.ref'=>"Text",'c.ref_client'=>"Text",'c.datec'=>"Date",'c.datep'=>"Date",'c.fin_validite'=>"Date",
217  'c.remise_percent'=>"Numeric",'c.total_ht'=>"Numeric",'c.total'=>"Numeric",'c.fk_statut'=>'Status','c.note_public'=>"Text",'c.date_livraison'=>'Date',
218  'pj.ref'=>'Text', 'cd.description'=>"Text",'cd.product_type'=>'Boolean','cd.tva_tx'=>"Numeric",'cd.qty'=>"Numeric",'cd.total_ht'=>"Numeric",
219  'cd.total_tva'=>"Numeric",'cd.total_ttc'=>"Numeric",'p.ref'=>'Text','p.label'=>'Text'
220  );
221  $this->export_entities_array[$r]=array(
222  's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','co.code'=>'company','s.phone'=>'company',
223  's.siren'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.siret'=>'company','c.rowid'=>"propal",'c.ref'=>"propal",'c.ref_client'=>"propal",
224  'c.fk_soc'=>"propal",'c.datec'=>"propal",'c.datep'=>"propal",'c.fin_validite'=>"propal",'c.remise_percent'=>"propal",'c.total_ht'=>"propal",
225  'c.total'=>"propal",'c.fk_statut'=>"propal",'c.note_public'=>"propal",'c.date_livraison'=>"propal", 'pj.ref'=>'project', 'cd.rowid'=>'propal_line',
226  'cd.label'=>"propal_line",'cd.description'=>"propal_line",'cd.product_type'=>'propal_line','cd.tva_tx'=>"propal_line",'cd.qty'=>"propal_line",
227  'cd.total_ht'=>"propal_line",'cd.total_tva'=>"propal_line",'cd.total_ttc'=>"propal_line",'p.rowid'=>'product','p.ref'=>'product','p.label'=>'product'
228  );
229  $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
230  $keyforselect='propal'; $keyforelement='propal'; $keyforaliasextra='extra';
231  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
232  $keyforselect='propaldet'; $keyforelement='propal_line'; $keyforaliasextra='extra2';
233  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
234  $keyforselect='product'; $keyforelement='product'; $keyforaliasextra='extra3';
235  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
236  $keyforselect='societe'; $keyforelement='societe'; $keyforaliasextra='extra4';
237  include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
238 
239  $this->export_sql_start[$r]='SELECT DISTINCT ';
240  $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'societe as s ';
241  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'societe_extrafields as extra4 ON s.rowid = extra4.fk_object';
242 
243  if(!$user->rights->societe->client->voir) $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'societe_commerciaux as sc ON sc.fk_soc = s.rowid';
244  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'c_country as co ON s.fk_pays = co.rowid,';
245  $this->export_sql_end[$r] .=' '.MAIN_DB_PREFIX.'propal as c';
246  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'projet as pj ON c.fk_projet = pj.rowid';
247  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'user as uc ON c.fk_user_author = uc.rowid';
248  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'user as uv ON c.fk_user_valid = uv.rowid';
249  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'propal_extrafields as extra ON c.rowid = extra.fk_object';
250  $this->export_sql_end[$r] .=', '.MAIN_DB_PREFIX.'propaldet as cd';
251  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'propaldet_extrafields as extra2 on cd.rowid = extra2.fk_object';
252  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (cd.fk_product = p.rowid)';
253  $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product_extrafields as extra3 on p.rowid = extra3.fk_object';
254  $this->export_sql_end[$r] .=' WHERE c.fk_soc = s.rowid AND c.rowid = cd.fk_propal';
255  $this->export_sql_end[$r] .=' AND c.entity IN ('.getEntity('propal').')';
256  if(!$user->rights->societe->client->voir) $this->export_sql_end[$r] .=' AND sc.fk_user = '.$user->id;
257  }
258 
259 
268  function init($options='')
269  {
270  global $conf,$langs;
271 
272  // Remove permissions and default values
273  $this->remove($options);
274 
275  //ODT template
276  $src=DOL_DOCUMENT_ROOT.'/install/doctemplates/proposals/template_proposal.odt';
277  $dirodt=DOL_DATA_ROOT.'/doctemplates/proposals';
278  $dest=$dirodt.'/template_proposal.odt';
279 
280  if (file_exists($src) && ! file_exists($dest))
281  {
282  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
283  dol_mkdir($dirodt);
284  $result=dol_copy($src,$dest,0,0);
285  if ($result < 0)
286  {
287  $langs->load("errors");
288  $this->error=$langs->trans('ErrorFailToCopyFile',$src,$dest);
289  return 0;
290  }
291  }
292 
293  $sql = array(
294  "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[0][2])."' AND type = 'propal' AND entity = ".$conf->entity,
295  "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[0][2])."','propal',".$conf->entity.")",
296  );
297 
298  return $this->_init($sql,$options);
299  }
300 }
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1)
Copy a file to another file.
Definition: files.lib.php:666
Class DolibarrModules.
init($options='')
Function called when module is enabled.
__construct($db)
Constructor.
</td >< td class="liste_titre" align="right"></td ></tr >< tr class="liste_titre">< input type="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< tr class="oddeven">< td >< input type="checkbox" class="check" name="' . $i . '"' . $disabled . '></td >< td >< input type="checkbox" class="check" name="choose'.$i.'"></td >< td class="nowrap"></td >< td >< input type="hidden" name="desc' . $i . '" value="' . dol_escape_htmltag($objp-> description
Only used if Module[ID]Desc translation string is not found.
Definition: replenish.php:573
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:103
Class to describe and enable module Propale.
_init($array_sql, $options='')
Enables a module.
dol_mkdir($dir, $dataroot='', $newmask=null)
Creation of a directory (this can create recursive subdir)