151 lines
6.7 KiB
PHP
151 lines
6.7 KiB
PHP
<?php
|
|
/* Copyright (C) 2012 Christophe Battarel <christophe.battarel@altairis.fr>
|
|
* Copyright (C) 2015 Marcos García <marcosgdf@gmail.com>
|
|
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
/** \defgroup margin Module margin
|
|
* \brief Module to manage margins
|
|
* \file htdocs/core/modules/modMargin.class.php
|
|
* \ingroup margin
|
|
* \brief Description and activation file for the module Margin
|
|
*/
|
|
include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
|
|
|
|
|
|
/**
|
|
* Class to describe module Margin
|
|
*/
|
|
class modMargin extends DolibarrModules
|
|
{
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param DoliDB $db Database handler
|
|
*/
|
|
public function __construct($db)
|
|
{
|
|
$this->db = $db;
|
|
|
|
// Id for module (must be unique).
|
|
// Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
|
|
$this->numero = 59000;
|
|
// Key text used to identify module (for permissions, menus, etc...)
|
|
$this->rights_class = 'margins';
|
|
|
|
// Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
|
|
// It is used to group modules in module setup page
|
|
$this->family = "financial";
|
|
$this->module_position = '55';
|
|
// 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 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
|
|
$this->description = "Margin management";
|
|
// Possible values for version are: 'development', 'experimental', 'dolibarr' or version
|
|
$this->version = 'dolibarr';
|
|
// Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
|
|
$this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
|
|
// Name of png file (without png) used for this module.
|
|
// Png file must be in theme/yourtheme/img directory under name object_pictovalue.png.
|
|
$this->picto = 'margin';
|
|
|
|
// Data directories to create when module is enabled.
|
|
$this->dirs = array('/margin/temp');
|
|
|
|
// Config pages. Put here list of php page names stored in admmin directory used to setup module.
|
|
$this->config_page_url = array("margin.php@margin");
|
|
|
|
// Dependencies
|
|
$this->hidden = false; // A condition to hide module
|
|
$this->depends = array("modPropale", "modProduct"); // List of module class names as string that must be enabled if this module is enabled
|
|
$this->requiredby = array(); // List of module ids to disable if this one is disabled
|
|
$this->conflictwith = array(); // List of module class names as string this module is in conflict with
|
|
$this->phpmin = array(7, 0); // Minimum version of PHP required by module
|
|
$this->need_dolibarr_version = array(3, 2); // Minimum version of Dolibarr required by module
|
|
$this->langfiles = array("margins");
|
|
|
|
// Constants
|
|
// List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
|
|
// Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
|
|
// 1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
|
|
// );
|
|
$this->const = array(0 => array('MARGIN_TYPE', 'chaine', 'costprice', 'Rule for margin calculation by default', 0, 'current', 0)); // List of particular constants to add when module is enabled
|
|
|
|
// New pages on tabs
|
|
$this->tabs = array(
|
|
'product:+margin:Margins:margins:$user->rights->margins->liretous:/margin/tabs/productMargins.php?id=__ID__',
|
|
'thirdparty:+margin:Margins:margins:empty($user->socid) && $user->rights->margins->liretous && ($object->client > 0):/margin/tabs/thirdpartyMargins.php?socid=__ID__'
|
|
);
|
|
|
|
|
|
// Boxes
|
|
$this->boxes = array(); // List of boxes
|
|
$r = 0;
|
|
|
|
// Permissions
|
|
$this->rights = array(); // Permission array used by this module
|
|
$r = 0;
|
|
|
|
// Main menu entries
|
|
$this->menu = array(); // List of menus to add
|
|
$r = 0;
|
|
|
|
// left menu entry
|
|
$this->menu[$r] = array(
|
|
'fk_menu' => 'fk_mainmenu=billing', // Put 0 if this is a top menu
|
|
'type' => 'left', // This is a Top menu entry
|
|
'titre' => 'Margins',
|
|
'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth"'),
|
|
'mainmenu' => 'billing',
|
|
'leftmenu' => 'margins',
|
|
'url' => '/margin/index.php',
|
|
'langs' => 'margins', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
|
|
'position' => 100,
|
|
'enabled' => 'isModEnabled("margin")', // Define condition to show or hide menu entry. Use '$conf->monmodule->enabled' if entry must be visible if module is enabled.
|
|
'perms' => '$user->rights->margins->liretous', // Use 'perms'=>'$user->rights->monmodule->level1->level2' if you want your menu with a permission rules
|
|
'target' => '',
|
|
'user' => 2, // 0=Menu for internal users, 1=external users, 2=both
|
|
);
|
|
$r++;
|
|
|
|
// Permissions
|
|
$this->rights = array();
|
|
$r = 0;
|
|
|
|
$r++;
|
|
$this->rights[$r][0] = 59001; // id de la permission
|
|
$this->rights[$r][1] = 'Visualiser les marges'; // libelle de la permission
|
|
$this->rights[$r][2] = 'r'; // type de la permission (deprecated)
|
|
$this->rights[$r][3] = 0; // La permission est-elle une permission par default
|
|
$this->rights[$r][4] = 'liretous';
|
|
|
|
$r++;
|
|
$this->rights[$r][0] = 59002; // id de la permission
|
|
$this->rights[$r][1] = 'Définir les marges'; // libelle de la permission
|
|
$this->rights[$r][2] = 'w'; // type de la permission (deprecated)
|
|
$this->rights[$r][3] = 0; // La permission est-elle une permission par default
|
|
$this->rights[$r][4] = 'creer';
|
|
|
|
$r++;
|
|
$this->rights[$r][0] = 59003; // id de la permission
|
|
$this->rights[$r][1] = 'Read every user margin'; // libelle de la permission
|
|
$this->rights[$r][2] = 'r'; // type de la permission (deprecated)
|
|
$this->rights[$r][3] = 0; // La permission est-elle une permission par default
|
|
$this->rights[$r][4] = 'read';
|
|
$this->rights[$r][5] = 'all';
|
|
}
|
|
}
|