dolibarr  18.0.0
modWorkflow.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2010-2012 Regis Houssin <regis.houssin@inodbox.com>
3  * Copyright (C) 2010 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 <https://www.gnu.org/licenses/>.
17  */
18 
26 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
27 
28 
33 {
34 
40  public function __construct($db)
41  {
42  $this->db = $db;
43 
44  // Id for module (must be unique).
45  // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
46  $this->numero = 6000;
47  // Key text used to identify module (for permissions, menus, etc...)
48  $this->rights_class = 'workflow';
49 
50  $this->family = "technic";
51  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
52  $this->name = preg_replace('/^mod/i', '', get_class($this));
53  // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
54  $this->description = "Inter-modules workflow management";
55  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
56  $this->version = 'dolibarr';
57  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
58  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
59  // Name of png file (without png) used for this module.
60  // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
61  // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
62  $this->picto = 'technic';
63 
64  // Data directories to create when module is enabled
65  $this->dirs = array("/workflow/temp");
66 
67  // Config pages. Put here list of php page names stored in admmin directory used to setup module.
68  $this->config_page_url = array('workflow.php');
69 
70  // Dependencies
71  $this->hidden = false; // A condition to hide module
72  $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
73  $this->requiredby = array(); // List of module ids to disable if this one is disabled
74  $this->conflictwith = array(); // List of module class names as string this module is in conflict with
75  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
76  $this->need_dolibarr_version = array(2, 8); // Minimum version of Dolibarr required by module
77  $this->langfiles = array("@workflow");
78 
79  // Constants
80  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
81  // Example: $this->const=array(1 => array('MYMODULE_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
82  // 2 => array('MYMODULE_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
83  // );
84  $this->const = array(
85  //0=>array('WORKFLOW_PROPAL_AUTOCREATE_ORDER', 'chaine', '1', 'WORKFLOW_PROPAL_AUTOCREATE_ORDER', 0, 'current', 0),
86  //0=>array('WORKFLOW_ORDER_AUTOCREATE_INVOICE', 'chaine', '1', 'WORKFLOW_ORDER_AUTOCREATE_INVOICE', 0, 'current', 0),
87  0=>array('WORKFLOW_ORDER_CLASSIFY_BILLED_PROPAL', 'chaine', '1', 'WORKFLOW_ORDER_CLASSIFY_BILLED_PROPAL', 0, 'current', 0),
88  1=>array('WORKFLOW_INVOICE_CLASSIFY_BILLED_PROPAL', 'chaine', '1', 'WORKFLOW_INVOICE_CLASSIFY_BILLED_PROPAL', 0, 'current', 0),
89  2=>array('WORKFLOW_ORDER_CLASSIFY_SHIPPED_SHIPPING', 'chaine', '1', 'WORKFLOW_ORDER_CLASSIFY_SHIPPED_SHIPPING', 0, 'current', 0),
90  3=>array('WORKFLOW_ORDER_CLASSIFY_SHIPPED_SHIPPING_CLOSED', 'chaine', '1', 'WORKFLOW_ORDER_CLASSIFY_SHIPPED_SHIPPING_CLOSED', 0, 'current', 0),
91  4=>array('WORKFLOW_INVOICE_AMOUNT_CLASSIFY_BILLED_ORDER', 'chaine', '1', 'WORKFLOW_INVOICE_AMOUNT_CLASSIFY_BILLED_ORDER', 0, 'current', 0),
92  5=>array('WORKFLOW_ORDER_CLASSIFY_BILLED_SUPPLIER_PROPOSAL', 'chaine', '1', 'WORKFLOW_ORDER_CLASSIFY_BILLED_SUPPLIER_PROPOSAL', 0, 'current', 0),
93  6=>array('WORKFLOW_ORDER_CLASSIFY_RECEIVED_RECEPTION', 'chaine', '1', 'WORKFLOW_ORDER_CLASSIFY_RECEIVED_RECEPTION', 0, 'current', 0),
94  7=>array('WORKFLOW_ORDER_CLASSIFY_RECEIVED_RECEPTION_CLOSED', 'chaine', '1', 'WORKFLOW_ORDER_CLASSIFY_RECEIVED_RECEPTION_CLOSED', 0, 'current', 0),
95  8=>array('WORKFLOW_INVOICE_AMOUNT_CLASSIFY_BILLED_SUPPLIER_ORDER', 'chaine', '1', 'WORKFLOW_INVOICE_AMOUNT_CLASSIFY_BILLED_SUPPLIER_ORDER', 0, 'current', 0),
96  10=>array('WORKFLOW_TICKET_LINK_CONTRACT', 'chaine', '0', 'Automatically link a ticket to available contracts', 0, 'current', 0),
97  11=>array('WORKFLOW_TICKET_USE_PARENT_COMPANY_CONTRACTS', 'chaine', '0', 'Search among parent companies contracts when automatically linking a ticket to available contracts', 0, 'current', 0),
98  12=>array('WORKFLOW_TICKET_CREATE_INTERVENTION', 'chaine', '0', 'WORKFLOW_TICKET_CREATE_INTERVENTION', 0, 'current', 0)
99  );
100 
101  // Boxes
102  $this->boxes = array();
103 
104  // Permissions
105  $this->rights = array();
106  $r = 0;
107 
108  /*
109  $r++;
110  $this->rights[$r][0] = 6001; // id de la permission
111  $this->rights[$r][1] = "Lire les workflow"; // libelle de la permission
112  $this->rights[$r][2] = 'r'; // type de la permission (deprecie a ce jour)
113  $this->rights[$r][3] = 0; // La permission est-elle une permission par defaut
114  $this->rights[$r][4] = 'read';
115  */
116 
117  // Main menu entries
118  $this->menu = array(); // List of menus to add
119  $r = 0;
120  /*
121  $this->menu[$r]=array('fk_menu'=>0,
122  'type'=>'top',
123  'titre'=>'Workflow',
124  'mainmenu'=>'workflow',
125  'url'=>'/workflow/index.php',
126  'langs'=>'@workflow',
127  'position'=>100,
128  'perms'=>'$user->rights->workflow->read',
129  'enabled'=>'$conf->workflow->enabled',
130  'target'=>'',
131  'user'=>0);
132  $r++;
133 
134  $this->menu[$r]=array( 'fk_menu'=>'r=0',
135  'type'=>'left',
136  'titre'=>'Workflow',
137  'mainmenu'=>'workflow',
138  'url'=>'/workflow/index.php',
139  'langs'=>'@workflow',
140  'position'=>101,
141  'enabled'=>1,
142  'perms'=>'$user->rights->workflow->read',
143  'target'=>'',
144  'user'=>0);
145  $r++;
146  */
147  }
148 
149 
158  public function init($options = '')
159  {
160  // Permissions
161  $this->remove($options);
162 
163  $sql = array();
164 
165  return $this->_init($sql, $options);
166  }
167 }
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:123
modWorkflow\__construct
__construct($db)
Constructor.
Definition: modWorkflow.class.php:40
DolibarrModules\_init
_init($array_sql, $options='')
Enables a module.
Definition: DolibarrModules.class.php:436
$sql
if(isModEnabled('facture') && $user->hasRight('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') && $user->hasRight('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:746
modWorkflow\init
init($options='')
Function called when module is enabled.
Definition: modWorkflow.class.php:158
modWorkflow
Class to describe and enable module Workflow.
Definition: modWorkflow.class.php:32
DolibarrModules
Class DolibarrModules.
Definition: DolibarrModules.class.php:37