dolibarr  18.0.0-alpha
modDav.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2004-2018 Laurent Destailleur <eldy@users.sourceforge.net>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <https://www.gnu.org/licenses/>.
16  */
17 
26 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
27 
28 
32 class modDav extends DolibarrModules
33 {
39  public function __construct($db)
40  {
41  global $langs, $conf;
42 
43  $this->db = $db;
44 
45  // Id for module (must be unique).
46  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
47  $this->numero = 50310;
48  // Key text used to identify module (for permissions, menus, etc...)
49  $this->rights_class = 'dav';
50 
51  // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
52  // It is used to group modules by family in module setup page
53  $this->family = "interface";
54  // Module position in the family on 2 digits ('01', '10', '20', ...)
55  $this->module_position = '75';
56  // Gives the possibility to the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this)
57  //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
58 
59  // Module label (no space allowed), used if translation string 'ModuledavName' not found (MyModue is name of module).
60  $this->name = preg_replace('/^mod/i', '', get_class($this));
61  // Module description, used if translation string 'ModuledavDesc' not found (MyModue is name of module).
62  $this->description = "davDescription";
63  // Used only if file README.md and README-LL.md not found.
64  $this->descriptionlong = "davDescription";
65 
66  // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
67  $this->version = 'dolibarr';
68  // Key used in llx_const table to save module status enabled/disabled (where DAV is value of property name of module in uppercase)
69  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
70  // Name of image file used for this module.
71  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
72  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
73  $this->picto = 'generic';
74 
75  // Defined all module parts (triggers, login, substitutions, menus, css, etc...)
76  // for default path (eg: /dav/core/xxxxx) (0=disable, 1=enable)
77  // for specific path of parts (eg: /dav/core/modules/barcode)
78  // for specific css file (eg: /dav/css/dav.css.php)
79  $this->module_parts = array();
80 
81  // Data directories to create when module is enabled.
82  // Example: this->dirs = array("/dav/temp","/dav/subdir");
83  $this->dirs = array("/dav/temp", "/dav/public", "/dav/private");
84 
85  // Config pages. Put here list of php page, stored into dav/admin directory, to use to setup module.
86  $this->config_page_url = array("dav.php");
87 
88  // Dependencies
89  $this->hidden = false; // A condition to hide module
90  $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
91  $this->requiredby = array(); // List of module ids to disable if this one is disabled
92  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
93  $this->langfiles = array("admin");
94  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
95  $this->need_dolibarr_version = array(7, 0); // Minimum version of Dolibarr required by module
96  $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
97  $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
98  //$this->automatic_activation = array('FR'=>'davWasAutomaticallyActivatedBecauseOfYourCountryChoice');
99  //$this->always_enabled = true; // If true, can't be disabled
100 
101  // Constants
102  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
103  // Example: $this->const=array(0=>array('DAV_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
104  // 1=>array('DAV_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
105  // );
106  $this->const = array(
107  //1=>array('DAV_MYCONSTANT', 'chaine', 'avalue', 'This is a constant to add', 1, 'allentities', 1)
108  );
109 
110 
111  if (!isset($conf->dav) || !isset($conf->dav->enabled)) {
112  $conf->dav = new stdClass();
113  $conf->dav->enabled = 0;
114  }
115 
116 
117  // Array to add new pages in new tabs
118  $this->tabs = array();
119  // Example:
120  // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@dav:$user->rights->dav->read:/dav/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
121  // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@dav:$user->rights->othermodule->read:/dav/mynewtab2.php?id=__ID__', // To add another new tab identified by code tabname2. Label will be result of calling all substitution functions on 'Title2' key.
122  // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
123  //
124  // Where objecttype can be
125  // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
126  // 'contact' to add a tab in contact view
127  // 'contract' to add a tab in contract view
128  // 'group' to add a tab in group view
129  // 'intervention' to add a tab in intervention view
130  // 'invoice' to add a tab in customer invoice view
131  // 'invoice_supplier' to add a tab in supplier invoice view
132  // 'member' to add a tab in fundation member view
133  // 'opensurveypoll' to add a tab in opensurvey poll view
134  // 'order' to add a tab in sales order view
135  // 'order_supplier' to add a tab in supplier order view
136  // 'payment' to add a tab in payment view
137  // 'payment_supplier' to add a tab in supplier payment view
138  // 'product' to add a tab in product view
139  // 'propal' to add a tab in propal view
140  // 'project' to add a tab in project view
141  // 'stock' to add a tab in stock view
142  // 'thirdparty' to add a tab in third party view
143  // 'user' to add a tab in user view
144 
145 
146  // Dictionaries
147  $this->dictionaries = array();
148 
149 
150  // Boxes/Widgets
151  // Add here list of php file(s) stored in dav/core/boxes that contains class to show a widget.
152  $this->boxes = array(
153  //0=>array('file'=>'davwidget1.php@dav','note'=>'Widget provided by dav','enabledbydefaulton'=>'Home'),
154  //1=>array('file'=>'davwidget2.php@dav','note'=>'Widget provided by dav'),
155  //2=>array('file'=>'davwidget3.php@dav','note'=>'Widget provided by dav')
156  );
157 
158 
159  // Cronjobs (List of cron jobs entries to add when module is enabled)
160  // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
161  //$this->cronjobs = array(
162  //0=>array('label'=>'MyJob label', 'jobtype'=>'method', 'class'=>'/dav/class/myobject.class.php', 'objectname'=>'MyObject', 'method'=>'doScheduledJob', 'parameters'=>'', 'comment'=>'Comment', 'frequency'=>2, 'unitfrequency'=>3600, 'status'=>0, 'test'=>true)
163  //);
164  // Example: $this->cronjobs=array(0=>array('label'=>'My label', 'jobtype'=>'method', 'class'=>'/dir/class/file.class.php', 'objectname'=>'MyClass', 'method'=>'myMethod', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>2, 'unitfrequency'=>3600, 'status'=>0, 'test'=>true),
165  // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>true)
166  // );
167 
168 
169  // Permissions
170  $this->rights = array(); // Permission array used by this module
171 
172  /*
173  $r=0;
174  $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
175  $this->rights[$r][1] = 'Read myobject of dav'; // Permission label
176  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
177  $this->rights[$r][4] = 'read'; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
178  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
179 
180  $r++;
181  $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
182  $this->rights[$r][1] = 'Create/Update myobject of dav'; // Permission label
183  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
184  $this->rights[$r][4] = 'write'; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
185  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
186 
187  $r++;
188  $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
189  $this->rights[$r][1] = 'Delete myobject of dav'; // Permission label
190  $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
191  $this->rights[$r][4] = 'delete'; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
192  $this->rights[$r][5] = ''; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
193  */
194 
195  // Main menu entries
196  $this->menu = array(); // List of menus to add
197  $r = 0;
198 
199  // Add here entries to declare new menus
200 
201  /* BEGIN MODULEBUILDER TOPMENU */
202  /*$this->menu[$r++]=array('fk_menu'=>'', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
203  'type'=>'top', // This is a Top menu entry
204  'titre'=>'dav',
205  'mainmenu'=>'dav',
206  'leftmenu'=>'',
207  'url'=>'/dav/davindex.php',
208  'langs'=>'dav@dav', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
209  'position'=>1000+$r,
210  'enabled'=>'$conf->dav->enabled', // Define condition to show or hide menu entry. Use '$conf->dav->enabled' if entry must be visible if module is enabled.
211  'perms'=>'1', // Use 'perms'=>'$user->rights->dav->level1->level2' if you want your menu with a permission rules
212  'target'=>'',
213  'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
214  */
215  /* END MODULEBUILDER TOPMENU */
216 
217  /* BEGIN MODULEBUILDER LEFTMENU MYOBJECT
218  $this->menu[$r++]=array( 'fk_menu'=>'fk_mainmenu=dav', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
219  'type'=>'left', // This is a Left menu entry
220  'titre'=>'List MyObject',
221  'mainmenu'=>'dav',
222  'leftmenu'=>'dav_myobject_list',
223  'url'=>'/dav/myobject_list.php',
224  'langs'=>'dav@dav', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
225  'position'=>1000+$r,
226  'enabled'=>'$conf->dav->enabled', // Define condition to show or hide menu entry. Use '$conf->dav->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
227  'perms'=>'1', // Use 'perms'=>'$user->rights->dav->level1->level2' if you want your menu with a permission rules
228  'target'=>'',
229  'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
230  $this->menu[$r++]=array( 'fk_menu'=>'fk_mainmenu=dav,fk_leftmenu=dav', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
231  'type'=>'left', // This is a Left menu entry
232  'titre'=>'New MyObject',
233  'mainmenu'=>'dav',
234  'leftmenu'=>'dav_myobject_new',
235  'url'=>'/dav/myobject_page.php?action=create',
236  'langs'=>'dav@dav', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
237  'position'=>1000+$r,
238  'enabled'=>'$conf->dav->enabled', // Define condition to show or hide menu entry. Use '$conf->dav->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
239  'perms'=>'1', // Use 'perms'=>'$user->rights->dav->level1->level2' if you want your menu with a permission rules
240  'target'=>'',
241  'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
242  END MODULEBUILDER LEFTMENU MYOBJECT */
243  }
244 
253  public function init($options = '')
254  {
255  // Create extrafields
256  include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
257  $extrafields = new ExtraFields($this->db);
258 
259  //$result1=$extrafields->addExtraField('myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
260  //$result2=$extrafields->addExtraField('myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
261  //$result3=$extrafields->addExtraField('myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
262  //$result4=$extrafields->addExtraField('myattr4', "New Attr 4 label", 'select', 1, 3, 'thirdparty', 0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1 '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
263  //$result5=$extrafields->addExtraField('myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
264 
265  $sql = array();
266 
267  return $this->_init($sql, $options);
268  }
269 
278  public function remove($options = '')
279  {
280  $sql = array();
281 
282  return $this->_remove($sql, $options);
283  }
284 }
db
$conf db
API class for accounts.
Definition: inc.php:41
modDav
Description and activation class for module dav.
Definition: modDav.class.php:32
description
print *****$script_file(".$version.") pid cd cd cd description as description
Definition: email_expire_services_to_customers.php:83
$sql
if(isModEnabled('facture') &&!empty($user->rights->facture->lire)) if((isModEnabled('fournisseur') &&empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD) && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') &&!empty($user->rights->don->lire)) if(isModEnabled('tax') &&!empty($user->rights->tax->charges->lire)) if(isModEnabled('facture') &&isModEnabled('commande') && $user->hasRight("commande", "lire") &&empty($conf->global->WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER)) $sql
Social contributions to pay.
Definition: index.php:745
modDav\init
init($options='')
Function called when module is enabled.
Definition: modDav.class.php:253
name
$conf db name
Definition: repair.php:123
DolibarrModules\_remove
_remove($array_sql, $options='')
Disable function.
Definition: DolibarrModules.class.php:519
modDav\__construct
__construct($db)
Constructor.
Definition: modDav.class.php:39
DolibarrModules\_init
_init($array_sql, $options='')
Enables a module.
Definition: DolibarrModules.class.php:420
ExtraFields
Class to manage standard extra fields.
Definition: extrafields.class.php:39
DolibarrModules
Class DolibarrModules.
Definition: DolibarrModules.class.php:37