Completed
Branch develop (6390f5)
by
unknown
27:55
created

modDataPolicies::__construct()   B

Complexity

Conditions 3
Paths 2

Size

Total Lines 170

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 2
nop 1
dl 0
loc 170
rs 8
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/* Copyright (C) 2004-2018 Laurent Destailleur  <[email protected]>
4
 * Copyright (C) 2018      Nicolas ZABOURI      <[email protected]>
5
 *
6
 * This program is free software; you can redistribute it and/or modify
7
 * it under the terms of the GNU General Public License as published by
8
 * the Free Software Foundation; either version 3 of the License, or
9
 * (at your option) any later version.
10
 *
11
 * This program is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 * GNU General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU General Public License
17
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18
 */
19
20
/**
21
 * 	\defgroup   datapolicies     Module datapolicies
22
 *  \brief      datapolicies module descriptor.
23
 *
24
 *  \file       htdocs/datapolicies/core/modules/modGdpr.class.php
25
 *  \ingroup    datapolicies
26
 *  \brief      Description and activation file for module DATAPOLICIES
27
 */
28
include_once DOL_DOCUMENT_ROOT . '/core/modules/DolibarrModules.class.php';
29
30
31
32
// The class name should start with a lower case mod for Dolibarr to pick it up
33
// so we ignore the Squiz.Classes.ValidClassName.NotCamelCaps rule.
34
// @codingStandardsIgnoreStart
35
/**
36
 *  Description and activation class for module datapolicies
37
 */
38
class modDataPolicies extends DolibarrModules {
39
40
    // @codingStandardsIgnoreEnd
41
    /**
42
     * Constructor. Define names, constants, directories, boxes, permissions
43
     *
44
     * @param DoliDB $db Database handler
45
     */
46
    public function __construct($db)
47
    {
48
        global $langs, $conf;
49
50
        $this->db = $db;
51
52
        // Id for module (must be unique).
53
        // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
54
        $this->numero = 4100;
55
        // Key text used to identify module (for permissions, menus, etc...)
56
        $this->rights_class = 'datapolicies';
57
58
        // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
59
        // It is used to group modules by family in module setup page
60
        $this->family = "hr";
61
        // Module position in the family on 2 digits ('01', '10', '20', ...)
62
        $this->module_position = '70';
63
        // 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)
64
        //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
65
        // Module label (no space allowed), used if translation string 'ModuledatapoliciesName' not found (MyModue is name of module).
66
        $this->name = preg_replace('/^mod/i', '', get_class($this));
67
        // Module description, used if translation string 'ModuledatapoliciesDesc' not found (MyModue is name of module).
68
        $this->description = "Module to manage Data policies (for compliance with GDPR in Europe or other Data policies rules)";
69
        // Used only if file README.md and README-LL.md not found.
70
        $this->descriptionlong = "";
71
72
        // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
73
        $this->version = 'development';
74
        // Key used in llx_const table to save module status enabled/disabled (where datapolicies is value of property name of module in uppercase)
75
        $this->const_name = 'MAIN_MODULE_' . strtoupper($this->name);
76
        // Name of image file used for this module.
77
        // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
78
        // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
79
        $this->picto = 'generic';
80
81
        // Defined all module parts (triggers, login, substitutions, menus, css, etc...)
82
        // for default path (eg: /datapolicies/core/xxxxx) (0=disable, 1=enable)
83
        // for specific path of parts (eg: /datapolicies/core/modules/barcode)
84
        // for specific css file (eg: /datapolicies/css/datapolicies.css.php)
85
        $this->module_parts = array(
86
            'triggers' => 0, // Set this to 1 if module has its own trigger directory (core/triggers)
87
            'login' => 0, // Set this to 1 if module has its own login method file (core/login)
88
            'substitutions' => 0, // Set this to 1 if module has its own substitution function file (core/substitutions)
89
            'menus' => 0, // Set this to 1 if module has its own menus handler directory (core/menus)
90
            'theme' => 0, // Set this to 1 if module has its own theme directory (theme)
91
            'tpl' => 0, // Set this to 1 if module overwrite template dir (core/tpl)
92
            'barcode' => 0, // Set this to 1 if module has its own barcode directory (core/modules/barcode)
93
            'models' => 0, // Set this to 1 if module has its own models directory (core/modules/xxx)
94
            'css' => array('/datapolicies/css/datapolicies.css.php'), // Set this to relative path of css file if module has its own css file
95
            'js' => array('/datapolicies/js/datapolicies.js.php'), // Set this to relative path of js file if module must load a js on all pages
96
            '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'
97
        );
98
99
        // Data directories to create when module is enabled.
100
        // Example: this->dirs = array("/datapolicies/temp","/datapolicies/subdir");
101
        $this->dirs = array("/datapolicies/temp");
102
103
        // Config pages. Put here list of php page, stored into datapolicies/admin directory, to use to setup module.
104
        $this->config_page_url = array("setup.php@datapolicies");
105
106
        // Dependencies
107
        $this->hidden = false;   // A condition to hide module
108
        $this->depends = array();  // List of module class names as string that must be enabled if this module is enabled
109
        $this->requiredby = array(); // List of module ids to disable if this one is disabled
110
        $this->conflictwith = array(); // List of module class names as string this module is in conflict with
111
        $this->langfiles = array("datapolicies@datapolicies");
112
        $this->phpmin = array(5, 3);     // Minimum version of PHP required by module
113
        $this->need_dolibarr_version = array(4, 0); // Minimum version of Dolibarr required by module
114
        $this->warnings_activation = array();                     // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
115
        $this->warnings_activation_ext = array();                 // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
116
        //$this->automatic_activation = array('FR'=>'datapoliciesWasAutomaticallyActivatedBecauseOfYourCountryChoice');
117
        //$this->always_enabled = true;								// If true, can't be disabled
118
        // Constants
119
        // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
120
        // Example: $this->const=array(0=>array('datapolicies_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
121
        //                             1=>array('datapolicies_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
122
        // );
123
        $this->const = array(
124
            array('DATAPOLICIES_TIERS_CLIENT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
125
            array('DATAPOLICIES_TIERS_PROSPECT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
126
            array('DATAPOLICIES_TIERS_PROSPECT_CLIENT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
127
            array('DATAPOLICIES_TIERS_NIPROSPECT_NICLIENT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
128
            array('DATAPOLICIES_TIERS_FOURNISSEUR', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
129
            array('DATAPOLICIES_CONTACT_CLIENT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
130
            array('DATAPOLICIES_CONTACT_PROSPECT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
131
            array('DATAPOLICIES_CONTACT_PROSPECT_CLIENT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
132
            array('DATAPOLICIES_CONTACT_NIPROSPECT_NICLIENT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
133
            array('DATAPOLICIES_CONTACT_FOURNISSEUR', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
134
            array('DATAPOLICIES_ADHERENT', 'chaine', '', 'Nombre de mois avant suppression des données', 0),
135
        );
136
137
        $country = explode(":", $conf->global->MAIN_INFO_SOCIETE_COUNTRY);
138
139
        // Some keys to add into the overwriting translation tables
140
        /* $this->overwrite_translation = array(
141
          'en_US:ParentCompany'=>'Parent company or reseller',
142
          'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
143
          ) */
144
145
        if (!isset($conf->datapolicies) || !isset($conf->datapolicies->enabled)) {
146
            $conf->datapolicies = new stdClass();
147
            $conf->datapolicies->enabled = 0;
148
        }
149
150
151
        // Array to add new pages in new tabs
152
        $this->tabs = array();
153
        // Example:
154
        // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@datapolicies:$user->rights->datapolicies->read:/datapolicies/mynewtab1.php?id=__ID__');  					// To add a new tab identified by code tabname1
155
        // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@datapolicies:$user->rights->othermodule->read:/datapolicies/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.
156
        // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove');                                                     										// To remove an existing tab identified by code tabname
157
        //
158
        // Where objecttype can be
159
        // 'categories_x'	  to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
160
        // 'contact'          to add a tab in contact view
161
        // 'contract'         to add a tab in contract view
162
        // 'group'            to add a tab in group view
163
        // 'intervention'     to add a tab in intervention view
164
        // 'invoice'          to add a tab in customer invoice view
165
        // 'invoice_supplier' to add a tab in supplier invoice view
166
        // 'member'           to add a tab in fundation member view
167
        // 'opensurveypoll'	  to add a tab in opensurvey poll view
168
        // 'order'            to add a tab in customer order view
169
        // 'order_supplier'   to add a tab in supplier order view
170
        // 'payment'		  to add a tab in payment view
171
        // 'payment_supplier' to add a tab in supplier payment view
172
        // 'product'          to add a tab in product view
173
        // 'propal'           to add a tab in propal view
174
        // 'project'          to add a tab in project view
175
        // 'stock'            to add a tab in stock view
176
        // 'thirdparty'       to add a tab in third party view
177
        // 'user'             to add a tab in user view
178
        // Dictionaries
179
        $this->dictionaries = array();
180
        /* Example:
181
          $this->dictionaries=array(
182
          'langs'=>'mylangfile@datapolicies',
183
          'tabname'=>array(MAIN_DB_PREFIX."table1",MAIN_DB_PREFIX."table2",MAIN_DB_PREFIX."table3"),		// List of tables we want to see into dictonnary editor
184
          'tablib'=>array("Table1","Table2","Table3"),													// Label of tables
185
          'tabsql'=>array('SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table1 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table2 as f','SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table3 as f'),	// Request to select fields
186
          'tabsqlsort'=>array("label ASC","label ASC","label ASC"),																					// Sort order
187
          'tabfield'=>array("code,label","code,label","code,label"),																					// List of fields (result of select to show dictionary)
188
          'tabfieldvalue'=>array("code,label","code,label","code,label"),																				// List of fields (list of fields to edit a record)
189
          'tabfieldinsert'=>array("code,label","code,label","code,label"),																			// List of fields (list of fields for insert)
190
          'tabrowid'=>array("rowid","rowid","rowid"),																									// Name of columns with primary key (try to always name it 'rowid')
191
          'tabcond'=>array($conf->datapolicies->enabled,$conf->datapolicies->enabled,$conf->datapolicies->enabled)												// Condition to show each dictionary
192
          );
193
         */
194
195
196
        // Boxes/Widgets
197
        // Add here list of php file(s) stored in datapolicies/core/boxes that contains class to show a widget.
198
        $this->boxes = array();
199
200
201
        // Cronjobs (List of cron jobs entries to add when module is enabled)
202
        // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
203
        $this->cronjobs = array(
204
            0 => array('label' => 'DATAPOLICIES Cron', 'jobtype' => 'method', 'class' => '/datapolicies/class/datapoliciesCron.class.php', 'objectname' => 'RgpdCron', 'method' => 'exec', 'parameters' => '', 'comment' => 'Comment', 'frequency' => 1, 'unitfrequency' => 86400, 'status' => 1, 'test' => true),
205
            1 => array('label' => 'DATAPOLICIES Mailing', 'jobtype' => 'method', 'class' => '/datapolicies/class/datapoliciesCron.class.php', 'objectname' => 'RgpdCron', 'method' => 'sendMailing', 'parameters' => '', 'comment' => 'Comment', 'frequency' => 1, 'unitfrequency' => 86400, 'status' => 0, 'test' => true)
206
        );
207
        // 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),
208
        //                                1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>true)
209
        // );
210
        // Permissions
211
        $this->rights = array();  // Permission array used by this module
212
        // Main menu entries
213
        $this->menu = array();   // List of menus to add
214
        $r = 0;
215
    }
216
217
    /**
218
     * 	Function called when module is enabled.
219
     * 	The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
220
     * 	It also creates data directories
221
     *
222
     * 	@param      string	$options    Options when enabling module ('', 'noboxes')
223
     * 	@return     int             	1 if OK, 0 if KO
224
     */
225
    public function init($options = '')
226
    {
227
    	global $langs;
228
229
    	$this->_load_tables('/datapolicies/sql/');
230
231
        // Create extrafields
232
        include_once DOL_DOCUMENT_ROOT . '/core/class/extrafields.class.php';
233
        $extrafields = new ExtraFields($this->db);
234
235
236
        // Extrafield contact
237
        //$result1=$extrafields->addExtraField('datapolicies_separate', "DATAPOLICIES_BLOCKCHECKBOX", 'separate', 100,  1, 'thirdparty',   0, 0, '', '', 1, '', '1', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
238
        $result1 = $extrafields->addExtraField('datapolicies_consentement', "DATAPOLICIES_consentement", 'boolean', 101, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
239
        $result1 = $extrafields->addExtraField('datapolicies_opposition_traitement', "DATAPOLICIES_opposition_traitement", 'boolean', 102, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
240
        $result1 = $extrafields->addExtraField('datapolicies_opposition_prospection', "DATAPOLICIES_opposition_prospection", 'boolean', 103, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
241
        $result1 = $extrafields->addExtraField('datapolicies_date', $langs->trans("DATAPOLICIES_date"), 'date', 104, 3, 'thirdparty', 0, 0, '', '', 1, '', '3', 0);
242
        $result1 = $extrafields->addExtraField('datapolicies_send', $langs->trans("DATAPOLICIES_send"), 'date', 105, 3, 'thirdparty', 0, 0, '', '', 0, '', '0', 0);
243
244
        // Extrafield Tiers
245
        //$result1=$extrafields->addExtraField('datapolicies_separate', "DATAPOLICIES_BLOCKCHECKBOX", 'separate', 100,  1, 'contact',   0, 0, '', '', 1, '', '1', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
246
        $result1 = $extrafields->addExtraField('datapolicies_consentement', "DATAPOLICIES_consentement", 'boolean', 101, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
247
        $result1 = $extrafields->addExtraField('datapolicies_opposition_traitement', "DATAPOLICIES_opposition_traitement", 'boolean', 102, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
248
        $result1 = $extrafields->addExtraField('datapolicies_opposition_prospection', "DATAPOLICIES_opposition_prospection", 'boolean', 103, 3, 'contact', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
249
        $result1 = $extrafields->addExtraField('datapolicies_date', $langs->trans("DATAPOLICIES_date"), 'date', 104, 3, 'contact', 0, 0, '', '', 1, '', '3', 0);
250
        $result1 = $extrafields->addExtraField('datapolicies_send', $langs->trans("DATAPOLICIES_send"), 'date', 105, 3, 'contact', 0, 0, '', '', 0, '', '0', 0);
251
252
        // Extrafield Adherent
253
        //$result1=$extrafields->addExtraField('datapolicies_separate', "DATAPOLICIES_BLOCKCHECKBOX", 'separate', 100,  1, 'adherent',   0, 0, '', '', 1, '', '1', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
254
        $result1 = $extrafields->addExtraField('datapolicies_consentement', "DATAPOLICIES_consentement", 'boolean', 101, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
255
        $result1 = $extrafields->addExtraField('datapolicies_opposition_traitement', "DATAPOLICIES_opposition_traitement", 'boolean', 102, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
256
        $result1 = $extrafields->addExtraField('datapolicies_opposition_prospection', "DATAPOLICIES_opposition_prospection", 'boolean', 103, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0, '', '', 'datapolicies@datapolicies', '$conf->datapolicies->enabled');
257
        $result1 = $extrafields->addExtraField('datapolicies_date', $langs->trans("DATAPOLICIES_date"), 'date', 104, 3, 'adherent', 0, 0, '', '', 1, '', '3', 0);
258
        $result1 = $extrafields->addExtraField('datapolicies_send', $langs->trans("DATAPOLICIES_send"), 'date', 105, 3, 'adherent', 0, 0, '', '', 0, '', '0', 0);
259
260
        $sql = array();
261
262
        return $this->_init($sql, $options);
263
    }
264
265
    /**
266
     * 	Function called when module is disabled.
267
     * 	Remove from database constants, boxes and permissions from Dolibarr database.
268
     * 	Data directories are not deleted
269
     *
270
     * 	@param      string	$options    Options when enabling module ('', 'noboxes')
271
     * 	@return     int             	1 if OK, 0 if KO
272
     */
273
    public function remove($options = '')
274
    {
275
        $sql = array();
276
277
        return $this->_remove($sql, $options);
278
    }
279
}
280