// 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 id number for your module
// Key text used to identify module (for permissions, menus, etc...)
$this->rights_class='mymodule';
// 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";
// Module position in the family on 2 digits ('01', '10', '20', ...)
$this->module_position='90';
// 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)
// 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'
$this->picto='generic';
// 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'=>1,
// 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'=>1,
// Set this to 1 if module has its own menus handler directory (core/menus)
'menus'=>0,
// Set this to 1 if module has its own theme directory (theme)
'theme'=>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,
// 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 'all'
// 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->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', ...)
$this->langfiles=array("mymodule@mymodule");
//$this->phpmin = array(5,4); // Minimum version of PHP required by module
$this->need_dolibarr_version=array(4,0);// Minimum version of Dolibarr required by module
$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->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@mymodule:$user->rights->mymodule->read:/mymodule/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
// $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@mymodule:$user->rights->othermodule->read:/mymodule/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
'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'),
$this->rights=array();// Permission array used by this module
$r=0;
$this->rights[$r][0]=$this->numero+$r;// Permission id (must not be already used)
$this->rights[$r][1]='Read myobject of MyModule';// Permission label
$this->rights[$r][3]=1;// Permission by default for new user (0/1)
$this->rights[$r][4]='read';// In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
$this->rights[$r][5]='';// In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
$r++;
$this->rights[$r][0]=$this->numero+$r;// Permission id (must not be already used)
$this->rights[$r][1]='Create/Update myobject of MyModule';// Permission label
$this->rights[$r][3]=1;// Permission by default for new user (0/1)
$this->rights[$r][4]='write';// In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
$this->rights[$r][5]='';// In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
$r++;
$this->rights[$r][0]=$this->numero+$r;// Permission id (must not be already used)
$this->rights[$r][1]='Delete myobject of MyModule';// Permission label
$this->rights[$r][3]=1;// Permission by default for new user (0/1)
$this->rights[$r][4]='delete';// In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
$this->rights[$r][5]='';// In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
// Main menu entries
$this->menu=array();// List of menus to add
$r=0;
// Add here entries to declare new menus
/* BEGIN MODULEBUILDER TOPMENU */
$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
'titre'=>'MyModule',
'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,
'enabled'=>'$conf->mymodule->enabled',// Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
'perms'=>'1',// Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2,// 0=Menu for internal users, 1=external users, 2=both
);
/* END MODULEBUILDER TOPMENU */
/*BEGINMODULEBUILDERLEFTMENUMYOBJECT
$this->menu[$r++]=array(
'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
'type'=>'left',// This is a Left menu entry
'titre'=>'List MyObject',
'mainmenu'=>'mymodule',
'leftmenu'=>'mymodule_myobject_list',
'url'=>'/mymodule/myobject_list.php',
'langs'=>'mymodule@mymodule',// Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>1000+$r,
'enabled'=>'$conf->mymodule->enabled',// 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.
'perms'=>'1',// Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2,// 0=Menu for internal users, 1=external users, 2=both
);
$this->menu[$r++]=array(
'fk_menu'=>'fk_mainmenu=mymodule,fk_leftmenu=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
'langs'=>'mymodule@mymodule',// Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position'=>1000+$r,
'enabled'=>'$conf->mymodule->enabled',// 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.
'perms'=>'1',// Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
'target'=>'',
'user'=>2,// 0=Menu for internal users, 1=external users, 2=both
//$this->export_dependencies_array[$r]=array('mysubobject'=>'ts.rowid', 't.myfield'=>array('t.myfield2','t.myfield3')); // 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_sql_start[$r]='SELECT DISTINCT ';
$this->export_sql_end[$r]=' FROM '.MAIN_DB_PREFIX.'myobject as t';
$this->export_sql_end[$r].=' WHERE 1 = 1';
$this->export_sql_end[$r].=' AND t.entity IN ('.getEntity('myobject').')';
if($result<0)return-1;// Do not activate module if not allowed errors found on module SQL queries (the _load_table run sql with run_sql with error allowed parameter to 'default')
