dolibarr  9.0.0
modGravatar.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2015 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 = 2700;
46  // Key text used to identify module (for permissions, menus, etc...)
47  $this->rights_class = 'gravatar';
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 = "interface";
52  // Module position in the family on 2 digits ('01', '10', '20', ...)
53  $this->module_position = '75';
54  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
55  $this->name = preg_replace('/^mod/i', '', get_class($this));
56  // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
57  $this->description = "Use online Gravatar service (www.gravatar.com) to show photo of users/members (found with their emails).<br>Need an internet access.";
58  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
59  $this->version = 'dolibarr';
60  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
61  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
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/images directory, use this->picto=DOL_URL_ROOT.'/module/images/file.png'
65  $this->picto = 'gravatar';
66 
67  // Data directories to create when module is enabled.
68  // Example: this->dirs = array("/mymodule/temp");
69  $this->dirs = array();
70  $r = 0;
71 
72  // Config pages. Put here list of php page names stored in admmin directory used to setup module.
73  $this->config_page_url = array();
74 
75  // Dependencies
76  $this->hidden = false; // A condition to hide module
77  $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
78  $this->requiredby = array(); // List of module ids to disable if this one is disabled
79  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
80  $this->phpmin = array(5, 4); // Minimum version of PHP required by module
81  $this->need_dolibarr_version = array(2, 7); // Minimum version of Dolibarr required by module
82  $this->langfiles = array();
83 
84  // Constants
85  $this->const = array(); // List of particular constants to add when module is enabled
86  //Example: $this->const=array(0=>array('MODULE_MY_NEW_CONST1','chaine','myvalue','This is a constant to add',0),
87  // 1=>array('MODULE_MY_NEW_CONST2','chaine','myvalue','This is another constant to add',0) );
88 
89  // Array to add new pages in new tabs
90  $this->tabs = array();
91 
92  // Boxes
93  $this->boxes = array(); // List of boxes
94  $r = 0;
95 
96  // Add here list of php file(s) stored in core/boxes that contains class to show a box.
97  // Example:
98  //$this->boxes[$r][1] = "myboxa.php";
99  //$r++;
100  //$this->boxes[$r][1] = "myboxb.php";
101  //$r++;
102 
103 
104  // Permissions
105  $this->rights = array(); // Permission array used by this module
106  $r = 0;
107 
108  // Add here list of permission defined by an id, a label, a boolean and two constant strings.
109  // Example:
110  // $this->rights[$r][0] = 2000; // Permission id (must not be already used)
111  // $this->rights[$r][1] = 'Permision label'; // Permission label
112  // $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
113  // $this->rights[$r][4] = 'level1'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
114  // $this->rights[$r][5] = 'level2'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2)
115  // $r++;
116 
117 
118  // Main menu entries
119  $this->menus = array(); // List of menus to add
120  $r = 0;
121 
122  // Add here entries to declare new menus
123  // Example to declare the Top Menu entry:
124  // $this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
125  // 'type'=>'top', // This is a Top menu entry
126  // 'titre'=>'MyModule top menu',
127  // 'mainmenu'=>'mymodule',
128  // 'url'=>'/mymodule/pagetop.php',
129  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
130  // 'position'=>100,
131  // 'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
132  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
133  // 'target'=>'',
134  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
135  // $r++;
136  //
137  // Example to declare a Left Menu entry:
138  // $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)
139  // 'type'=>'left', // This is a Left menu entry
140  // 'titre'=>'MyModule left menu 1',
141  // 'mainmenu'=>'mymodule',
142  // 'url'=>'/mymodule/pagelevel1.php',
143  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
144  // 'position'=>100,
145  // 'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
146  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
147  // 'target'=>'',
148  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
149  // $r++;
150  //
151  // Example to declare another Left Menu entry:
152  // $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)
153  // 'type'=>'left', // This is a Left menu entry
154  // 'titre'=>'MyModule left menu 2',
155  // 'mainmenu'=>'mymodule',
156  // 'url'=>'/mymodule/pagelevel2.php',
157  // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
158  // 'position'=>100,
159  // 'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
160  // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
161  // 'target'=>'',
162  // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
163  // $r++;
164 
165 
166  // Exports
167  $r = 1;
168 
169  // Example:
170  // $this->export_code[$r]=$this->rights_class.'_'.$r;
171  // $this->export_label[$r]='CustomersInvoicesAndInvoiceLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
172  // $this->export_permission[$r]=array(array("facture","facture","export"));
173  // $this->export_fields_array[$r]=array(
174  // 's.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone',
175  // 's.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode',
176  // 's.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.facnumber'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",
177  // 'f.datef'=>"DateInvoice",'f.total'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus',
178  // 'f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",'fd.qty'=>"LineQty",
179  // 'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",'fd.date_end'=>"DateEnd",
180  // 'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef'
181  //);
182  // $this->export_entities_array[$r]=array(
183  // 's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company',
184  // 's.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company',
185  // 'f.rowid'=>"invoice",'f.facnumber'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total'=>"invoice",'f.total_ttc'=>"invoice",'f.tva'=>"invoice",
186  // 'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",'fd.price'=>"invoice_line",
187  // 'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",'fd.qty'=>"invoice_line",
188  // 'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product'
189  //);
190  // $this->export_sql_start[$r]='SELECT DISTINCT ';
191  // $this->export_sql_end[$r] =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
192  // $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
193  // $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
194  // $r++;
195  }
196 }
197 
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
__construct($db)
Constructor.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:103
Description and activation class for module Gravatar.