dolibarr  17.0.3
modDataPolicy.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2004-2018 Laurent Destailleur <eldy@users.sourceforge.net>
3  * Copyright (C) 2018 Nicolas ZABOURI <info@inovea-conseil.com>
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 <https://www.gnu.org/licenses/>.
17  */
18 
27 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
28 
29 
30 
31 // The class name should start with a lower case mod for Dolibarr to pick it up
32 // so we ignore the Squiz.Classes.ValidClassName.NotCamelCaps rule.
33 // @codingStandardsIgnoreStart
38 
39  // @codingStandardsIgnoreEnd
45  public function __construct($db)
46  {
47  global $langs, $conf;
48 
49  $this->db = $db;
50 
51  // Id for module (must be unique).
52  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
53  $this->numero = 4100;
54  // Key text used to identify module (for permissions, menus, etc...)
55  $this->rights_class = 'datapolicy';
56 
57  // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
58  // It is used to group modules by family in module setup page
59  $this->family = "technic";
60  // Module position in the family on 2 digits ('01', '10', '20', ...)
61  $this->module_position = '78';
62  // 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)
63  //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
64  // Module label (no space allowed), used if translation string 'ModuledatapolicyName' not found (MyModue is name of module).
65  $this->name = preg_replace('/^mod/i', '', get_class($this));
66  // Module description, used if translation string 'ModuledatapolicyDesc' not found (MyModue is name of module).
67  $this->description = "Module to manage Data policy (for compliance with GDPR in Europe or other Data policy rules)";
68  // Used only if file README.md and README-LL.md not found.
69  $this->descriptionlong = "";
70 
71  // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
72  $this->version = 'experimental';
73  // Key used in llx_const table to save module status enabled/disabled (where datapolicy is value of property name of module in uppercase)
74  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
75  // Name of image file used for this module.
76  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
77  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
78  $this->picto = 'generic';
79 
80  // Defined all module parts (triggers, login, substitutions, menus, css, etc...)
81  // for default path (eg: /datapolicy/core/xxxxx) (0=disable, 1=enable)
82  // for specific path of parts (eg: /datapolicy/core/modules/barcode)
83  // for specific css file (eg: /datapolicy/css/datapolicy.css.php)
84  $this->module_parts = array(
85  'triggers' => 0, // Set this to 1 if module has its own trigger directory (core/triggers)
86  'login' => 0, // Set this to 1 if module has its own login method file (core/login)
87  'substitutions' => 0, // Set this to 1 if module has its own substitution function file (core/substitutions)
88  'menus' => 0, // Set this to 1 if module has its own menus handler directory (core/menus)
89  'theme' => 0, // Set this to 1 if module has its own theme directory (theme)
90  'tpl' => 0, // Set this to 1 if module overwrite template dir (core/tpl)
91  'barcode' => 0, // Set this to 1 if module has its own barcode directory (core/modules/barcode)
92  'models' => 0, // Set this to 1 if module has its own models directory (core/modules/xxx)
93  'hooks' => array('data' => array('membercard', 'contactcard', 'thirdpartycard'), 'entity' => $conf->entity) // Set here all hooks context managed by module. To find available hook context, make a "grep -r '>initHooks(' *" on source code. You can also set hook context 'all'
94  );
95 
96  // Data directories to create when module is enabled.
97  // Example: this->dirs = array("/datapolicy/temp","/datapolicy/subdir");
98  $this->dirs = array("/datapolicy/temp");
99 
100  // Config pages. Put here list of php page, stored into datapolicy/admin directory, to use to setup module.
101  $this->config_page_url = array("setup.php@datapolicy");
102 
103  // Dependencies
104  $this->hidden = false; // A condition to hide module
105  $this->depends = array('always'=>'modCron'); // List of module class names as string that must be enabled if this module is enabled
106  $this->requiredby = array(); // List of module ids to disable if this one is disabled
107  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
108  $this->langfiles = array("datapolicy");
109  $this->phpmin = array(5, 3); // Minimum version of PHP required by module
110  $this->need_dolibarr_version = array(7, 0); // Minimum version of Dolibarr required by module
111  $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
112  $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
113  //$this->automatic_activation = array('FR'=>'datapolicyWasAutomaticallyActivatedBecauseOfYourCountryChoice');
114  //$this->always_enabled = true; // If true, can't be disabled
115  // Constants
116  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
117  // Example: $this->const=array(0=>array('datapolicy_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
118  // 1=>array('datapolicy_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
119  // );
120  $this->const = array(
121  array('DATAPOLICY_TIERS_CLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
122  array('DATAPOLICY_TIERS_PROSPECT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
123  array('DATAPOLICY_TIERS_PROSPECT_CLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
124  array('DATAPOLICY_TIERS_NIPROSPECT_NICLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
125  array('DATAPOLICY_TIERS_FOURNISSEUR', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
126  array('DATAPOLICY_CONTACT_CLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
127  array('DATAPOLICY_CONTACT_PROSPECT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
128  array('DATAPOLICY_CONTACT_PROSPECT_CLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
129  array('DATAPOLICY_CONTACT_NIPROSPECT_NICLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
130  array('DATAPOLICY_CONTACT_FOURNISSEUR', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
131  array('DATAPOLICY_ADHERENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
132  );
133 
134  $country = explode(":", empty($conf->global->MAIN_INFO_SOCIETE_COUNTRY) ? '' : $conf->global->MAIN_INFO_SOCIETE_COUNTRY);
135 
136  // Some keys to add into the overwriting translation tables
137  /* $this->overwrite_translation = array(
138  'en_US:ParentCompany'=>'Parent company or reseller',
139  'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
140  ) */
141 
142  if (!isset($conf->datapolicy) || !isset($conf->datapolicy->enabled)) {
143  $conf->datapolicy = new stdClass();
144  $conf->datapolicy->enabled = 0;
145  }
146 
147 
148  // Array to add new pages in new tabs
149  $this->tabs = array();
150  // Example:
151  // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@datapolicy:$user->rights->datapolicy->read:/datapolicy/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
152  // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@datapolicy:$user->rights->othermodule->read:/datapolicy/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.
153  // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
154  //
155  // Where objecttype can be
156  // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
157  // 'contact' to add a tab in contact view
158  // 'contract' to add a tab in contract view
159  // 'group' to add a tab in group view
160  // 'intervention' to add a tab in intervention view
161  // 'invoice' to add a tab in customer invoice view
162  // 'invoice_supplier' to add a tab in supplier invoice view
163  // 'member' to add a tab in fundation member view
164  // 'opensurveypoll' to add a tab in opensurvey poll view
165  // 'order' to add a tab in sales order view
166  // 'order_supplier' to add a tab in supplier order view
167  // 'payment' to add a tab in payment view
168  // 'payment_supplier' to add a tab in supplier payment view
169  // 'product' to add a tab in product view
170  // 'propal' to add a tab in propal view
171  // 'project' to add a tab in project view
172  // 'stock' to add a tab in stock view
173  // 'thirdparty' to add a tab in third party view
174  // 'user' to add a tab in user view
175 
176 
177  // Dictionaries
178  $this->dictionaries = array();
179 
180 
181  // Boxes/Widgets
182  // Add here list of php file(s) stored in datapolicy/core/boxes that contains class to show a widget.
183  $this->boxes = array();
184 
185 
186  // Cronjobs (List of cron jobs entries to add when module is enabled)
187  // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
188  $this->cronjobs = array(
189  0 => array('label' => 'DATAPOLICYJob', 'jobtype' => 'method', 'class' => 'datapolicy/class/datapolicycron.class.php', 'objectname' => 'DataPolicyCron', 'method' => 'cleanDataForDataPolicy', 'parameters' => '', 'comment' => 'Clean data', 'frequency' => 1, 'unitfrequency' => 86400, 'status' => 1, 'test' => '$conf->datapolicy->enabled'),
190  );
191  // 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),
192  // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>true)
193  // );
194  // Permissions
195  $this->rights = array(); // Permission array used by this module
196  // Main menu entries
197  $this->menu = array(); // List of menus to add
198  $r = 0;
199  }
200 
209  public function init($options = '')
210  {
211  global $langs;
212 
213  // Create extrafields
214  include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
215  $extrafields = new ExtraFields($this->db);
216 
217  /*
218  // Extrafield contact
219  $result1 = $extrafields->addExtraField('datapolicy_consentement', $langs->trans("DATAPOLICY_consentement"), 'boolean', 101, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
220  $result1 = $extrafields->addExtraField('datapolicy_opposition_traitement', $langs->trans("DATAPOLICY_opposition_traitement"), 'boolean', 102, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
221  $result1 = $extrafields->addExtraField('datapolicy_opposition_prospection', $langs->trans("DATAPOLICY_opposition_prospection"), 'boolean', 103, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
222  $result1 = $extrafields->addExtraField('datapolicy_date', $langs->trans("DATAPOLICY_date"), 'date', 104, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0);
223  $result1 = $extrafields->addExtraField('datapolicy_send', $langs->trans("DATAPOLICY_send"), 'date', 105, 3, 'thirdparty', 0, 0, '', '', 0, '', '0', 0);
224 
225  // Extrafield Tiers
226  $result1 = $extrafields->addExtraField('datapolicy_consentement', $langs->trans("DATAPOLICY_consentement"), 'boolean', 101, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
227  $result1 = $extrafields->addExtraField('datapolicy_opposition_traitement', $langs->trans("DATAPOLICY_opposition_traitement"), 'boolean', 102, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
228  $result1 = $extrafields->addExtraField('datapolicy_opposition_prospection', $langs->trans("DATAPOLICY_opposition_prospection"), 'boolean', 103, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
229  $result1 = $extrafields->addExtraField('datapolicy_date', $langs->trans("DATAPOLICY_date"), 'date', 104, 3, 'contact', 0, 0, '', '', 1, '', '3', 0);
230  $result1 = $extrafields->addExtraField('datapolicy_send', $langs->trans("DATAPOLICY_send"), 'date', 105, 3, 'contact', 0, 0, '', '', 0, '', '0', 0);
231 
232  // Extrafield Adherent
233  $result1 = $extrafields->addExtraField('datapolicy_consentement', $langs->trans("DATAPOLICY_consentement"), 'boolean', 101, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
234  $result1 = $extrafields->addExtraField('datapolicy_opposition_traitement', $langs->trans("DATAPOLICY_opposition_traitement"), 'boolean', 102, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
235  $result1 = $extrafields->addExtraField('datapolicy_opposition_prospection', $langs->trans("DATAPOLICY_opposition_prospection"), 'boolean', 103, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
236  $result1 = $extrafields->addExtraField('datapolicy_date', $langs->trans("DATAPOLICY_date"), 'date', 104, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0);
237  $result1 = $extrafields->addExtraField('datapolicy_send', $langs->trans("DATAPOLICY_send"), 'date', 105, 3, 'adherent', 0, 0, '', '', 0, '', '0', 0);
238  */
239 
240  $sql = array();
241 
242  return $this->_init($sql, $options);
243  }
244 
253  public function remove($options = '')
254  {
255  $sql = array();
256 
257  return $this->_remove($sql, $options);
258  }
259 }
db
$conf db
API class for accounts.
Definition: inc.php:41
description
print *****$script_file(".$version.") pid cd cd cd description as description
Definition: email_expire_services_to_customers.php:83
name
$conf db name
Definition: repair.php:122
DolibarrModules\_remove
_remove($array_sql, $options='')
Disable function.
Definition: DolibarrModules.class.php:496
DolibarrModules\_init
_init($array_sql, $options='')
Enables a module.
Definition: DolibarrModules.class.php:397
modDataPolicy\init
init($options='')
Function called when module is enabled.
Definition: modDataPolicy.class.php:209
ExtraFields
Class to manage standard extra fields.
Definition: extrafields.class.php:39
modDataPolicy\__construct
__construct($db)
Constructor.
Definition: modDataPolicy.class.php:45
DolibarrModules
Class DolibarrModules.
Definition: DolibarrModules.class.php:37
modDataPolicy
Description and activation class for module datapolicy.
Definition: modDataPolicy.class.php:37