2022-11-14 00:26:01 +00:00
< ? php
/* Copyright ( C ) 2004 - 2018 Laurent Destailleur < eldy @ users . sourceforge . net >
* Copyright ( C ) 2018 - 2019 Nicolas ZABOURI < info @ inovea - conseil . com >
2024-11-13 20:21:15 +00:00
* Copyright ( C ) 2019 - 2024 Frédéric France < frederic . france @ free . fr >
* Copyright ( C ) 2024 MDW < mdeweerd @ users . noreply . github . com >
2022-11-14 00:26:01 +00:00
*
* 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 bookcal Module BookCal
* \brief BookCal module descriptor .
*
2024-06-04 08:59:54 +00:00
* \file htdocs / core / modules / modBookCal . class . php
2022-11-14 00:26:01 +00:00
* \ingroup bookcal
* \brief Description and activation file for module BookCal
*/
include_once DOL_DOCUMENT_ROOT . '/core/modules/DolibarrModules.class.php' ;
/**
* Description and activation class for module BookCal
*/
class modBookCal extends DolibarrModules
{
/**
* Constructor . Define names , constants , directories , boxes , permissions
*
* @ param DoliDB $db Database handler
*/
public function __construct ( $db )
{
2025-11-12 15:02:03 +00:00
global $conf ;
2023-01-19 00:16:39 +00:00
2022-11-14 00:26:01 +00:00
$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).
2023-01-19 00:16:39 +00:00
$this -> numero = 2430 ;
2022-11-14 00:26:01 +00:00
// Key text used to identify module (for permissions, menus, etc...)
$this -> rights_class = 'bookcal' ;
// 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
2025-11-12 15:02:03 +00:00
$this -> family = " portal " ;
2022-11-14 00:26:01 +00:00
// Module position in the family on 2 digits ('01', '10', '20', ...)
$this -> module_position = '50' ;
// 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 'ModuleBookCalName' not found (BookCal is name of module).
$this -> name = preg_replace ( '/^mod/i' , '' , get_class ( $this ));
// Module description, used if translation string 'ModuleBookCalDesc' not found (BookCal is name of module).
$this -> description = " BookCalDescription " ;
// Used only if file README.md and README-LL.md not found.
$this -> descriptionlong = " BookCalDescription " ;
// Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
2024-02-14 03:47:46 +00:00
$this -> version = 'experimental' ;
2022-11-14 00:26:01 +00:00
// Key used in llx_const table to save module status enabled/disabled (where BOOKCAL 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'
// To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
2024-03-14 15:40:06 +00:00
$this -> picto = 'bookcal' ;
2022-11-14 00:26:01 +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 ,
// Set this to 1 if module has its own printing directory (core/modules/printing)
'printing' => 0 ,
// 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 (
// '/bookcal/css/bookcal.css.php',
),
// Set this to relative path of js file if module must load a js on all pages
'js' => array (
// '/bookcal/js/bookcal.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 ,
);
// Data directories to create when module is enabled.
// Example: this->dirs = array("/bookcal/temp","/bookcal/subdir");
$this -> dirs = array ( " /bookcal/temp " );
// Config pages. Put here list of php page, stored into bookcal/admin directory, to use to setup module.
$this -> config_page_url = array ( " setup.php@bookcal " );
// Dependencies
// A condition to hide module
$this -> hidden = false ;
2023-04-21 11:27:50 +00:00
// List of module class names as string that must be enabled if this module is enabled. Example: array('always'=>array('modModuleToEnable1','modModuleToEnable2'), 'FR'=>array('modModuleToEnableFR'...))
2022-11-14 00:26:01 +00:00
$this -> depends = array ();
$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', ...)
// The language file dedicated to your module
2023-11-07 19:42:13 +00:00
$this -> langfiles = array ( " agenda " );
2022-11-14 00:26:01 +00:00
// Messages at activation
2025-10-10 08:16:33 +00:00
$this -> warnings_activation = array ();
$this -> warnings_activation_ext = array ();
2022-11-14 00:26:01 +00:00
//$this->automatic_activation = array('FR'=>'BookCalWasAutomaticallyActivatedBecauseOfYourCountryChoice');
// 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('BOOKCAL_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
// 2 => array('BOOKCAL_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
// );
$this -> const = array ();
// 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'
) */
if ( ! isset ( $conf -> bookcal ) || ! isset ( $conf -> bookcal -> enabled )) {
$conf -> bookcal = new stdClass ();
$conf -> bookcal -> enabled = 0 ;
}
// Array to add new pages in new tabs
$this -> tabs = array ();
// Example:
// $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@bookcal:$user->rights->bookcal->read:/bookcal/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
// $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@bookcal:$user->rights->othermodule->read:/bookcal/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
2024-01-13 18:48:20 +00:00
// 'member' to add a tab in foundation member view
2022-11-14 00:26:01 +00:00
// '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' => 'bookcal@bookcal' ,
2024-10-23 18:23:07 +00:00
// List of tables we want to see into dictionary editor
2022-11-14 00:26:01 +00:00
'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 ( $conf -> bookcal -> enabled , $conf -> bookcal -> enabled , $conf -> bookcal -> enabled )
// Help tooltip for each fields of the dictionary
'tabhelp' => array ( array ( 'code' => $langs -> trans ( 'CodeTooltipHelp' )))
);
*/
// Boxes/Widgets
// Add here list of php file(s) stored in bookcal/core/boxes that contains a class to show a widget.
$this -> boxes = array (
// 0 => array(
// 'file' => 'bookcalwidget1.php@bookcal',
// 'note' => 'Widget provided by BookCal',
// 'enabledbydefaulton' => 'Home',
// ),
// ...
);
// 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 -> cronjobs = array (
// 0 => array(
// 'label' => 'MyJob label',
// 'jobtype' => 'method',
// 'class' => '/bookcal/class/availabilities.class.php',
// 'objectname' => 'Availabilities',
// 'method' => 'doScheduledJob',
// 'parameters' => '',
// 'comment' => 'Comment',
// 'frequency' => 2,
// 'unitfrequency' => 3600,
// 'status' => 0,
2026-03-30 09:38:39 +00:00
// 'test' => 'isModEnabled('bookcal')',
2022-11-14 00:26:01 +00:00
// 'priority' => 50,
// ),
);
// 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'=>'$conf->bookcal->enabled', 'priority'=>50),
// 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'$conf->bookcal->enabled', 'priority'=>50)
// );
// Permissions provided by this module
$this -> rights = array ();
$r = 0 ;
// Add here entries to declare new permissions
/* BEGIN MODULEBUILDER PERMISSIONS */
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( '%02d' , ( 0 * 10 ) + 1 );
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 1 ] = 'Read objects of BookCal' ;
2022-11-14 00:26:01 +00:00
$this -> rights [ $r ][ 4 ] = 'availabilities' ;
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 5 ] = 'read' ;
2022-11-14 00:26:01 +00:00
$r ++ ;
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( '%02d' , ( 0 * 10 ) + 2 );
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 1 ] = 'Create/Update objects of BookCal' ;
2022-11-14 00:26:01 +00:00
$this -> rights [ $r ][ 4 ] = 'availabilities' ;
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 5 ] = 'write' ;
2022-11-14 00:26:01 +00:00
$r ++ ;
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( '%02d' , ( 0 * 10 ) + 3 );
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 1 ] = 'Delete objects of BookCal' ;
2022-11-14 00:26:01 +00:00
$this -> rights [ $r ][ 4 ] = 'availabilities' ;
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 5 ] = 'delete' ;
2022-11-14 00:26:01 +00:00
$r ++ ;
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( '%02d' , ( 1 * 10 ) + 1 );
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 1 ] = 'Read Calendar object of BookCal' ;
$this -> rights [ $r ][ 4 ] = 'calendar' ;
$this -> rights [ $r ][ 5 ] = 'read' ;
$r ++ ;
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( '%02d' , ( 1 * 10 ) + 2 );
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 1 ] = 'Create/Update Calendar object of BookCal' ;
$this -> rights [ $r ][ 4 ] = 'calendar' ;
$this -> rights [ $r ][ 5 ] = 'write' ;
$r ++ ;
2023-08-01 22:37:02 +00:00
$this -> rights [ $r ][ 0 ] = $this -> numero . sprintf ( '%02d' , ( 1 * 10 ) + 3 );
2023-07-23 21:31:12 +00:00
$this -> rights [ $r ][ 1 ] = 'Delete Calendar object of BookCal' ;
$this -> rights [ $r ][ 4 ] = 'calendar' ;
$this -> rights [ $r ][ 5 ] = 'delete' ;
$r ++ ;
2022-11-14 00:26:01 +00:00
/* END MODULEBUILDER PERMISSIONS */
// Main menu entries to add
$this -> menu = array ();
$r = 0 ;
// Add here entries to declare new menus
/* BEGIN MODULEBUILDER TOPMENU */
2023-09-05 14:32:02 +00:00
/* $this -> menu [ $r ++ ] = array (
2022-11-14 00:26:01 +00:00
'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' => 'ModuleBookCalName' ,
2023-10-13 13:00:51 +00:00
'prefix' => img_picto ( '' , $this -> picto , 'class="pictofixedwidth valignmiddle"' ),
2022-11-14 00:26:01 +00:00
'mainmenu' => 'bookcal' ,
'leftmenu' => '' ,
'url' => '/bookcal/bookcalindex.php' ,
2023-08-08 19:44:23 +00:00
'langs' => 'bookcal' , // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
2022-11-14 00:26:01 +00:00
'position' => 1000 + $r ,
'enabled' => '$conf->bookcal->enabled' , // Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled.
2023-08-08 19:44:23 +00:00
'perms' => '$user->rights->bookcal->availabilities->read' , // Use 'perms'=>'$user->rights->bookcal->availabilities->read' if you want your menu with a permission rules
2022-11-14 00:26:01 +00:00
'target' => '' ,
'user' => 2 , // 0=Menu for internal users, 1=external users, 2=both
2023-09-05 14:32:02 +00:00
); */
2022-11-14 00:26:01 +00:00
/* END MODULEBUILDER TOPMENU */
2023-08-08 19:44:23 +00:00
/* BEGIN MODULEBUILDER LEFTMENU CALENDAR */
2023-09-05 14:32:02 +00:00
$this -> menu [ $r ++ ] = array (
2024-03-12 23:30:33 +00:00
'fk_menu' => 'fk_mainmenu=agenda' ,
'type' => 'left' ,
'titre' => 'MenuBookcalIndex' ,
2023-09-05 14:32:02 +00:00
'prefix' => img_picto ( '' , $this -> picto , 'class="paddingright pictofixedwidth em92"' ),
2024-03-12 23:30:33 +00:00
'mainmenu' => 'agenda' ,
'leftmenu' => 'bookcal' ,
'url' => '/bookcal/bookcalindex.php' ,
'langs' => 'bookcal' ,
'position' => 1100 + $r ,
'enabled' => '1' ,
2025-11-26 23:21:50 +00:00
'perms' => '$user->hasRight("bookcal", "calendar", "read")' ,
2024-03-12 23:30:33 +00:00
'user' => 0
2023-09-05 14:32:02 +00:00
);
2024-03-12 23:30:33 +00:00
$this -> menu [ $r ++ ] = array (
2023-08-08 19:44:23 +00:00
// '' 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
2024-03-12 23:30:33 +00:00
'fk_menu' => 'fk_mainmenu=agenda,fk_leftmenu=bookcal' ,
2023-08-08 19:44:23 +00:00
// This is a Left menu entry
2024-03-12 23:30:33 +00:00
'type' => 'left' ,
'titre' => 'Calendar' ,
'mainmenu' => 'agenda' ,
'leftmenu' => 'bookcal_calendar_list' ,
'url' => '/bookcal/calendar_list.php' ,
2023-08-08 19:44:23 +00:00
// Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
2024-03-12 23:30:33 +00:00
'langs' => 'bookcal' ,
'position' => 1100 + $r ,
2023-08-08 19:44:23 +00:00
// Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
2025-11-26 23:21:50 +00:00
'enabled' => 'isModEnabled("bookcal")' ,
2023-08-08 19:44:23 +00:00
// Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
2025-11-26 23:21:50 +00:00
'perms' => '$user->hasRight("bookcal", "calendar", "read")' ,
2024-03-12 23:30:33 +00:00
'target' => '' ,
2023-08-08 19:44:23 +00:00
// 0=Menu for internal users, 1=external users, 2=both
2024-03-12 23:30:33 +00:00
'user' => 2 ,
2023-08-08 19:44:23 +00:00
);
2024-03-12 23:30:33 +00:00
$this -> menu [ $r ++ ] = array (
2023-08-08 19:44:23 +00:00
// '' 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
2024-03-12 23:30:33 +00:00
'fk_menu' => 'fk_mainmenu=agenda,fk_leftmenu=bookcal_calendar_list' ,
2023-08-08 19:44:23 +00:00
// This is a Left menu entry
2024-03-12 23:30:33 +00:00
'type' => 'left' ,
'titre' => 'NewCalendar' ,
'mainmenu' => 'agenda' ,
'leftmenu' => 'bookcal_new' ,
'url' => '/bookcal/calendar_card.php?action=create' ,
2023-08-08 19:44:23 +00:00
// Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
2024-03-12 23:30:33 +00:00
'langs' => 'bookcal' ,
'position' => 1100 + $r ,
2023-08-08 19:44:23 +00:00
// Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
2025-11-26 23:21:50 +00:00
'enabled' => 'isModEnabled("bookcal")' ,
2023-08-08 19:44:23 +00:00
// Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
2025-11-26 23:21:50 +00:00
'perms' => '$user->hasRight("bookcal", "calendar", "read")' ,
2024-03-12 23:30:33 +00:00
'target' => '' ,
2023-08-08 19:44:23 +00:00
// 0=Menu for internal users, 1=external users, 2=both
2024-03-12 23:30:33 +00:00
'user' => 2
2023-08-08 19:44:23 +00:00
);
/* END MODULEBUILDER LEFTMENU CALENDAR */
2025-11-12 15:02:03 +00:00
/* BEGIN MODULEBUILDER LEFTMENU AVAILABILITIES */
2022-11-14 00:26:01 +00:00
2024-03-12 23:30:33 +00:00
$this -> menu [ $r ++ ] = array (
2022-11-14 00:26:01 +00:00
// '' 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
2024-03-12 23:30:33 +00:00
'fk_menu' => 'fk_mainmenu=agenda,fk_leftmenu=bookcal' ,
2022-11-14 00:26:01 +00:00
// This is a Left menu entry
2024-03-12 23:30:33 +00:00
'type' => 'left' ,
'titre' => 'Availabilities' ,
'mainmenu' => 'agenda' ,
'leftmenu' => 'bookcal_availabilities' ,
'url' => '/bookcal/availabilities_list.php' ,
2022-11-14 00:26:01 +00:00
// Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
2024-03-12 23:30:33 +00:00
'langs' => 'bookcal' ,
'position' => 1200 + $r ,
2022-11-14 00:26:01 +00:00
// Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
2025-11-26 23:21:50 +00:00
'enabled' => 'isModEnabled("bookcal")' ,
2022-11-14 00:26:01 +00:00
// Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
2025-11-26 23:21:50 +00:00
'perms' => '$user->hasRight("bookcal", "availabilities", "read")' ,
2024-03-12 23:30:33 +00:00
'target' => '' ,
2022-11-14 00:26:01 +00:00
// 0=Menu for internal users, 1=external users, 2=both
2024-03-12 23:30:33 +00:00
'user' => 2 ,
2022-11-14 00:26:01 +00:00
);
2024-03-12 23:30:33 +00:00
$this -> menu [ $r ++ ] = array (
2022-11-14 00:26:01 +00:00
// '' 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
2024-03-12 23:30:33 +00:00
'fk_menu' => 'fk_mainmenu=agenda,fk_leftmenu=bookcal_availabilities' ,
2022-11-14 00:26:01 +00:00
// This is a Left menu entry
2024-03-12 23:30:33 +00:00
'type' => 'left' ,
'titre' => 'NewAvailabilities' ,
'mainmenu' => 'agenda' ,
'leftmenu' => 'bookcal_availabilities' ,
'url' => '/bookcal/availabilities_card.php?action=create' ,
2022-11-14 00:26:01 +00:00
// Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
2024-03-12 23:30:33 +00:00
'langs' => 'bookcal' ,
'position' => 1200 + $r ,
2022-11-14 00:26:01 +00:00
// Define condition to show or hide menu entry. Use '$conf->bookcal->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
2025-11-26 23:21:50 +00:00
'enabled' => 'isModEnabled("bookcal")' ,
2022-11-14 00:26:01 +00:00
// Use 'perms'=>'$user->rights->bookcal->level1->level2' if you want your menu with a permission rules
2025-11-26 23:21:50 +00:00
'perms' => '$user->hasRight("bookcal", "availabilities", "read")' ,
2024-03-12 23:30:33 +00:00
'target' => '' ,
2022-11-14 00:26:01 +00:00
// 0=Menu for internal users, 1=external users, 2=both
2024-03-12 23:30:33 +00:00
'user' => 2
2022-11-14 00:26:01 +00:00
);
/* END MODULEBUILDER LEFTMENU AVAILABILITIES */
2025-11-12 15:02:03 +00:00
2022-11-14 00:26:01 +00:00
// Exports profiles provided by this module
$r = 1 ;
/* BEGIN MODULEBUILDER EXPORT AVAILABILITIES */
/*
2023-11-07 19:42:13 +00:00
$langs -> load ( " agenda " );
2022-11-14 00:26:01 +00:00
$this -> export_code [ $r ] = $this -> rights_class . '_' . $r ;
$this -> export_label [ $r ] = 'AvailabilitiesLines' ; // Translation key (used only if key ExportDataset_xxx_z not found)
$this -> export_icon [ $r ] = 'availabilities@bookcal' ;
// Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
$keyforclass = 'Availabilities' ; $keyforclassfile = '/bookcal/class/availabilities.class.php' ; $keyforelement = 'availabilities@bookcal' ;
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 = 'AvailabilitiesLine'; $keyforclassfile='/bookcal/class/availabilities.class.php'; $keyforelement='availabilitiesline@bookcal'; $keyforalias='tl';
//include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
$keyforselect = 'availabilities' ; $keyforaliasextra = 'extra' ; $keyforelement = 'availabilities@bookcal' ;
include DOL_DOCUMENT_ROOT . '/core/extrafieldsinexport.inc.php' ;
//$keyforselect='availabilitiesline'; $keyforaliasextra='extraline'; $keyforelement='availabilitiesline@bookcal';
//include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
//$this->export_dependencies_array[$r] = array('availabilitiesline'=>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 ' ;
$this -> export_sql_end [ $r ] = ' FROM ' . MAIN_DB_PREFIX . 'availabilities as t' ;
//$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'availabilities_line as tl ON tl.fk_availabilities = t.rowid';
$this -> export_sql_end [ $r ] .= ' WHERE 1 = 1' ;
$this -> export_sql_end [ $r ] .= ' AND t.entity IN (' . getEntity ( 'availabilities' ) . ')' ;
$r ++ ; */
/* END MODULEBUILDER EXPORT AVAILABILITIES */
}
/**
* 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 = '' )
{
2023-01-19 00:16:39 +00:00
$result = $this -> _load_tables ( '/install/mysql/' , 'bookcal' );
2022-11-14 00:26:01 +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')
}
// Permissions
$this -> remove ( $options );
$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 );
}
}