2017-05-08 19:00:23 +00:00
< ? php
2019-02-25 23:02:39 +00:00
/* Copyright ( C ) 2004 - 2018 Laurent Destailleur < eldy @ users . sourceforge . net >
2019-05-09 12:36:48 +00:00
* Copyright ( C ) 2018 - 2019 Nicolas ZABOURI < info @ inovea - conseil . com >
2024-03-05 16:11:46 +00:00
* Copyright ( C ) 2019 - 2024 Frédéric France < frederic . france @ free . fr >
2017-06-27 18:14:48 +00:00
* Copyright ( C ) --- Put here your own copyright and developer email ---
2017-05-08 19:00:23 +00:00
*
2017-05-27 11:46:34 +00:00
* This program is free software ; you can redistribute it and / or modify
2017-05-08 19:00:23 +00:00
* it under the terms of the GNU General Public License as published by
2017-05-27 11:46:34 +00:00
* the Free Software Foundation ; either version 3 of the License , or
2017-05-08 19:00:23 +00:00
* ( 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
2019-09-23 19:55:30 +00:00
* along with this program . If not , see < https :// www . gnu . org / licenses />.
2017-05-08 19:00:23 +00:00
*/
2019-05-09 12:36:48 +00:00
2017-05-08 19:00:23 +00:00
/**
2017-05-27 11:46:34 +00:00
* \defgroup mymodule Module MyModule
* \brief MyModule module descriptor .
2017-05-08 19:00:23 +00:00
*
2017-05-27 11:46:34 +00:00
* \file htdocs / mymodule / core / modules / modMyModule . class . php
* \ingroup mymodule
* \brief Description and activation file for module MyModule
2017-05-08 19:00:23 +00:00
*/
2019-11-08 14:51:54 +00:00
include_once DOL_DOCUMENT_ROOT . '/core/modules/DolibarrModules.class.php' ;
2019-05-09 12:36:48 +00:00
2024-03-13 19:17:26 +00:00
2017-05-08 19:00:23 +00:00
/**
2017-05-27 11:46:34 +00:00
* Description and activation class for module MyModule
2017-05-08 19:00:23 +00:00
*/
class modMyModule extends DolibarrModules
{
2020-05-01 06:40:55 +00:00
/**
* Constructor . Define names , constants , directories , boxes , permissions
*
* @ param DoliDB $db Database handler
*/
public function __construct ( $db )
{
global $langs , $conf ;
$this -> db = $db ;
2019-05-09 12:36:48 +00:00
2020-05-01 06:40:55 +00:00
// 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 = 500000 ; // TODO Go on page https://wiki.dolibarr.org/index.php/List_of_modules_id to reserve an id number for your module
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// Key text used to identify module (for permissions, menus, etc...)
$this -> rights_class = 'mymodule' ;
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
// It is used to group modules by family in module setup page
$this -> family = " other " ;
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// Module position in the family on 2 digits ('01', '10', '20', ...)
$this -> module_position = '90' ;
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// Gives the possibility for the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this)
//$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
// Module label (no space allowed), used if translation string 'ModuleMyModuleName' not found (MyModule is name of module).
$this -> name = preg_replace ( '/^mod/i' , '' , get_class ( $this ));
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// Module description, used if translation string 'ModuleMyModuleDesc' not found (MyModule is name of module).
$this -> description = " MyModuleDescription " ;
// Used only if file README.md and README-LL.md not found.
2021-01-13 11:36:33 +00:00
$this -> descriptionlong = " MyModuleDescription " ;
2020-12-27 14:39:10 +00:00
// Author
2020-05-01 06:40:55 +00:00
$this -> editor_name = 'Editor name' ;
$this -> editor_url = 'https://www.example.com' ;
2020-12-27 14:39:10 +00:00
2022-09-12 13:16:38 +00:00
// Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated', 'experimental_deprecated' or a version string like 'x.y.z'
2020-05-01 06:40:55 +00:00
$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';
2019-05-09 12:36:48 +00:00
2020-05-01 06:40:55 +00:00
// 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 );
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// 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'
2020-12-27 14:39:10 +00:00
// To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
2020-05-01 06:40:55 +00:00
$this -> picto = 'generic' ;
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// 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' => 0 ,
2020-10-31 13:32:18 +00:00
// Set this to 1 if module has its own printing directory (core/modules/printing)
'printing' => 0 ,
2020-05-01 06:40:55 +00:00
// 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 (
// '/mymodule/css/mymodule.css.php',
),
// Set this to relative path of js file if module must load a js on all pages
'js' => array (
// '/mymodule/js/mymodule.js.php',
),
// 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 to 'all'
'hooks' => array (
// 'data' => array(
// 'hookcontext1',
// 'hookcontext2',
// ),
// 'entity' => '0',
),
// Set this to 1 if features of module are opened to external users
'moduleforexternal' => 0 ,
2024-02-09 16:54:57 +00:00
// Set this to 1 if the module provides a website template into doctemplates/websites/website_template-mytemplate
'websitetemplates' => 0
2020-05-01 06:40:55 +00:00
);
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// Data directories to create when module is enabled.
// Example: this->dirs = array("/mymodule/temp","/mymodule/subdir");
$this -> dirs = array ( " /mymodule/temp " );
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// Config pages. Put here list of php page, stored into mymodule/admin directory, to use to setup module.
$this -> config_page_url = array ( " setup.php@mymodule " );
2020-12-27 14:39:10 +00:00
2020-05-01 06:40:55 +00:00
// Dependencies
// A condition to hide module
2024-02-22 12:28:18 +00:00
$this -> hidden = getDolGlobalInt ( 'MODULE_MYMODULE_DISABLED' ); // A condition to disable module;
2023-04-21 11:27:50 +00:00
// List of module class names that must be enabled if this module is enabled. Example: array('always'=>array('modModuleToEnable1','modModuleToEnable2'), 'FR'=>array('modModuleToEnableFR')...)
2020-05-01 06:40:55 +00:00
$this -> depends = array ();
2023-04-21 11:27:50 +00:00
// List of module class names to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
$this -> requiredby = array ();
// List of module class names this module is in conflict with. Example: array('modModuleToDisable1', ...)
$this -> conflictwith = array ();
2020-12-27 14:39:10 +00:00
// The language file dedicated to your module
2020-05-01 06:40:55 +00:00
$this -> langfiles = array ( " mymodule@mymodule " );
2020-12-27 14:39:10 +00:00
// Prerequisites
2024-03-05 16:11:46 +00:00
$this -> phpmin = array ( 7 , 1 ); // Minimum version of PHP required by module
2020-05-01 06:40:55 +00:00
$this -> need_dolibarr_version = array ( 11 , - 3 ); // Minimum version of Dolibarr required by module
2023-06-28 10:05:51 +00:00
$this -> need_javascript_ajax = 0 ;
2020-12-27 14:39:10 +00:00
// Messages at activation
2021-11-13 13:06:59 +00:00
$this -> warnings_activation = array (); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
$this -> warnings_activation_ext = array (); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
2020-05-01 06:40:55 +00:00
//$this->automatic_activation = array('FR'=>'MyModuleWasAutomaticallyActivatedBecauseOfYourCountryChoice');
//$this->always_enabled = true; // If true, can't be disabled
2019-05-10 16:15:09 +00:00
2020-05-01 06:40:55 +00:00
// 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('MYMODULE_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
// 2 => array('MYMODULE_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
// );
2020-06-29 07:56:04 +00:00
$this -> const = array ();
2019-05-09 12:36:48 +00:00
2020-05-01 06:40:55 +00:00
// Some keys to add into the overwriting translation tables
/* $this -> overwrite_translation = array (
'en_US:ParentCompany' => 'Parent company or reseller' ,
'fr_FR:ParentCompany' => 'Maison mère ou revendeur'
) */
2019-05-09 12:36:48 +00:00
2024-01-27 00:34:53 +00:00
if ( ! isModEnabled ( " mymodule " )) {
2020-05-01 06:40:55 +00:00
$conf -> mymodule = new stdClass ();
$conf -> mymodule -> enabled = 0 ;
}
2019-05-09 12:36:48 +00:00
2020-05-01 06:40:55 +00:00
// Array to add new pages in new tabs
$this -> tabs = array ();
// Example:
2024-03-05 16:11:46 +00:00
// To add a new tab identified by code tabname1
// $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@mymodule:$user->hasRight('mymodule', 'read'):/mymodule/mynewtab1.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:+tabname2:SUBSTITUTION_Title2:mylangfile@mymodule:$user->hasRight('othermodule', 'read'):/mymodule/mynewtab2.php?id=__ID__',
// To remove an existing tab identified by code tabname
// $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove');
2020-05-01 06:40:55 +00:00
//
// 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
2024-01-12 17:06:50 +00:00
// 'member' to add a tab in foundation member view
2020-05-01 06:40:55 +00:00
// 'opensurveypoll' to add a tab in opensurvey poll view
2022-10-12 13:29:30 +00:00
// 'order' to add a tab in sale order view
2020-05-01 06:40:55 +00:00
// '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
2019-05-02 10:03:14 +00:00
2020-05-01 06:40:55 +00:00
// Dictionaries
/* Example :
2023-08-08 18:22:31 +00:00
$this -> dictionaries = array (
'langs' => 'mymodule@mymodule' ,
// List of tables we want to see into dictonnary editor
'tabname' => array ( " table1 " , " table2 " , " table3 " ),
// Label of tables
'tablib' => array ( " Table1 " , " Table2 " , " Table3 " ),
// Request to select fields
'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' ),
// Sort order
'tabsqlsort' => array ( " label ASC " , " label ASC " , " label ASC " ),
// List of fields (result of select to show dictionary)
'tabfield' => array ( " code,label " , " code,label " , " code,label " ),
// List of fields (list of fields to edit a record)
'tabfieldvalue' => array ( " code,label " , " code,label " , " code,label " ),
// List of fields (list of fields for insert)
'tabfieldinsert' => array ( " code,label " , " code,label " , " code,label " ),
// Name of columns with primary key (try to always name it 'rowid')
'tabrowid' => array ( " rowid " , " rowid " , " rowid " ),
// Condition to show each dictionary
'tabcond' => array ( isModEnabled ( 'mymodule' ), isModEnabled ( 'mymodule' ), isModEnabled ( 'mymodule' )),
// Tooltip for every fields of dictionaries: DO NOT PUT AN EMPTY ARRAY
'tabhelp' => array ( array ( 'code' => $langs -> trans ( 'CodeTooltipHelp' ), 'field2' => 'field2tooltip' ), array ( 'code' => $langs -> trans ( 'CodeTooltipHelp' ), 'field2' => 'field2tooltip' ), ... ),
);
*/
/* BEGIN MODULEBUILDER DICTIONARIES */
$this -> dictionaries = array ();
/* END MODULEBUILDER DICTIONARIES */
2019-05-02 10:03:14 +00:00
2020-05-01 06:40:55 +00:00
// Boxes/Widgets
// Add here list of php file(s) stored in mymodule/core/boxes that contains a class to show a widget.
2023-08-08 18:22:31 +00:00
/* BEGIN MODULEBUILDER WIDGETS */
2020-05-01 06:40:55 +00:00
$this -> boxes = array (
// 0 => array(
// 'file' => 'mymodulewidget1.php@mymodule',
// 'note' => 'Widget provided by MyModule',
// 'enabledbydefaulton' => 'Home',
// ),
// ...
);
2023-08-08 18:22:31 +00:00
/* END MODULEBUILDER WIDGETS */
2019-05-02 10:03:14 +00:00
2020-05-01 06:40:55 +00:00
// 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
2023-08-08 18:22:31 +00:00
/* BEGIN MODULEBUILDER CRON */
2020-05-01 06:40:55 +00:00
$this -> cronjobs = array (
// 0 => array(
// 'label' => 'MyJob label',
// 'jobtype' => 'method',
// 'class' => '/mymodule/class/myobject.class.php',
// 'objectname' => 'MyObject',
// 'method' => 'doScheduledJob',
// 'parameters' => '',
// 'comment' => 'Comment',
// 'frequency' => 2,
// 'unitfrequency' => 3600,
// 'status' => 0,
2023-04-18 18:33:36 +00:00
// 'test' => 'isModEnabled("mymodule")',
2020-05-01 06:40:55 +00:00
// 'priority' => 50,
// ),
);
2023-08-08 18:22:31 +00:00
/* END MODULEBUILDER CRON */
2020-05-01 06:40:55 +00:00
// Example: $this->cronjobs=array(
2023-04-18 18:33:36 +00:00
// 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'=>'isModEnabled("mymodule")', 'priority'=>50),
// 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'isModEnabled("mymodule")', 'priority'=>50)
2020-05-01 06:40:55 +00:00
// );
2019-05-02 10:03:14 +00:00
2020-05-01 06:40:55 +00:00
// Permissions provided by this module
$this -> rights = array ();
$r = 0 ;
// Add here entries to declare new permissions
/* BEGIN MODULEBUILDER PERMISSIONS */
2023-08-01 22:34:52 +00:00
/*
$o = 1 ;
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( " %02d " , ( $o * 10 ) + 1 ); // Permission id (must not be already used)
2020-05-01 06:40:55 +00:00
$this -> rights [ $r ][ 1 ] = 'Read objects of MyModule' ; // Permission label
2021-04-01 23:34:04 +00:00
$this -> rights [ $r ][ 4 ] = 'myobject' ;
2023-06-05 22:05:02 +00:00
$this -> rights [ $r ][ 5 ] = 'read' ; // In php code, permission will be checked by test if ($user->hasRight('mymodule', 'myobject', 'read'))
2020-05-01 06:40:55 +00:00
$r ++ ;
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( " %02d " , ( $o * 10 ) + 2 ); // Permission id (must not be already used)
2020-05-01 06:40:55 +00:00
$this -> rights [ $r ][ 1 ] = 'Create/Update objects of MyModule' ; // Permission label
2021-04-01 23:34:04 +00:00
$this -> rights [ $r ][ 4 ] = 'myobject' ;
2023-06-05 22:05:02 +00:00
$this -> rights [ $r ][ 5 ] = 'write' ; // In php code, permission will be checked by test if ($user->hasRight('mymodule', 'myobject', 'write'))
2020-05-01 06:40:55 +00:00
$r ++ ;
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( " %02d " , ( $o * 10 ) + 3 ); // Permission id (must not be already used)
2020-05-01 06:40:55 +00:00
$this -> rights [ $r ][ 1 ] = 'Delete objects of MyModule' ; // Permission label
2021-04-01 23:34:04 +00:00
$this -> rights [ $r ][ 4 ] = 'myobject' ;
2024-02-04 15:03:59 +00:00
$this -> rights [ $r ][ 5 ] = 'delete' ; // In php code, permission will be checked by test if ($user->hasRight('mymodule', 'myobject', 'delete'))
2023-08-01 22:34:52 +00:00
$r ++ ;
*/
2020-05-01 06:40:55 +00:00
/* END MODULEBUILDER PERMISSIONS */
2019-05-02 10:03:14 +00:00
2020-05-01 06:40:55 +00:00
// Main menu entries to add
$this -> menu = array ();
$r = 0 ;
2024-03-13 19:17:26 +00:00
2020-05-01 06:40:55 +00:00
// Add here entries to declare new menus
2024-03-13 19:17:26 +00:00
/* BEGIN MODULEBUILDER TOPMENU MYOBJECT */
2020-05-01 06:40:55 +00:00
$this -> menu [ $r ++ ] = array (
'fk_menu' => '' , // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
'type' => 'top' , // This is a Top menu entry
2020-06-07 17:37:42 +00:00
'titre' => 'ModuleMyModuleName' ,
2023-10-13 13:00:51 +00:00
'prefix' => img_picto ( '' , $this -> picto , 'class="pictofixedwidth valignmiddle"' ),
2020-05-01 06:40:55 +00:00
'mainmenu' => 'mymodule' ,
'leftmenu' => '' ,
'url' => '/mymodule/mymoduleindex.php' ,
'langs' => 'mymodule@mymodule' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position' => 1000 + $r ,
2022-09-08 12:58:00 +00:00
'enabled' => 'isModEnabled("mymodule")' , // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
'perms' => '1' , // Use 'perms'=>'$user->hasRight("mymodule", "myobject", "read")' if you want your menu with a permission rules
2020-05-01 06:40:55 +00:00
'target' => '' ,
'user' => 2 , // 0=Menu for internal users, 1=external users, 2=both
);
2024-03-13 19:17:26 +00:00
/* END MODULEBUILDER TOPMENU MYOBJECT */
2023-05-23 15:37:52 +00:00
/* BEGIN MODULEBUILDER LEFTMENU MYOBJECT */
2024-03-19 21:05:55 +00:00
/*
$this -> menu [ $r ++ ] = array (
2020-05-01 06:40:55 +00:00
'fk_menu' => 'fk_mainmenu=mymodule' , // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
2022-03-11 09:32:06 +00:00
'type' => 'left' , // This is a Left menu entry
2020-05-01 06:40:55 +00:00
'titre' => 'MyObject' ,
2023-10-20 14:36:28 +00:00
'prefix' => img_picto ( '' , $this -> picto , 'class="pictofixedwidth valignmiddle paddingright"' ),
2020-05-01 06:40:55 +00:00
'mainmenu' => 'mymodule' ,
'leftmenu' => 'myobject' ,
'url' => '/mymodule/mymoduleindex.php' ,
'langs' => 'mymodule@mymodule' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position' => 1000 + $r ,
2022-09-08 12:58:00 +00:00
'enabled' => 'isModEnabled("mymodule")' , // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
'perms' => '$user->hasRight("mymodule", "myobject", "read")' ,
2020-05-01 06:40:55 +00:00
'target' => '' ,
'user' => 2 , // 0=Menu for internal users, 1=external users, 2=both
);
$this -> menu [ $r ++ ] = array (
'fk_menu' => 'fk_mainmenu=mymodule,fk_leftmenu=myobject' , // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
'type' => 'left' , // This is a Left menu entry
2024-03-19 21:05:55 +00:00
'titre' => 'New_MyObject' ,
2020-05-01 06:40:55 +00:00
'mainmenu' => 'mymodule' ,
2024-03-19 21:05:55 +00:00
'leftmenu' => 'mymodule_myobject_new' ,
'url' => '/mymodule/myobject_card.php?action=create' ,
2020-05-01 06:40:55 +00:00
'langs' => 'mymodule@mymodule' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position' => 1000 + $r ,
2024-03-19 21:05:55 +00:00
'enabled' => 'isModEnabled("mymodule")' , // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
'perms' => '$user->hasRight("mymodule", "myobject", "write")'
2020-05-01 06:40:55 +00:00
'target' => '' ,
'user' => 2 , // 0=Menu for internal users, 1=external users, 2=both
);
$this -> menu [ $r ++ ] = array (
'fk_menu' => 'fk_mainmenu=mymodule,fk_leftmenu=myobject' , // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
'type' => 'left' , // This is a Left menu entry
2024-03-19 21:05:55 +00:00
'titre' => 'List_MyObject' ,
2020-05-01 06:40:55 +00:00
'mainmenu' => 'mymodule' ,
2024-03-19 21:05:55 +00:00
'leftmenu' => 'mymodule_myobject_list' ,
'url' => '/mymodule/myobject_list.php' ,
2020-05-01 06:40:55 +00:00
'langs' => 'mymodule@mymodule' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position' => 1000 + $r ,
2024-03-19 21:05:55 +00:00
'enabled' => 'isModEnabled("mymodule")' , // Define condition to show or hide menu entry. Use 'isModEnabled("mymodule")' if entry must be visible if module is enabled.
'perms' => '$user->hasRight("mymodule", "myobject", "read")'
2020-05-01 06:40:55 +00:00
'target' => '' ,
'user' => 2 , // 0=Menu for internal users, 1=external users, 2=both
2024-03-19 21:05:55 +00:00
);
*/
2022-12-29 15:10:53 +00:00
/* END MODULEBUILDER LEFTMENU MYOBJECT */
2024-03-13 19:17:26 +00:00
2020-05-01 06:40:55 +00:00
// Exports profiles provided by this module
$r = 1 ;
/* BEGIN MODULEBUILDER EXPORT MYOBJECT */
/*
$langs -> load ( " mymodule@mymodule " );
2024-02-15 12:10:28 +00:00
$this -> export_code [ $r ] = $this -> rights_class . '_' . $r ;
$this -> export_label [ $r ] = 'MyObjectLines' ; // Translation key (used only if key ExportDataset_xxx_z not found)
$this -> export_icon [ $r ] = $this -> picto ;
2020-05-01 06:40:55 +00:00
// Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
2020-06-29 12:42:09 +00:00
$keyforclass = 'MyObject' ; $keyforclassfile = '/mymodule/class/myobject.class.php' ; $keyforelement = 'myobject@mymodule' ;
2020-05-01 06:40:55 +00:00
include DOL_DOCUMENT_ROOT . '/core/commonfieldsinexport.inc.php' ;
//$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
//unset($this->export_fields_array[$r]['t.fieldtoremove']);
//$keyforclass = 'MyObjectLine'; $keyforclassfile='/mymodule/class/myobject.class.php'; $keyforelement='myobjectline@mymodule'; $keyforalias='tl';
2019-10-27 14:56:20 +00:00
//include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
2020-05-01 06:40:55 +00:00
$keyforselect = 'myobject' ; $keyforaliasextra = 'extra' ; $keyforelement = 'myobject@mymodule' ;
include DOL_DOCUMENT_ROOT . '/core/extrafieldsinexport.inc.php' ;
//$keyforselect='myobjectline'; $keyforaliasextra='extraline'; $keyforelement='myobjectline@mymodule';
//include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
//$this->export_dependencies_array[$r] = array('myobjectline'=>array('tl.rowid','tl.ref')); // To force to activate one or several fields if we select some fields that need same (like to select a unique key if we ask a field of a child to avoid the DISTINCT to discard them, or for computed field than need several other fields)
//$this->export_special_array[$r] = array('t.field'=>'...');
//$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
//$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
$this -> export_sql_start [ $r ] = 'SELECT DISTINCT ' ;
2024-02-15 12:13:24 +00:00
$this -> export_sql_end [ $r ] = ' FROM ' . MAIN_DB_PREFIX . 'mymodule_myobject as t' ;
//$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'mymodule_myobject_line as tl ON tl.fk_myobject = t.rowid';
2020-05-01 06:40:55 +00:00
$this -> export_sql_end [ $r ] .= ' WHERE 1 = 1' ;
$this -> export_sql_end [ $r ] .= ' AND t.entity IN (' . getEntity ( 'myobject' ) . ')' ;
$r ++ ; */
/* END MODULEBUILDER EXPORT MYOBJECT */
2019-05-02 10:03:14 +00:00
2020-05-01 06:40:55 +00:00
// Imports profiles provided by this module
$r = 1 ;
/* BEGIN MODULEBUILDER IMPORT MYOBJECT */
/*
2022-04-04 11:17:45 +00:00
$langs -> load ( " mymodule@mymodule " );
2024-02-15 12:10:28 +00:00
$this -> import_code [ $r ] = $this -> rights_class . '_' . $r ;
$this -> import_label [ $r ] = 'MyObjectLines' ; // Translation key (used only if key ExportDataset_xxx_z not found)
$this -> import_icon [ $r ] = $this -> picto ;
2022-04-04 11:17:45 +00:00
$this -> import_tables_array [ $r ] = array ( 't' => MAIN_DB_PREFIX . 'mymodule_myobject' , 'extra' => MAIN_DB_PREFIX . 'mymodule_myobject_extrafields' );
$this -> import_tables_creator_array [ $r ] = array ( 't' => 'fk_user_author' ); // Fields to store import user id
$import_sample = array ();
$keyforclass = 'MyObject' ; $keyforclassfile = '/mymodule/class/myobject.class.php' ; $keyforelement = 'myobject@mymodule' ;
include DOL_DOCUMENT_ROOT . '/core/commonfieldsinimport.inc.php' ;
$import_extrafield_sample = array ();
$keyforselect = 'myobject' ; $keyforaliasextra = 'extra' ; $keyforelement = 'myobject@mymodule' ;
include DOL_DOCUMENT_ROOT . '/core/extrafieldsinimport.inc.php' ;
$this -> import_fieldshidden_array [ $r ] = array ( 'extra.fk_object' => 'lastrowid-' . MAIN_DB_PREFIX . 'mymodule_myobject' );
$this -> import_regex_array [ $r ] = array ();
$this -> import_examplevalues_array [ $r ] = array_merge ( $import_sample , $import_extrafield_sample );
$this -> import_updatekeys_array [ $r ] = array ( 't.ref' => 'Ref' );
$this -> import_convertvalue_array [ $r ] = array (
2022-04-04 11:35:08 +00:00
't.ref' => array (
'rule' => 'getrefifauto' ,
2023-08-27 15:11:28 +00:00
'class' => ( ! getDolGlobalString ( 'MYMODULE_MYOBJECT_ADDON' ) ? 'mod_myobject_standard' : getDolGlobalString ( 'MYMODULE_MYOBJECT_ADDON' )),
'path' => " /core/modules/commande/ " . ( ! getDolGlobalString ( 'MYMODULE_MYOBJECT_ADDON' ) ? 'mod_myobject_standard' : getDolGlobalString ( 'MYMODULE_MYOBJECT_ADDON' )) . '.php'
2022-04-04 11:35:08 +00:00
'classobject' => 'MyObject' ,
'pathobject' => '/mymodule/class/myobject.class.php' ,
),
2022-04-04 11:17:45 +00:00
't.fk_soc' => array ( 'rule' => 'fetchidfromref' , 'file' => '/societe/class/societe.class.php' , 'class' => 'Societe' , 'method' => 'fetch' , 'element' => 'ThirdParty' ),
't.fk_user_valid' => array ( 'rule' => 'fetchidfromref' , 'file' => '/user/class/user.class.php' , 'class' => 'User' , 'method' => 'fetch' , 'element' => 'user' ),
't.fk_mode_reglement' => array ( 'rule' => 'fetchidfromcodeorlabel' , 'file' => '/compta/paiement/class/cpaiement.class.php' , 'class' => 'Cpaiement' , 'method' => 'fetch' , 'element' => 'cpayment' ),
);
2023-06-28 10:05:51 +00:00
$this -> import_run_sql_after_array [ $r ] = array ();
2022-04-04 11:17:45 +00:00
$r ++ ; */
2020-05-01 06:40:55 +00:00
/* END MODULEBUILDER IMPORT MYOBJECT */
}
2019-05-09 12:36:48 +00:00
2020-05-01 06:40:55 +00:00
/**
* 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 Options when enabling module ( '' , 'noboxes' )
* @ return int 1 if OK , 0 if KO
*/
public function init ( $options = '' )
{
global $conf , $langs ;
2019-10-31 01:36:16 +00:00
2022-05-08 13:18:34 +00:00
//$result = $this->_load_tables('/install/mysql/', 'mymodule');
2020-05-01 06:40:55 +00:00
$result = $this -> _load_tables ( '/mymodule/sql/' );
2021-01-06 19:27:45 +00:00
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')
}
2019-05-09 12:36:48 +00:00
2020-05-01 06:40:55 +00:00
// Create extrafields during init
//include_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
//$extrafields = new ExtraFields($this->db);
2024-02-12 05:08:22 +00:00
//$result0=$extrafields->addExtraField('mymodule_separator1', "Separator 1", 'separator', 1, 0, 'thirdparty', 0, 0, '', array('options'=>array(1=>1)), 1, '', 1, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
//$result1=$extrafields->addExtraField('mymodule_myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', -1, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
//$result2=$extrafields->addExtraField('mymodule_myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', -1, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
//$result3=$extrafields->addExtraField('mymodule_myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', -1, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
//$result4=$extrafields->addExtraField('mymodule_myattr4', "New Attr 4 label", 'select', 1, 3, 'thirdparty', 0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1,'', -1, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
//$result5=$extrafields->addExtraField('mymodule_myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', -1, 0, '', '', 'mymodule@mymodule', 'isModEnabled("mymodule")');
2019-05-09 12:36:48 +00:00
2020-05-01 06:40:55 +00:00
// Permissions
$this -> remove ( $options );
2019-10-31 01:36:16 +00:00
2020-05-01 06:40:55 +00:00
$sql = array ();
2019-10-31 01:36:16 +00:00
2020-06-01 14:44:22 +00:00
// Document templates
2022-03-07 11:01:34 +00:00
$moduledir = dol_sanitizeFileName ( 'mymodule' );
2020-06-01 14:44:22 +00:00
$myTmpObjects = array ();
2020-10-31 13:32:18 +00:00
$myTmpObjects [ 'MyObject' ] = array ( 'includerefgeneration' => 0 , 'includedocgeneration' => 0 );
2020-06-01 14:44:22 +00:00
foreach ( $myTmpObjects as $myTmpObjectKey => $myTmpObjectArray ) {
2021-01-06 19:27:45 +00:00
if ( $myTmpObjectKey == 'MyObject' ) {
continue ;
}
2020-06-01 14:44:22 +00:00
if ( $myTmpObjectArray [ 'includerefgeneration' ]) {
2022-03-07 11:01:34 +00:00
$src = DOL_DOCUMENT_ROOT . '/install/doctemplates/' . $moduledir . '/template_myobjects.odt' ;
$dirodt = DOL_DATA_ROOT . '/doctemplates/' . $moduledir ;
2020-10-31 13:32:18 +00:00
$dest = $dirodt . '/template_myobjects.odt' ;
2020-06-01 14:44:22 +00:00
2021-01-06 19:27:45 +00:00
if ( file_exists ( $src ) && ! file_exists ( $dest )) {
2020-06-01 14:44:22 +00:00
require_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php' ;
dol_mkdir ( $dirodt );
2020-10-31 13:32:18 +00:00
$result = dol_copy ( $src , $dest , 0 , 0 );
2021-01-06 19:27:45 +00:00
if ( $result < 0 ) {
2020-06-01 14:44:22 +00:00
$langs -> load ( " errors " );
2020-10-31 13:32:18 +00:00
$this -> error = $langs -> trans ( 'ErrorFailToCopyFile' , $src , $dest );
2020-06-01 14:44:22 +00:00
return 0 ;
}
}
2019-10-31 01:36:16 +00:00
2020-06-01 14:44:22 +00:00
$sql = array_merge ( $sql , array (
2021-08-28 01:09:18 +00:00
" DELETE FROM " . MAIN_DB_PREFIX . " document_model WHERE nom = 'standard_ " . strtolower ( $myTmpObjectKey ) . " ' AND type = ' " . $this -> db -> escape ( strtolower ( $myTmpObjectKey )) . " ' AND entity = " . (( int ) $conf -> entity ),
" INSERT INTO " . MAIN_DB_PREFIX . " document_model (nom, type, entity) VALUES('standard_ " . strtolower ( $myTmpObjectKey ) . " ', ' " . $this -> db -> escape ( strtolower ( $myTmpObjectKey )) . " ', " . (( int ) $conf -> entity ) . " ) " ,
" DELETE FROM " . MAIN_DB_PREFIX . " document_model WHERE nom = 'generic_ " . strtolower ( $myTmpObjectKey ) . " _odt' AND type = ' " . $this -> db -> escape ( strtolower ( $myTmpObjectKey )) . " ' AND entity = " . (( int ) $conf -> entity ),
" INSERT INTO " . MAIN_DB_PREFIX . " document_model (nom, type, entity) VALUES('generic_ " . strtolower ( $myTmpObjectKey ) . " _odt', ' " . $this -> db -> escape ( strtolower ( $myTmpObjectKey )) . " ', " . (( int ) $conf -> entity ) . " ) "
2020-06-01 14:44:22 +00:00
));
2020-05-01 06:40:55 +00:00
}
}
2019-10-31 01:36:16 +00:00
2020-05-01 06:40:55 +00:00
return $this -> _init ( $sql , $options );
}
2019-05-09 12:36:48 +00:00
2020-05-01 06:40:55 +00:00
/**
* Function called when module is disabled .
* Remove from database constants , boxes and permissions from Dolibarr database .
* Data directories are not deleted
*
* @ param string $options Options when enabling module ( '' , 'noboxes' )
* @ return int 1 if OK , 0 if KO
*/
public function remove ( $options = '' )
{
$sql = array ();
return $this -> _remove ( $sql , $options );
}
2019-04-01 16:10:14 +00:00
}