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 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.
	print_left_eldy_menu ($db, $menu_array_before, $menu_array_after, &$tabMenu, &$menu, $noout=0, $forcemainmenu='', $forceleftmenu='', $moredata=null, $type_user=0)
	Core function to output left menu eldy Fill &$menu (example with $forcemainmenu='home' $forceleftmenu='all', return left menu tree of Home)
	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	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

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

Referenced by print_left_eldy_menu().

get_left_menu_bank()

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

Get left Menu BANK.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

References getDolGlobalString(), and img_picto().

Referenced by print_left_eldy_menu().

get_left_menu_billing()

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

Get left COMPTA-FINANCIAL.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

References getDolGlobalString(), and img_picto().

Referenced by print_left_eldy_menu().

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	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

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

Referenced by print_left_eldy_menu().

get_left_menu_home()

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

Get left Menu HOME.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of user

Returns

void

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

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

Referenced by print_left_eldy_menu().

get_left_menu_hrm()

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

Get left Menu HRM.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

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

Referenced by print_left_eldy_menu().

get_left_menu_members()

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

Get left Menu MEMBERS.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

References img_picto().

Referenced by print_left_eldy_menu().

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	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

References img_picto().

Referenced by print_left_eldy_menu().

get_left_menu_products()

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

Get left Menu PRODUCTS-SERVICES.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

References getDolGlobalString(), and img_picto().

Referenced by print_left_eldy_menu().

get_left_menu_projects()

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

Get left Menu PROJECTS.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

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

Referenced by print_left_eldy_menu().

get_left_menu_thridparties()

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

Get left Menu THIRDPARTIES.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

References getDolGlobalString(), and img_picto().

Referenced by print_left_eldy_menu().

get_left_menu_tools()

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

Get left Menu TOOLS.

Parameters

string	$mainmenu	Main menu
Menu	$newmenu	Object Menu to return back list of menu entries
int	$usemenuhider	Use menu hider
string	$leftmenu	Left menu
int	$type_user	Type of targeted user for menu

Returns

void

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

References getDolGlobalInt(), and img_picto().

Referenced by print_left_eldy_menu().

print_eldy_menu()

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

Core function to output top menu eldy.

Parameters

DoliDB	$db	Database handler
string	$atarget	Target (Example: '' or '_top')
int	$type_user	0=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,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	$menu	Object Menu to return back list of menu entries
int	$noout	1=Disable output (Initialise &$menu only).
string	$mode	'top', 'topnb', 'left', 'jmobile'

Returns

int 0

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

References dol_buildpath(), dol_escape_htmltag(), dol_sort_array(), getCommonSubstitutionArray(), getDolGlobalInt(), getDolGlobalString(), img_picto(), 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 713 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

$showmode

0 = hide, 1 = allowed or 2 = not allowed

Returns

void

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

Referenced by print_eldy_menu().

print_left_eldy_menu()

print_left_eldy_menu	(		$db,
			$menu_array_before,
			$menu_array_after,
		&	$tabMenu,
		&	$menu,
			$noout = 0,
			$forcemainmenu = '',
			$forceleftmenu = '',
			$moredata = null,
			$type_user = 0 )

Core function to output left menu eldy Fill &$menu (example with $forcemainmenu='home' $forceleftmenu='all', return left menu tree of Home)

Parameters

DoliDB	$db	Database handler
	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,level?:int,prefix:string}>	$menu_array_before Table of menu entries to show before entries of menu handler (menu->liste filled with menu->add)
	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,level?:int,prefix:string}>	$menu_array_after Table of menu entries to show after entries of menu handler (menu->liste filled with menu->add)
	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,level?:int,prefix:string}>	$tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)
Menu	$menu	Object Menu to return back list of menu entries
int	$noout	Disable output (Initialise &$menu only).
string	$forcemainmenu	'x'=Force mainmenu to mainmenu='x'
string	$forceleftmenu	'all'=Force leftmenu to '' (= all). If value come being '', we change it to value in session and 'none' if not defined in session.
array	$moredata	An array with more data to output
int	$type_user	0=Menu for backoffice, 1=Menu for front office

Returns

int Nb of menu entries

We update newmenu with entries found into database

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

References dol_buildpath(), dol_string_nohtmltag(), dol_trunc(), get_left_menu_accountancy(), get_left_menu_bank(), get_left_menu_billing(), get_left_menu_commercial(), get_left_menu_home(), get_left_menu_hrm(), get_left_menu_members(), get_left_menu_mrp(), get_left_menu_products(), get_left_menu_projects(), get_left_menu_thridparties(), get_left_menu_tools(), getCommonSubstitutionArray(), getDolGlobalString(), and make_substitutions().

Referenced by MenuManager\showmenu().

print_start_menu_array()

print_start_menu_array

(

)

Output start menu array.

Returns

void

Definition at line 611 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	$idsel	Text
string	$classname	String to add a css class
int	$showmode	0 = hide, 1 = allowed or 2 = not allowed

Returns

void

Definition at line 625 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	$text	Text
int	$showmode	0 = hide, 1 = allowed or 2 = not allowed
string	$url	Url
string	$id	Id
string	$idsel	Id sel
string	$classname	Class name
string	$atarget	Target
	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,level?:int,prefix:string}	$menuval All the $menuval array

Returns

void

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

References dol_escape_htmltag(), and getDolGlobalString().

Referenced by print_eldy_menu().