dolibarr 20.0.0
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
27include_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.Class.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 = 'lock';
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
86 // Data directories to create when module is enabled.
87 // Example: this->dirs = array("/datapolicy/temp","/datapolicy/subdir");
88 $this->dirs = array("/datapolicy/temp");
89
90 // Config pages. Put here list of php page, stored into datapolicy/admin directory, to use to setup module.
91 $this->config_page_url = array("setup.php@datapolicy");
92
93 // Dependencies
94 $this->hidden = false; // A condition to hide module
95 $this->depends = array('always'=>'modCron'); // List of module class names as string that must be enabled if this module is enabled
96 $this->requiredby = array(); // List of module ids to disable if this one is disabled
97 $this->conflictwith = array(); // List of module class names as string this module is in conflict with
98 $this->langfiles = array("datapolicy");
99 $this->phpmin = array(5, 3); // Minimum version of PHP required by module
100 $this->need_dolibarr_version = array(7, 0); // Minimum version of Dolibarr required by module
101 $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
102 $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
103 //$this->automatic_activation = array('FR'=>'datapolicyWasAutomaticallyActivatedBecauseOfYourCountryChoice');
104 //$this->always_enabled = true; // If true, can't be disabled
105 // Constants
106 // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
107 // Example: $this->const=array(0=>array('datapolicy_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
108 // 1=>array('datapolicy_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
109 // );
110 $this->const = array(
111 array('DATAPOLICY_TIERS_CLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
112 array('DATAPOLICY_TIERS_PROSPECT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
113 array('DATAPOLICY_TIERS_PROSPECT_CLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
114 array('DATAPOLICY_TIERS_NIPROSPECT_NICLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
115 array('DATAPOLICY_TIERS_FOURNISSEUR', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
116 array('DATAPOLICY_CONTACT_CLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
117 array('DATAPOLICY_CONTACT_PROSPECT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
118 array('DATAPOLICY_CONTACT_PROSPECT_CLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
119 array('DATAPOLICY_CONTACT_NIPROSPECT_NICLIENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
120 array('DATAPOLICY_CONTACT_FOURNISSEUR', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
121 array('DATAPOLICY_ADHERENT', 'chaine', '', $langs->trans('NUMBER_MONTH_BEFORE_DELETION'), 0),
122 );
123
124 $country = explode(":", !getDolGlobalString('MAIN_INFO_SOCIETE_COUNTRY') ? '' : $conf->global->MAIN_INFO_SOCIETE_COUNTRY);
125
126 // Some keys to add into the overwriting translation tables
127 /* $this->overwrite_translation = array(
128 'en_US:ParentCompany'=>'Parent company or reseller',
129 'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
130 ) */
131
132 if (!isset($conf->datapolicy) || !isset($conf->datapolicy->enabled)) {
133 $conf->datapolicy = new stdClass();
134 $conf->datapolicy->enabled = 0;
135 }
136
137
138 // Array to add new pages in new tabs
139 $this->tabs = array();
140 // Example:
141 // $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
142 // $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.
143 // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
144 //
145 // Where objecttype can be
146 // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
147 // 'contact' to add a tab in contact view
148 // 'contract' to add a tab in contract view
149 // 'group' to add a tab in group view
150 // 'intervention' to add a tab in intervention view
151 // 'invoice' to add a tab in customer invoice view
152 // 'invoice_supplier' to add a tab in supplier invoice view
153 // 'member' to add a tab in foundation member view
154 // 'opensurveypoll' to add a tab in opensurvey poll view
155 // 'order' to add a tab in sales order view
156 // 'order_supplier' to add a tab in supplier order view
157 // 'payment' to add a tab in payment view
158 // 'payment_supplier' to add a tab in supplier payment view
159 // 'product' to add a tab in product view
160 // 'propal' to add a tab in propal view
161 // 'project' to add a tab in project view
162 // 'stock' to add a tab in stock view
163 // 'thirdparty' to add a tab in third party view
164 // 'user' to add a tab in user view
165
166
167 // Dictionaries
168 $this->dictionaries = array();
169
170
171 // Boxes/Widgets
172 // Add here list of php file(s) stored in datapolicy/core/boxes that contains class to show a widget.
173 $this->boxes = array();
174
175
176 // Cronjobs (List of cron jobs entries to add when module is enabled)
177 // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
178 $this->cronjobs = array(
179 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'),
180 );
181 // 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),
182 // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>true)
183 // );
184 // Permissions
185 $this->rights = array(); // Permission array used by this module
186 // Main menu entries
187 $this->menu = array(); // List of menus to add
188 $r = 0;
189 }
190
199 public function init($options = '')
200 {
201 global $langs;
202
203 // Create extrafields
204 include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
205 $extrafields = new ExtraFields($this->db);
206
207 /*
208 // Extrafield contact
209 $result1 = $extrafields->addExtraField('datapolicy_consentement', $langs->trans("DATAPOLICY_consentement"), 'boolean', 101, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
210 $result1 = $extrafields->addExtraField('datapolicy_opposition_traitement', $langs->trans("DATAPOLICY_opposition_traitement"), 'boolean', 102, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
211 $result1 = $extrafields->addExtraField('datapolicy_opposition_prospection', $langs->trans("DATAPOLICY_opposition_prospection"), 'boolean', 103, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
212 $result1 = $extrafields->addExtraField('datapolicy_date', $langs->trans("DATAPOLICY_date"), 'date', 104, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0);
213 $result1 = $extrafields->addExtraField('datapolicy_send', $langs->trans("DATAPOLICY_send"), 'date', 105, 3, 'thirdparty', 0, 0, '', '', 0, '', '0', 0);
214
215 // Extrafield Tiers
216 $result1 = $extrafields->addExtraField('datapolicy_consentement', $langs->trans("DATAPOLICY_consentement"), 'boolean', 101, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
217 $result1 = $extrafields->addExtraField('datapolicy_opposition_traitement', $langs->trans("DATAPOLICY_opposition_traitement"), 'boolean', 102, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
218 $result1 = $extrafields->addExtraField('datapolicy_opposition_prospection', $langs->trans("DATAPOLICY_opposition_prospection"), 'boolean', 103, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
219 $result1 = $extrafields->addExtraField('datapolicy_date', $langs->trans("DATAPOLICY_date"), 'date', 104, 3, 'contact', 0, 0, '', '', 1, '', '3', 0);
220 $result1 = $extrafields->addExtraField('datapolicy_send', $langs->trans("DATAPOLICY_send"), 'date', 105, 3, 'contact', 0, 0, '', '', 0, '', '0', 0);
221
222 // Extrafield Adherent
223 $result1 = $extrafields->addExtraField('datapolicy_consentement', $langs->trans("DATAPOLICY_consentement"), 'boolean', 101, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
224 $result1 = $extrafields->addExtraField('datapolicy_opposition_traitement', $langs->trans("DATAPOLICY_opposition_traitement"), 'boolean', 102, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
225 $result1 = $extrafields->addExtraField('datapolicy_opposition_prospection', $langs->trans("DATAPOLICY_opposition_prospection"), 'boolean', 103, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicy', '$conf->datapolicy->enabled');
226 $result1 = $extrafields->addExtraField('datapolicy_date', $langs->trans("DATAPOLICY_date"), 'date', 104, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0);
227 $result1 = $extrafields->addExtraField('datapolicy_send', $langs->trans("DATAPOLICY_send"), 'date', 105, 3, 'adherent', 0, 0, '', '', 0, '', '0', 0);
228 */
229
230 $sql = array();
231
232 return $this->_init($sql, $options);
233 }
234
243 public function remove($options = '')
244 {
245 $sql = array();
246
247 return $this->_remove($sql, $options);
248 }
249}
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
_remove($array_sql, $options='')
Disable function.
Class to manage standard extra fields.
Description and activation class for module datapolicy.
__construct($db)
Constructor.
init($options='')
Function called when module is enabled.
print $script_file $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:140