dolibarr  9.0.0
modCron.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2012 Nicolas Villa aka Boyquotes http://informetic.fr
3  * Copyright (C) 2013 Florian Henry <florian.henry@open-concept.pro>
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 <http://www.gnu.org/licenses/>.
17  */
18 
26 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
27 
28 
32 class modCron extends DolibarrModules
33 {
34 
40  function __construct($db)
41  {
42  global $langs, $conf;
43 
44  $this->db = $db;
45  $this->numero = 2300;
46 
47  // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
48  // It is used to group modules in module setup page
49  $this->family = "base";
50  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
51  $this->name = preg_replace('/^mod/i', '', get_class($this));
52  $this->description = "Enable the Dolibarr cron service";
53  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
54  $this->version = 'dolibarr';
55  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
56  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
57  // Name of image file used for this module.
58  $this->picto = 'technic';
59 
60  // Data directories to create when module is enabled
61  $this->dirs = array();
62 
63  // Config pages
64  //-------------
65  $this->config_page_url = array("cron.php@cron");
66 
67  // Dependancies
68  //-------------
69  $this->hidden = !empty($conf->global->MODULE_CRON_DISABLED); // A condition to disable module
70  $this->depends = array(); // List of modules id that must be enabled if this module is enabled
71  $this->requiredby = array(); // List of modules id to disable if this one is disabled
72  $this->conflictwith = array(); // List of modules id this module is in conflict with
73  $this->langfiles = array("cron");
74 
75  // Constants
76  //-----------
77  $this->const = array(
78  0=>array(
79  'CRON_KEY',
80  'chaine',
81  '',
82  'CRON KEY',
83  0,
84  'main',
85  0
86  ),);
87 
88  // New pages on tabs
89  // -----------------
90  $this->tabs = array();
91 
92  // Boxes
93  //------
94  $this->boxes = array();
95 
96  // Cronjobs
97  $this->cronjobs = array(
98  0=>array('entity'=>0, 'label'=>'PurgeDeleteTemporaryFilesShort', 'jobtype'=>'method', 'class'=>'core/class/utils.class.php', 'objectname'=>'Utils', 'method'=>'purgeFiles', 'parameters'=>'', 'comment'=>'PurgeDeleteTemporaryFiles', 'frequency'=>2, 'unitfrequency'=>3600 * 24 * 7, 'priority'=>50, 'status'=>1, 'test'=>true),
99  1=>array('entity'=>0, 'label'=>'MakeLocalDatabaseDumpShort', 'jobtype'=>'method', 'class'=>'core/class/utils.class.php', 'objectname'=>'Utils', 'method'=>'dumpDatabase', 'parameters'=>'none,auto,1,auto,10', 'comment'=>'MakeLocalDatabaseDump', 'frequency'=>1, 'unitfrequency'=>3600 * 24 * 7, 'priority'=>90, 'status'=>0, 'test'=>in_array($db->type, array('mysql', 'mysqli'))),
100  // 1=>array('entity'=>0, 'label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24)
101  );
102 
103  // Permissions
104  $this->rights = array(); // Permission array used by this module
105  $this->rights_class = 'cron';
106  $r = 0;
107 
108  $this->rights[$r][0] = 23001;
109  $this->rights[$r][1] = 'Read cron jobs';
110  $this->rights[$r][3] = 0;
111  $this->rights[$r][4] = 'read';
112  $r++;
113 
114  $this->rights[$r][0] = 23002;
115  $this->rights[$r][1] = 'Create cron Jobs';
116  $this->rights[$r][3] = 0;
117  $this->rights[$r][4] = 'create';
118  $r++;
119 
120  $this->rights[$r][0] = 23003;
121  $this->rights[$r][1] = 'Delete cron Jobs';
122  $this->rights[$r][3] = 0;
123  $this->rights[$r][4] = 'delete';
124  $r++;
125 
126  $this->rights[$r][0] = 23004;
127  $this->rights[$r][1] = 'Execute cron Jobs';
128  $this->rights[$r][3] = 0;
129  $this->rights[$r][4] = 'execute';
130  $r++;
131 
132  // Main menu entries
133  $r = 0;
134  $this->menu[$r] = array('fk_menu'=>'fk_mainmenu=home,fk_leftmenu=admintools', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
135  'type'=>'left', // This is a Left menu entry
136  'titre'=>'CronList',
137  'url'=>'/cron/list.php?status=-2&leftmenu=admintools',
138  'langs'=>'cron', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
139  'position'=>200,
140  'enabled'=>'$conf->cron->enabled && preg_match(\'/^(admintools|all)/\', $leftmenu)', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
141  'perms'=>'$user->rights->cron->read', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
142  'target'=>'',
143  'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
144  $r++;
145  }
146 }
Class DolibarrModules.
</td >< td class="liste_titre" align="right"></td ></tr >< tr class="liste_titre">< input type="checkbox" onClick="toggle(this)"/> Ref p ref Label p label Duration p duration warehouseinternal SELECT description FROM product_lang WHERE qty< br > qty qty qty StockTooLow img yes disabled img no img no< tr class="oddeven">< td >< input type="checkbox" class="check" name="' . $i . '"' . $disabled . '></td >< td >< input type="checkbox" class="check" name="choose'.$i.'"></td >< td class="nowrap"></td >< td >< input type="hidden" name="desc' . $i . '" value="' . dol_escape_htmltag($objp-> description
Only used if Module[ID]Desc translation string is not found.
Definition: replenish.php:573
__construct($db)
Constructor.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:103
Class to describe a Cron module.