// Key text used to identify module (for permissions, menus, etc...)
$this->rights_class='adddesctoservicelist';
// 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="crm";
// Module position in the family on 2 digits ('01', '10', '20', ...)
$this->module_position='90';
// Gives the possibility to 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';
// Defined all module parts (triggers, login, substitutions, menus, css, etc...)
// for default path (eg: /mymodule/core/xxxxx) (0=disable, 1=enable)
// for specific path of parts (eg: /mymodule/core/modules/barcode)
// for specific css file (eg: /mymodule/css/mymodule.css.php)
$this->module_parts=array(
'triggers'=>0,// Set this to 1 if module has its own trigger directory (core/triggers)
'login'=>0,// Set this to 1 if module has its own login method file (core/login)
'substitutions'=>0,// Set this to 1 if module has its own substitution function file (core/substitutions)
'menus'=>0,// Set this to 1 if module has its own menus handler directory (core/menus)
'theme'=>0,// Set this to 1 if module has its own theme directory (theme)
'tpl'=>0,// Set this to 1 if module overwrite template dir (core/tpl)
'barcode'=>0,// Set this to 1 if module has its own barcode directory (core/modules/barcode)
'models'=>0,// Set this to 1 if module has its own models directory (core/modules/xxx)
//'css' => array('/mymodule/css/mymodule.css.php'), // Set this to relative path of css file if module has its own css file
//'js' => array('/mymodule/js/mymodule.js.php'), // Set this to relative path of js file if module must load a js on all pages
'hooks'=>array('data'=>array('contractservicelist'),'entity'=>'0'),// 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'
//))printFieldListTitle', 'printFieldListOption')
'moduleforexternal'=>0// Set this to 1 if feature of module are opened to external users
);
// Data directories to create when module is enabled.
$this->phpmin=array(5,3);// Minimum version of PHP required by module
$this->need_dolibarr_version=array(7,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
//
// 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();
/*Example:
$this->dictionaries=array(
'langs'=>'mylangfile@mymodule',
'tabname'=>array(MAIN_DB_PREFIX."table1",MAIN_DB_PREFIX."table2",MAIN_DB_PREFIX."table3"),// List of tables we want to see into dictonnary editor
'tablib'=>array("Table1","Table2","Table3"),// Label of tables
'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'),// Request to select fields
'tabsqlsort'=>array("label ASC","label ASC","label ASC"),// Sort order
'tabfield'=>array("code,label","code,label","code,label"),// List of fields (result of select to show dictionary)
'tabfieldvalue'=>array("code,label","code,label","code,label"),// List of fields (list of fields to edit a record)
'tabfieldinsert'=>array("code,label","code,label","code,label"),// List of fields (list of fields for insert)
'tabrowid'=>array("rowid","rowid","rowid"),// Name of columns with primary key (try to always name it 'rowid')
'tabcond'=>array($conf->mymodule->enabled,$conf->mymodule->enabled,$conf->mymodule->enabled)// Condition to show each dictionary
);
*/
// Boxes/Widgets
// Add here list of php file(s) stored in mymodule/core/boxes that contains class to show a widget.
$this->boxes=array(
//0=>array('file'=>'mymodulewidget1.php@mymodule','note'=>'Widget provided by MyModule','enabledbydefaulton'=>'Home'),
//1=>array('file'=>'mymodulewidget2.php@mymodule','note'=>'Widget provided by MyModule'),
//2=>array('file'=>'mymodulewidget3.php@mymodule','note'=>'Widget provided by MyModule')
);
// 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->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')
