dolibarr 23.0.3
eldy.lib.php File Reference

Library for file eldy menus. More...

Go to the source code of this file.

Functions

 print_eldy_menu ($db, $atarget, $type_user, &$tabMenu, &$menu, $noout=0, $mode='')
 Core function to output the top menu eldy.
 
 print_start_menu_array ()
 Output start menu array.
 
 print_start_menu_entry ($idsel, $classname, $showmode)
 Output start menu entry.
 
 print_text_menu_entry ($text, $showmode, $url, $id, $idsel, $classname, $atarget, $menuval=array())
 Output menu entry.
 
 print_end_menu_entry ($showmode)
 Output end menu entry.
 
 print_end_menu_array ()
 Output menu array.
 
 get_left_menu_home ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu HOME.
 
 get_left_menu_thridparties ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu THIRDPARTIES.
 
 get_left_menu_commercial ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu COMMERCIAL (propal, commande, supplier_proposal, supplier_order, contrat, ficheinter)
 
 get_left_menu_billing ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left COMPTA-FINANCIAL.
 
 get_left_menu_accountancy ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left COMPTA-FINANCIAL (accountancy)
 
 get_left_menu_bank ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu BANK.
 
 get_left_menu_products ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu PRODUCTS-SERVICES.
 
 get_left_menu_mrp ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu PRODUCTS-SERVICES MRP - GPAO.
 
 get_left_menu_projects ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu PROJECTS.
 
 get_left_menu_hrm ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu HRM.
 
 get_left_menu_tools ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu TOOLS.
 
 get_left_menu_members ($mainmenu, &$newmenu, $usemenuhider=1, $leftmenu='none', $type_user=0)
 Get left Menu MEMBERS.
 

Detailed Description

Library for file eldy menus.

Definition in file eldy.lib.php.

Function Documentation

◆ get_left_menu_accountancy()

get_left_menu_accountancy ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left COMPTA-FINANCIAL (accountancy)

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 1728 of file eldy.lib.php.

References $mysoc, dol_print_error(), getDolGlobalInt(), getDolGlobalString(), img_picto(), and isModEnabled().

◆ get_left_menu_bank()

get_left_menu_bank ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu BANK.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 2107 of file eldy.lib.php.

References getDolGlobalString(), img_picto(), isModEnabled(), and newToken().

◆ get_left_menu_billing()

get_left_menu_billing ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left COMPTA-FINANCIAL.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 1533 of file eldy.lib.php.

References $mysoc, getDolGlobalString(), img_picto(), and isModEnabled().

◆ get_left_menu_commercial()

get_left_menu_commercial ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu COMMERCIAL (propal, commande, supplier_proposal, supplier_order, contrat, ficheinter)

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 1395 of file eldy.lib.php.

References getDolGlobalInt(), getDolGlobalString(), img_picto(), and isModEnabled().

◆ get_left_menu_home()

get_left_menu_home ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu HOME.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of user
Returns
void

Definition at line 1147 of file eldy.lib.php.

References dol_buildpath(), dolBuildUrl(), getDolGlobalInt(), getDolGlobalString(), getDolUserString(), img_picto(), img_warning(), and isModEnabled().

◆ get_left_menu_hrm()

get_left_menu_hrm ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu HRM.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 2442 of file eldy.lib.php.

References dolBuildUrl(), getDolGlobalString(), GETPOSTINT(), img_picto(), and isModEnabled().

◆ get_left_menu_members()

get_left_menu_members ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu MEMBERS.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 2615 of file eldy.lib.php.

References dolBuildUrl(), getDolGlobalString(), img_picto(), and isModEnabled().

◆ get_left_menu_mrp()

get_left_menu_mrp ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu PRODUCTS-SERVICES MRP - GPAO.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 2332 of file eldy.lib.php.

References img_picto(), and isModEnabled().

◆ get_left_menu_products()

get_left_menu_products ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu PRODUCTS-SERVICES.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 2190 of file eldy.lib.php.

References getDolGlobalString(), img_picto(), and isModEnabled().

◆ get_left_menu_projects()

get_left_menu_projects ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu PROJECTS.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 2366 of file eldy.lib.php.

References dolBuildUrl(), getDolGlobalInt(), getDolGlobalString(), GETPOSTINT(), img_picto(), isModEnabled(), and isVisibleToUserType().

◆ get_left_menu_thridparties()

get_left_menu_thridparties ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu THIRDPARTIES.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 1289 of file eldy.lib.php.

References dolBuildUrl(), getDolGlobalString(), img_picto(), and isModEnabled().

◆ get_left_menu_tools()

get_left_menu_tools ( $mainmenu,
& $newmenu,
$usemenuhider = 1,
$leftmenu = 'none',
$type_user = 0 )

Get left Menu TOOLS.

Parameters
string$mainmenuMain menu
Menu$newmenuObject Menu to return back list of menu entries
int$usemenuhiderUse menu hider
string$leftmenuLeft menu
int$type_userType of targeted user for menu
Returns
void

Definition at line 2553 of file eldy.lib.php.

References dolBuildUrl(), getDolGlobalInt(), img_picto(), and isModEnabled().

◆ print_eldy_menu()

print_eldy_menu ( $db,
$atarget,
$type_user,
& $tabMenu,
& $menu,
$noout = 0,
$mode = '' )

Core function to output the top menu eldy.

Parameters
DoliDB$dbDatabase handler
string$atargetTarget (Example: '' or '_top')
int$type_user0=Menu for backoffice, 1=Menu for front office
array<array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,positionfull:int|string,showtopmenuinframe:int,level?:int,prefix:string}>$tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty). For eldy menu, it contains menu entries loaded from database.
Menu$menuObject Menu to return back list of menu entries
int$noout1=Disable output (Initialise &$menu only).
string$mode'top', 'topnb', 'left', 'jmobile'
Returns
int 0

Definition at line 49 of file eldy.lib.php.

References $id, $mysoc, dol_buildpath(), dol_escape_htmltag(), dol_sort_array(), dolBuildUrl(), getDolGlobalInt(), getDolGlobalString(), getDolUserString(), img_picto(), isModEnabled(), isVisibleToUserType(), make_substitutions(), print_end_menu_array(), print_end_menu_entry(), print_start_menu_array(), print_start_menu_entry(), and print_text_menu_entry().

Referenced by MenuManager\showmenu().

◆ print_end_menu_array()

print_end_menu_array ( )

Output menu array.

Returns
void

Definition at line 735 of file eldy.lib.php.

Referenced by print_eldy_menu().

◆ print_end_menu_entry()

print_end_menu_entry ( $showmode)

Output end menu entry.

Parameters
int$showmode0 = hide, 1 = allowed or 2 = not allowed
Returns
void

Definition at line 722 of file eldy.lib.php.

Referenced by print_eldy_menu().

◆ print_start_menu_array()

print_start_menu_array ( )

Output start menu array.

Returns
void

Definition at line 632 of file eldy.lib.php.

Referenced by print_eldy_menu().

◆ print_start_menu_entry()

print_start_menu_entry ( $idsel,
$classname,
$showmode )

Output start menu entry.

Parameters
string$idselText
string$classnameString to add a css class
int$showmode0 = hide, 1 = allowed or 2 = not allowed
Returns
void

Definition at line 646 of file eldy.lib.php.

Referenced by print_eldy_menu().

◆ print_text_menu_entry()

print_text_menu_entry ( $text,
$showmode,
$url,
$id,
$idsel,
$classname,
$atarget,
$menuval = array() )

Output menu entry.

Parameters
string$textText
int$showmode0 = hide, 1 = allowed or 2 = not allowed
string$urlUrl
string$idId
string$idselId sel
string$classnameClass name
string$atargetTarget
array{}|array{rowid:string,fk_menu:string,langs:string,enabled:int<0,2>,type:string,fk_mainmenu:string,fk_leftmenu:string,url:string,titre:string,perms:string,target:string,mainmenu:string,leftmenu:string,position:int,positionfull:int|string,showtopmenuinframe:int,level?:int,prefix:string}$menuval All the $menuval array
Returns
void

Definition at line 668 of file eldy.lib.php.

References dol_escape_htmltag(), and getDolGlobalString().

Referenced by print_eldy_menu().