dolibarr  9.0.0
modPaypal.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2010 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2011 Regis Houssin <regis.houssin@inodbox.com>
5  *
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 <http://www.gnu.org/licenses/>.
18  */
19 
27 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
28 
29 
34 {
40  function __construct($db)
41  {
42  $this->db = $db;
43 
44  // Id for module (must be unique).
45  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
46  $this->numero = 50200;
47  // Key text used to identify module (for permissions, menus, etc...)
48  $this->rights_class = 'paypal';
49 
50  // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
51  // It is used to group modules in module setup page
52  $this->family = "interface";
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  // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
56  $this->description = "Module to offer an online payment page with PayPal";
57  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
58  $this->version = 'dolibarr';
59  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
60  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
61  // Name of image file used for this module.
62  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
63  // If file is in module/img directory, use this->picto=DOL_URL_ROOT.'/module/img/file.png'
64  $this->picto='paypal@paypal';
65 
66  // Data directories to create when module is enabled.
67  $this->dirs = array('/paypal/temp');
68 
69  // Config pages. Put here list of php page names stored in admmin directory used to setup module.
70  $this->config_page_url = array("paypal.php@paypal");
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('modPaypalPlus'); // 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(5,4); // Minimum version of PHP required by module
78  $this->need_dolibarr_version = array(3,0); // Minimum version of Dolibarr required by module
79  $this->langfiles = array("paypal");
80 
81  // Constants
82  $this->const = array(); // List of particular constants to add when module is enabled
83  //Example: $this->const=array(0=>array('MODULE_MY_NEW_CONST1','chaine','myvalue','This is a constant to add',0),
84  // 1=>array('MODULE_MY_NEW_CONST2','chaine','myvalue','This is another constant to add',0) );
85 
86  // New pages on tabs
87  $this->tabs = array();
88 
89 
90  // Boxes
91  $this->boxes = array(); // List of boxes
92  $r=0;
93 
94  // Add here list of php file(s) stored in core/boxes that contains class to show a box.
95  // Example:
96  //$this->boxes[$r][1] = "myboxa.php";
97  //$r++;
98  //$this->boxes[$r][1] = "myboxb.php";
99  //$r++;
100 
101 
102  // Permissions
103  $this->rights = array(); // Permission array used by this module
104  $r=0;
105 
106 
107  // Main menu entries
108  $this->menus = array(); // List of menus to add
109  $r=0;
110  /*$this->menu[$r]=array(
111  'fk_menu'=>'fk_mainmenu=billing,fk_leftmenu=customers_bills_payment', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
112  'mainmenu'=>'billing',
113  'leftmenu'=>'customers_bills_payment_paypal',
114  'type'=>'left', // This is a Left menu entry
115  'titre'=>'PaypalImportPayment',
116  'url'=>'/paypal/importpayments.php',
117  'langs'=>'paypal', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
118  'position'=>501,
119  'enabled'=>'$conf->paypal->enabled && $conf->banque->enabled && $conf->global->MAIN_FEATURES_LEVEL >= 2', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
120  'perms'=>'$user->rights->banque->consolidate', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
121  'target'=>'',
122  'user'=>2
123  ); // 0=Menu for internal users, 1=external users, 2=both
124  $r++;*/
125 
126  // Add here entries to declare new menus
127  // Example to declare the Top Menu entry:
128  // $this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
129  // 'type'=>'top', // This is a Top menu entry
130  // 'titre'=>'MyModule top menu',
131  // 'mainmenu'=>'mymodule',
132  // 'url'=>'/mymodule/pagetop.php',
133  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
134  // 'position'=>100,
135  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
136  // 'target'=>'',
137  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
138  // $r++;
139  //
140  // Example to declare a Left Menu entry:
141  // $this->menu[$r]=array( 'fk_menu'=>'r=0', // Use r=value where r is index key used for the parent menu entry (higher parent must be a top menu entry)
142  // 'type'=>'left', // This is a Left menu entry
143  // 'titre'=>'MyModule left menu 1',
144  // 'mainmenu'=>'mymodule',
145  // 'url'=>'/mymodule/pagelevel1.php',
146  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
147  // 'position'=>100,
148  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
149  // 'target'=>'',
150  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
151  // $r++;
152  //
153  // Example to declare another Left Menu entry:
154  // $this->menu[$r]=array( 'fk_menu'=>'r=1', // Use r=value where r is index key used for the parent menu entry (higher parent must be a top menu entry)
155  // 'type'=>'left', // This is a Left menu entry
156  // 'titre'=>'MyModule left menu 2',
157  // 'mainmenu'=>'mymodule',
158  // 'url'=>'/mymodule/pagelevel2.php',
159  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
160  // 'position'=>100,
161  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
162  // 'target'=>'',
163  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
164  // $r++;
165 
166 
167  // Exports
168  $r=1;
169 
170  // Example:
171  // $this->export_code[$r]=$this->rights_class.'_'.$r;
172  // $this->export_label[$r]='CustomersInvoicesAndInvoiceLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
173  // $this->export_permission[$r]=array(array("facture","facture","export"));
174  // $this->export_fields_array[$r]=array(
175  // 's.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone',
176  // 's.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode',
177  // 's.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.facnumber'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",
178  // 'f.datef'=>"DateInvoice",'f.total'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus',
179  // 'f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",
180  // 'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",
181  // 'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef'
182  // );
183  // $this->export_entities_array[$r]=array(
184  // 's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company',
185  // 's.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company',
186  // 'f.rowid'=>"invoice",'f.facnumber'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total'=>"invoice",'f.total_ttc'=>"invoice",
187  // 'f.tva'=>"invoice",'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",
188  // 'fd.price'=>"invoice_line",'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",
189  // 'fd.qty'=>"invoice_line",'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product'
190  // );
191  // $this->export_sql_start[$r]='SELECT DISTINCT ';
192  // $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
193  // $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
194  // $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
195  // $r++;
196  }
197 }
198 
Class DolibarrModules.
</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
Description and activation class for module Paypal.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:103
__construct($db)
Constructor.