2018-03-27 14:15:19 +00:00
< ? php
/* Copyright ( C ) 2004 - 2018 Laurent Destailleur < eldy @ users . sourceforge . net >
*
* 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
2019-09-23 19:55:30 +00:00
* along with this program . If not , see < https :// www . gnu . org / licenses />.
2018-03-27 14:15:19 +00:00
*/
/**
* \defgroup dav Module dav
* \brief dav module descriptor .
*
2019-03-16 15:27:14 +00:00
* \file htdocs / core / modules / modDav . class . php
2018-03-27 14:15:19 +00:00
* \ingroup dav
2021-03-20 12:55:43 +00:00
* \brief Description and activation file for the module dav
2018-03-27 14:15:19 +00:00
*/
2020-04-10 08:59:32 +00:00
include_once DOL_DOCUMENT_ROOT . '/core/modules/DolibarrModules.class.php' ;
2018-03-27 14:15:19 +00:00
/**
* Description and activation class for module dav
*/
class modDav extends DolibarrModules
{
/**
* Constructor . Define names , constants , directories , boxes , permissions
*
* @ param DoliDB $db Database handler
*/
public function __construct ( $db )
{
2020-04-10 08:59:32 +00:00
global $langs , $conf ;
2018-03-27 14:15:19 +00:00
2020-03-23 14:54:02 +00:00
$this -> db = $db ;
2018-03-27 14:15:19 +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).
2018-10-29 10:29:08 +00:00
$this -> numero = 50310 ;
2018-03-27 14:15:19 +00:00
// Key text used to identify module (for permissions, menus, etc...)
$this -> rights_class = 'dav' ;
// 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 = " interface " ;
// Module position in the family on 2 digits ('01', '10', '20', ...)
2018-10-06 09:57:53 +00:00
$this -> module_position = '75' ;
2018-03-27 14:15:19 +00:00
// 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)
//$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
// Module label (no space allowed), used if translation string 'ModuledavName' not found (MyModue is name of module).
2019-01-27 10:55:16 +00:00
$this -> name = preg_replace ( '/^mod/i' , '' , get_class ( $this ));
2018-03-27 14:15:19 +00:00
// Module description, used if translation string 'ModuledavDesc' not found (MyModue is name of module).
$this -> description = " davDescription " ;
// Used only if file README.md and README-LL.md not found.
2018-04-29 16:32:15 +00:00
$this -> descriptionlong = " davDescription " ;
2018-03-27 14:15:19 +00:00
// Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
2018-08-19 00:17:12 +00:00
$this -> version = 'dolibarr' ;
2018-03-27 14:15:19 +00:00
// Key used in llx_const table to save module status enabled/disabled (where DAV 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'
2020-04-10 08:59:32 +00:00
$this -> picto = 'generic' ;
2018-03-27 14:15:19 +00:00
// Defined all module parts (triggers, login, substitutions, menus, css, etc...)
// for default path (eg: /dav/core/xxxxx) (0=disable, 1=enable)
// for specific path of parts (eg: /dav/core/modules/barcode)
// for specific css file (eg: /dav/css/dav.css.php)
2018-05-01 10:40:42 +00:00
$this -> module_parts = array ();
2018-03-27 14:15:19 +00:00
// Data directories to create when module is enabled.
// Example: this->dirs = array("/dav/temp","/dav/subdir");
2020-04-10 08:59:32 +00:00
$this -> dirs = array ( " /dav/temp " , " /dav/public " , " /dav/private " );
2018-03-27 14:15:19 +00:00
// Config pages. Put here list of php page, stored into dav/admin directory, to use to setup module.
$this -> config_page_url = array ( " dav.php " );
// Dependencies
2020-04-10 08:59:32 +00:00
$this -> hidden = false ; // A condition to hide module
$this -> depends = array (); // 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
2018-03-27 14:15:19 +00:00
$this -> langfiles = array ( " admin " );
2023-12-02 15:34:58 +00:00
$this -> phpmin = array ( 7 , 0 ); // Minimum version of PHP required by module
2020-04-10 08:59:32 +00:00
$this -> need_dolibarr_version = array ( 7 , 0 ); // Minimum version of Dolibarr required by module
2025-10-10 08:16:33 +00:00
$this -> warnings_activation = array ();
$this -> warnings_activation_ext = array ();
2018-03-27 14:15:19 +00:00
//$this->automatic_activation = array('FR'=>'davWasAutomaticallyActivatedBecauseOfYourCountryChoice');
// 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('DAV_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
// 1=>array('DAV_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
// );
$this -> const = array (
2018-10-29 10:29:08 +00:00
//1=>array('DAV_MYCONSTANT', 'chaine', 'avalue', 'This is a constant to add', 1, 'allentities', 1)
2018-03-27 14:15:19 +00:00
);
2021-02-23 21:03:23 +00:00
if ( ! isset ( $conf -> dav ) || ! isset ( $conf -> dav -> enabled )) {
2020-04-10 08:59:32 +00:00
$conf -> dav = new stdClass ();
$conf -> dav -> enabled = 0 ;
2018-03-27 14:15:19 +00:00
}
// Array to add new pages in new tabs
2020-03-23 14:54:02 +00:00
$this -> tabs = array ();
2018-03-27 14:15:19 +00:00
// Example:
// $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@dav:$user->rights->dav->read:/dav/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
2020-03-23 14:54:02 +00:00
// $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@dav:$user->rights->othermodule->read:/dav/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
2018-03-27 14:15:19 +00:00
// '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-13 18:48:20 +00:00
// 'member' to add a tab in foundation member view
2018-03-27 14:15:19 +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 sales order view
2018-03-27 14:15:19 +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
2020-03-23 14:54:02 +00:00
// Dictionaries
2020-04-10 08:59:32 +00:00
$this -> dictionaries = array ();
2018-03-27 14:15:19 +00:00
2020-03-23 14:54:02 +00:00
// Boxes/Widgets
2018-03-27 14:15:19 +00:00
// Add here list of php file(s) stored in dav/core/boxes that contains class to show a widget.
2020-03-23 14:54:02 +00:00
$this -> boxes = array (
//0=>array('file'=>'davwidget1.php@dav','note'=>'Widget provided by dav','enabledbydefaulton'=>'Home'),
//1=>array('file'=>'davwidget2.php@dav','note'=>'Widget provided by dav'),
//2=>array('file'=>'davwidget3.php@dav','note'=>'Widget provided by dav')
);
2018-03-27 14:15:19 +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
2018-09-05 20:46:08 +00:00
//$this->cronjobs = array(
2023-12-04 11:07:31 +00:00
//0=>array('label'=>'MyJob label', 'jobtype'=>'method', 'class'=>'/dav/class/myobject.class.php', 'objectname'=>'MyObject', 'method'=>'doScheduledJob', 'parameters'=>'', 'comment'=>'Comment', 'frequency'=>2, 'unitfrequency'=>3600, 'status'=>0, 'test'=>true)
2018-09-05 20:46:08 +00:00
//);
2018-03-27 14:15:19 +00:00
// Example: $this->cronjobs=array(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'=>true),
// 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>true)
// );
// Permissions
2020-04-10 08:59:32 +00:00
$this -> rights = array (); // Permission array used by this module
2018-03-27 14:15:19 +00:00
/*
$r = 0 ;
$this -> rights [ $r ][ 0 ] = $this -> numero + $r ; // Permission id (must not be already used)
$this -> rights [ $r ][ 1 ] = 'Read myobject of dav' ; // Permission label
2019-05-07 21:03:45 +00:00
$this -> rights [ $r ][ 3 ] = 0 ; // Permission by default for new user (0/1)
2018-03-27 14:15:19 +00:00
$this -> rights [ $r ][ 4 ] = 'read' ; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
$this -> rights [ $r ][ 5 ] = '' ; // In php code, permission will be checked by test if ($user->rights->dav->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 dav' ; // Permission label
2019-05-07 21:03:45 +00:00
$this -> rights [ $r ][ 3 ] = 0 ; // Permission by default for new user (0/1)
2018-03-27 14:15:19 +00:00
$this -> rights [ $r ][ 4 ] = 'write' ; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
$this -> rights [ $r ][ 5 ] = '' ; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
$r ++ ;
$this -> rights [ $r ][ 0 ] = $this -> numero + $r ; // Permission id (must not be already used)
$this -> rights [ $r ][ 1 ] = 'Delete myobject of dav' ; // Permission label
2019-05-07 21:03:45 +00:00
$this -> rights [ $r ][ 3 ] = 0 ; // Permission by default for new user (0/1)
2018-03-27 14:15:19 +00:00
$this -> rights [ $r ][ 4 ] = 'delete' ; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
$this -> rights [ $r ][ 5 ] = '' ; // In php code, permission will be checked by test if ($user->rights->dav->level1->level2)
*/
// Main menu entries
2020-04-10 08:59:32 +00:00
$this -> menu = array (); // List of menus to add
$r = 0 ;
2018-03-27 14:15:19 +00:00
// 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' => 'dav' ,
'mainmenu' => 'dav' ,
'leftmenu' => '' ,
'url' => '/dav/davindex.php' ,
'langs' => 'dav@dav' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position' => 1000 + $r ,
'enabled' => '$conf->dav->enabled' , // Define condition to show or hide menu entry. Use '$conf->dav->enabled' if entry must be visible if module is enabled.
'perms' => '1' , // Use 'perms'=>'$user->rights->dav->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 */
/* BEGIN MODULEBUILDER LEFTMENU MYOBJECT
$this -> menu [ $r ++ ] = array ( 'fk_menu' => 'fk_mainmenu=dav' , // '' 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' => 'dav' ,
'leftmenu' => 'dav_myobject_list' ,
'url' => '/dav/myobject_list.php' ,
'langs' => 'dav@dav' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position' => 1000 + $r ,
'enabled' => '$conf->dav->enabled' , // Define condition to show or hide menu entry. Use '$conf->dav->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->dav->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=dav,fk_leftmenu=dav' , // '' 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' => 'New MyObject' ,
'mainmenu' => 'dav' ,
'leftmenu' => 'dav_myobject_new' ,
'url' => '/dav/myobject_page.php?action=create' ,
'langs' => 'dav@dav' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
'position' => 1000 + $r ,
'enabled' => '$conf->dav->enabled' , // Define condition to show or hide menu entry. Use '$conf->dav->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->dav->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 LEFTMENU MYOBJECT */
}
/**
* 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
*
2020-03-23 14:54:02 +00:00
* @ param string $options Options when enabling module ( '' , 'noboxes' )
2018-03-27 14:15:19 +00:00
* @ return int 1 if OK , 0 if KO
*/
2019-01-27 14:20:16 +00:00
public function init ( $options = '' )
2018-03-27 14:15:19 +00:00
{
// Create extrafields
include_once DOL_DOCUMENT_ROOT . '/core/class/extrafields.class.php' ;
$extrafields = new ExtraFields ( $this -> db );
//$result1=$extrafields->addExtraField('myattr1', "New Attr 1 label", 'boolean', 1, 3, 'thirdparty', 0, 0, '', '', 1, '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
//$result2=$extrafields->addExtraField('myattr2', "New Attr 2 label", 'varchar', 1, 10, 'project', 0, 0, '', '', 1, '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
//$result3=$extrafields->addExtraField('myattr3', "New Attr 3 label", 'varchar', 1, 10, 'bank_account', 0, 0, '', '', 1, '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
//$result4=$extrafields->addExtraField('myattr4', "New Attr 4 label", 'select', 1, 3, 'thirdparty', 0, 1, '', array('options'=>array('code1'=>'Val1','code2'=>'Val2','code3'=>'Val3')), 1 '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
//$result5=$extrafields->addExtraField('myattr5', "New Attr 5 label", 'text', 1, 10, 'user', 0, 0, '', '', 1, '', 0, 0, '', '', 'dav@dav', '$conf->dav->enabled');
$sql = array ();
return $this -> _init ( $sql , $options );
}
/**
* 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 );
}
}
