mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2025-12-07 10:08:27 +01:00
287 lines
13 KiB
PHP
287 lines
13 KiB
PHP
<?php
|
|
/* Copyright (C) 2015 Alexandre Spangaro <aspangaro@open-dsi.fr>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* \file htdocs/core/modules/modHRM.class.php
|
|
* \ingroup HRM
|
|
* \brief Description and activation file for the module HRM
|
|
*/
|
|
include_once DOL_DOCUMENT_ROOT."/core/modules/DolibarrModules.class.php";
|
|
|
|
/**
|
|
* Class to describe and activate the HRM module
|
|
*/
|
|
class modHRM extends DolibarrModules
|
|
{
|
|
/**
|
|
* Constructor.
|
|
* Define names, constants, directories, boxes, permissions
|
|
*
|
|
* @param DoliDB $db Database handler
|
|
*/
|
|
public function __construct($db)
|
|
{
|
|
global $langs, $conf;
|
|
|
|
$this->db = $db;
|
|
|
|
$this->numero = 4000;
|
|
$this->rights_class = 'hrm';
|
|
|
|
$this->family = "hr";
|
|
$this->module_position = '50';
|
|
// Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
|
|
$this->name = preg_replace('/^mod/i', '', get_class($this));
|
|
// Module description, used if translation string 'ModulehrmDesc' not found (hrm is name of module).
|
|
$this->description = "hrm Description product ";
|
|
// Used only if file README.md and README-LL.md not found.
|
|
$this->descriptionlong = "hrm Description long";
|
|
|
|
// Author
|
|
$this->editor_name = 'Editor name';
|
|
$this->editor_url = 'https://www.example.com';
|
|
|
|
// Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
|
|
$this->version = '1.0';
|
|
// Url to the file with your last numberversion of this module
|
|
//$this->url_last_version = 'http://www.example.com/versionmodule.txt';
|
|
|
|
// Key used in llx_const table to save module status enabled/disabled (where HRMTEST is value of property name of module in uppercase)
|
|
$this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
|
|
|
|
// Name of image file used for this module.
|
|
// If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
|
|
// If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
|
|
// To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
|
|
$this->picto = 'hrm';
|
|
|
|
// Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
|
|
$this->module_parts = array(
|
|
// Set this to 1 if module has its own trigger directory (core/triggers)
|
|
'triggers' => 0,
|
|
// Set this to 1 if module has its own login method file (core/login)
|
|
'login' => 0,
|
|
// Set this to 1 if module has its own substitution function file (core/substitutions)
|
|
'substitutions' => 0,
|
|
// Set this to 1 if module has its own menus handler directory (core/menus)
|
|
'menus' => 0,
|
|
// Set this to 1 if module overwrite template dir (core/tpl)
|
|
'tpl' => 0,
|
|
// Set this to 1 if module has its own barcode directory (core/modules/barcode)
|
|
'barcode' => 0,
|
|
// Set this to 1 if module has its own models directory (core/modules/xxx)
|
|
'models' => 1,
|
|
// Set this to 1 if module has its own printing directory (core/modules/printing)
|
|
'printing' => 0,
|
|
// Set this to 1 if module has its own theme directory (theme)
|
|
'theme' => 0,
|
|
// Set this to relative path of css file if module has its own css file
|
|
'css' => array(
|
|
'/hrm/css/radio_js_number.css',
|
|
),
|
|
// Set this to relative path of js file if module must load a js on all pages
|
|
'js' => array(
|
|
// '/hrm/js/hrm.js.php',
|
|
),
|
|
|
|
// Set this to 1 if features of module are opened to external users
|
|
'moduleforexternal' => 0,
|
|
);
|
|
|
|
// Data directories to create when module is enabled.
|
|
// Example: this->dirs = array("/hrm/temp","/hrm/subdir");
|
|
$this->dirs = array("/hrm/temp");
|
|
|
|
// Config pages. Put here list of php page, stored into hrm/admin directory, to use to setup module.
|
|
$this->config_page_url = array("hrm.php");
|
|
|
|
// Dependencies
|
|
// A condition to hide module
|
|
$this->hidden = false;
|
|
// List of module class names as string that must be enabled if this module is enabled. Example: array('always1'=>'modModuleToEnable1','always2'=>'modModuleToEnable2', 'FR1'=>'modModuleToEnableFR'...)
|
|
$this->depends = array();
|
|
$this->requiredby = array(); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
|
|
$this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
|
|
|
|
// The language file dedicated to your module
|
|
$this->langfiles = array("hrm");
|
|
|
|
// Prerequisites
|
|
$this->phpmin = array(5, 6); // Minimum version of PHP required by module
|
|
$this->need_dolibarr_version = array(11, -3); // Minimum version of Dolibarr required by module
|
|
|
|
// Messages at activation
|
|
$this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
|
|
$this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','ES'='textes'...)
|
|
//$this->automatic_activation = array('FR'=>'HrmTestWasAutomaticallyActivatedBecauseOfYourCountryChoice');
|
|
//$this->always_enabled = true; // If true, can't be disabled
|
|
|
|
// Constants
|
|
// List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
|
|
// Example: $this->const=array(1 => array('HRMTEST_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
|
|
// 2 => array('HRMTEST_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
|
|
// );
|
|
$this->const = array();
|
|
|
|
|
|
if (!isset($conf->hrm) || !isset($conf->hrm->enabled)) {
|
|
$conf->hrm = new stdClass();
|
|
$conf->hrm->enabled = 0;
|
|
}
|
|
|
|
// Array to add new pages in new tabs
|
|
$this->tabs = array();
|
|
$this->tabs[] = array('data'=>'user:+skill_tab:Skills:hrm:1:/hrm/skill_tab.php?id=__ID__&objecttype=user'); // To add a new tab identified by code tabname1
|
|
//$this->tabs[] = array('data'=>'job:+tabname1:Poste:mylangfile@hrm:1:/hrm/poste_list.php?fk_job=__ID__'); // To add a new tab identified by code tabname1
|
|
// Example:
|
|
// $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@hrm:$user->rights->hrm->read:/hrm/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
|
|
// $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@hrm:$user->rights->othermodule->read:/hrm/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.
|
|
// $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
|
|
//
|
|
// Where objecttype can be
|
|
// 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
|
|
// 'contact' to add a tab in contact view
|
|
// 'contract' to add a tab in contract view
|
|
// 'group' to add a tab in group view
|
|
// 'intervention' to add a tab in intervention view
|
|
// 'invoice' to add a tab in customer invoice view
|
|
// 'invoice_supplier' to add a tab in supplier invoice view
|
|
// 'member' to add a tab in fundation member view
|
|
// 'opensurveypoll' to add a tab in opensurvey poll view
|
|
// 'order' to add a tab in customer order view
|
|
// 'order_supplier' to add a tab in supplier order view
|
|
// 'payment' to add a tab in payment view
|
|
// 'payment_supplier' to add a tab in supplier payment view
|
|
// 'product' to add a tab in product view
|
|
// 'propal' to add a tab in propal view
|
|
// 'project' to add a tab in project view
|
|
// 'stock' to add a tab in stock view
|
|
// 'thirdparty' to add a tab in third party view
|
|
// 'user' to add a tab in user view
|
|
|
|
|
|
// Dictionaries
|
|
$this->dictionaries = array();
|
|
|
|
// Boxes/Widgets
|
|
// Add here list of php file(s) stored in hrm/core/boxes that contains a class to show a widget.
|
|
$this->boxes = array(
|
|
// 0 => array(
|
|
// 'file' => 'hrmwidget1.php@hrm',
|
|
// 'note' => 'Widget provided by HrmTest',
|
|
// 'enabledbydefaulton' => 'Home',
|
|
// ),
|
|
// ...
|
|
);
|
|
|
|
// Cronjobs (List of cron jobs entries to add when module is enabled)
|
|
// unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
|
|
$this->cronjobs = array(
|
|
// 0 => array(
|
|
// 'label' => 'MyJob label',
|
|
// 'jobtype' => 'method',
|
|
// 'class' => '/hrm/class/poste.class.php',
|
|
// 'objectname' => 'Poste',
|
|
// 'method' => 'doScheduledJob',
|
|
// 'parameters' => '',
|
|
// 'comment' => 'Comment',
|
|
// 'frequency' => 2,
|
|
// 'unitfrequency' => 3600,
|
|
// 'status' => 0,
|
|
// 'test' => '$conf->hrm->enabled',
|
|
// 'priority' => 50,
|
|
// ),
|
|
);
|
|
|
|
// Permissions provided by this module
|
|
$this->rights = array();
|
|
$r = 0;
|
|
// Add here entries to declare new permissions
|
|
/* BEGIN MODULEBUILDER PERMISSIONS */
|
|
|
|
// Skill / Job / Position
|
|
$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
|
|
$this->rights[$r][1] = $langs->trans('ReadSkillJobPosition'); // Permission label
|
|
$this->rights[$r][4] = 'all';
|
|
$this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->hrm->poste->read)
|
|
$r++;
|
|
$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
|
|
$this->rights[$r][1] = $langs->trans('CreateUpdateSkillJobPosition'); // Permission label
|
|
$this->rights[$r][4] = 'all';
|
|
$this->rights[$r][5] = 'write'; // In php code, permission will be checked by test if ($user->rights->hrm->poste->write)
|
|
$r++;
|
|
$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
|
|
$this->rights[$r][1] = $langs->trans('DeleteSkillJobPosition'); // Permission label
|
|
$this->rights[$r][4] = 'all';
|
|
$this->rights[$r][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->hrm->poste->delete)
|
|
$r++;
|
|
|
|
//Eval
|
|
$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
|
|
$this->rights[$r][1] = $langs->trans('ReadEval'); // Permission label
|
|
$this->rights[$r][4] = 'evaluation';
|
|
$this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->hrm->poste->read)
|
|
$r++;
|
|
$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
|
|
$this->rights[$r][1] = $langs->trans('CreateUpdateEval'); // Permission label
|
|
$this->rights[$r][4] = 'evaluation';
|
|
$this->rights[$r][5] = 'write'; // In php code, permission will be checked by test if ($user->rights->hrm->poste->write)
|
|
$r++;
|
|
$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
|
|
$this->rights[$r][1] = $langs->trans('ValidateEval'); // Permission label
|
|
$this->rights[$r][4] = 'evaluation';
|
|
$this->rights[$r][5] = 'validate'; // In php code, permission will be checked by test if ($user->rights->hrm->poste->write)
|
|
$r++;
|
|
$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
|
|
$this->rights[$r][1] = $langs->trans('DeleteEval'); // Permission label
|
|
$this->rights[$r][4] = 'evaluation';
|
|
$this->rights[$r][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->hrm->poste->delete)
|
|
$r++;
|
|
|
|
// Comparison
|
|
$this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
|
|
$this->rights[$r][1] = $langs->trans('SeeComparisonMenu'); // Permission label
|
|
$this->rights[$r][4] = 'compare';
|
|
$this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->hrm->poste->delete)
|
|
$r++;
|
|
}
|
|
|
|
/**
|
|
* Function called when module is enabled.
|
|
* The init function add constants, boxes, permissions and menus
|
|
* (defined in constructor) into Dolibarr database.
|
|
* It also creates data directories
|
|
*
|
|
* @param string $options Enabling module ('', 'noboxes')
|
|
* @return int if OK, 0 if KO
|
|
*/
|
|
public function init($options = '')
|
|
{
|
|
// Permissions
|
|
$this->remove($options);
|
|
|
|
/*$result = $this->_load_tables('/hrm/sql/');
|
|
if ($result < 0) {
|
|
return -1; // Do not activate module if error 'not allowed' returned when loading module SQL queries (the _load_table run sql with run_sql with the error allowed parameter set to 'default')
|
|
}*/
|
|
|
|
$sql = array();
|
|
|
|
return $this->_init($sql, $options);
|
|
}
|
|
}
|