dolibarr  7.0.0-beta
modPaybox.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2009 Laurent Destailleur <eldy@users.sourceforge.net>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <http://www.gnu.org/licenses/>.
17  */
18 
26 include_once DOL_DOCUMENT_ROOT .'/core/modules/DolibarrModules.class.php';
27 
28 
33 {
39  function __construct($db)
40  {
41  $this->db = $db;
42 
43  // Id for module (must be unique).
44  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
45  $this->numero = 50000;
46  // Key text used to identify module (for permissions, menus, etc...)
47  $this->rights_class = 'paybox';
48 
49  // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
50  // It is used to group modules in module setup page
51  $this->family = "other";
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 = "Module to offer an online payment page by credit card with PayBox";
56  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
57  $this->version = 'dolibarr';
58  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
59  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
60  // Where to store the module in setup page (0=common,1=interface,2=other)
61  $this->special = 1;
62  // Name of image file used for this module.
63  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
64  // If file is in module/img directory, use this->picto=DOL_URL_ROOT.'/module/img/file.png'
65  $this->picto='paybox@paybox';
66 
67  // Data directories to create when module is enabled.
68  $this->dirs = array('/paybox/temp');
69 
70  // Config pages. Put here list of php page names stored in admmin directory used to setup module.
71  $this->config_page_url = array("paybox.php@paybox");
72 
73  // Dependencies
74  $this->depends = array(); // List of modules id that must be enabled if this module is enabled
75  $this->requiredby = array(); // List of modules id to disable if this one is disabled
76  $this->phpmin = array(4,1); // Minimum version of PHP required by module
77  $this->need_dolibarr_version = array(2,6); // Minimum version of Dolibarr required by module
78  $this->langfiles = array("paybox");
79 
80  // Constants
81  $this->const = array(); // List of particular constants to add when module is enabled
82  //Example: $this->const=array(0=>array('MODULE_MY_NEW_CONST1','chaine','myvalue','This is a constant to add',0),
83  // 1=>array('MODULE_MY_NEW_CONST2','chaine','myvalue','This is another constant to add',0) );
84 
85  // New pages on tabs
86  $this->tabs = array();
87 
88 
89  // Boxes
90  $this->boxes = array(); // List of boxes
91  $r=0;
92 
93  // Add here list of php file(s) stored in core/boxes that contains class to show a box.
94  // Example:
95  //$this->boxes[$r][1] = "myboxa.php";
96  //$r++;
97  //$this->boxes[$r][1] = "myboxb.php";
98  //$r++;
99 
100 
101  // Permissions
102  $this->rights = array(); // Permission array used by this module
103  $r=0;
104 
105  // Add here list of permission defined by an id, a label, a boolean and two constant strings.
106  // Example:
107  // $this->rights[$r][0] = 2000; // Permission id (must not be already used)
108  // $this->rights[$r][1] = 'Permision label'; // Permission label
109  // $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
110  // $this->rights[$r][4] = 'level1'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
111  // $this->rights[$r][5] = 'level2'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
112  // $r++;
113 
114 
115  // Main menu entries
116  $this->menus = array(); // List of menus to add
117  $r=0;
118 
119  // Add here entries to declare new menus
120  // Example to declare the Top Menu entry:
121  // $this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
122  // 'type'=>'top', // This is a Top menu entry
123  // 'titre'=>'MyModule top menu',
124  // 'mainmenu'=>'mymodule',
125  // 'url'=>'/mymodule/pagetop.php',
126  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
127  // 'position'=>100,
128  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
129  // 'target'=>'',
130  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
131  // $r++;
132  //
133  // Example to declare a Left Menu entry:
134  // $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)
135  // 'type'=>'left', // This is a Left menu entry
136  // 'titre'=>'MyModule left menu 1',
137  // 'mainmenu'=>'mymodule',
138  // 'url'=>'/mymodule/pagelevel1.php',
139  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
140  // 'position'=>100,
141  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
142  // 'target'=>'',
143  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
144  // $r++;
145  //
146  // Example to declare another Left Menu entry:
147  // $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)
148  // 'type'=>'left', // This is a Left menu entry
149  // 'titre'=>'MyModule left menu 2',
150  // 'mainmenu'=>'mymodule',
151  // 'url'=>'/mymodule/pagelevel2.php',
152  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
153  // 'position'=>100,
154  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
155  // 'target'=>'',
156  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
157  // $r++;
158 
159 
160  // Exports
161  $r=1;
162 
163  // Example:
164  // $this->export_code[$r]=$this->rights_class.'_'.$r;
165  // $this->export_label[$r]='CustomersInvoicesAndInvoiceLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
166  // $this->export_permission[$r]=array(array("facture","facture","export"));
167  // $this->export_fields_array[$r]=array('s.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone','s.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode','s.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.facnumber'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",'f.datef'=>"DateInvoice",'f.total'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus','f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef');
168  // $this->export_entities_array[$r]=array('s.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company','s.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company','f.rowid'=>"invoice",'f.facnumber'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total'=>"invoice",'f.total_ttc'=>"invoice",'f.tva'=>"invoice",'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",'fd.price'=>"invoice_line",'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",'fd.qty'=>"invoice_line",'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product');
169  // $this->export_sql_start[$r]='SELECT DISTINCT ';
170  // $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
171  // $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
172  // $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
173  // $r++;
174  }
175 }
176 
Class DolibarrModules.
</td >< tdclass="liste_titre"align="right"></td ></tr >< trclass="liste_titre">< inputtype="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< trclass="oddeven">< td >< inputtype="checkbox"class="check"name="'.$i.'"'.$disabled.'></td >< td >< inputtype="checkbox"class="check"name="choose'.$i.'"></td >< tdclass="nowrap"></td >< td >< inputtype="hidden"name="desc'.$i.'"value="'.dol_escape_htmltag($objp-> description
Only used if Module[ID]Desc translation string is not found.
Definition: replenish.php:554
Description and activation class for module Paybox.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:104
__construct($db)
Constructor.