auguria.lib.php File Reference

Library for file auguria menus. More...

Go to the source code of this file.

Functions
	print_auguria_menu ($db, $atarget, $type_user, &$tabMenu, &$menu, $noout=0, $mode='')
	Core function to output top menu auguria. More...
	print_start_menu_array_auguria ()
	Output start menu array. More...
	print_start_menu_entry_auguria ($idsel, $classname, $showmode)
	Output start menu entry. More...
	print_text_menu_entry_auguria ($text, $showmode, $url, $id, $idsel, $classname, $atarget)
	Output menu entry. More...
	print_end_menu_entry_auguria ($showmode)
	Output end menu entry. More...
	print_end_menu_array_auguria ()
	Output menu array. More...
	print_left_auguria_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 auguria Fill &$menu (example with $forcemainmenu='home' $forceleftmenu='all', return left menu tree of Home) More...
	dol_auguria_showmenu ($type_user, &$menuentry, &$listofmodulesforexternal)
	Function to test if an entry is enabled or not. More...

Detailed Description

Library for file auguria menus.

Definition in file auguria.lib.php.

Function Documentation

dol_auguria_showmenu()

dol_auguria_showmenu	(		$type_user,
		&	$menuentry,
		&	$listofmodulesforexternal
	)

Function to test if an entry is enabled or not.

Parameters

string	$type_user	0=We need backoffice menu, 1=We need frontoffice menu
array	$menuentry	Array for menu entry
array	$listofmodulesforexternal	Array with list of modules allowed to external users

Returns

int 0=Hide, 1=Show, 2=Show gray

Definition at line 663 of file auguria.lib.php.

print_auguria_menu()

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

Core function to output top menu auguria.

Parameters

DoliDB	$db	Database handler
string	$atarget	Target (Example: '' or '_top')
int	$type_user	0=Menu for backoffice, 1=Menu for front office
array	$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	1=Disable output (Initialise &$menu only).
string	$mode	'top', 'topnb', 'left', 'jmobile'

Returns

int 0

Definition at line 40 of file auguria.lib.php.

print_end_menu_array_auguria()

print_end_menu_array_auguria

(

)

Output menu array.

Returns

void

Definition at line 282 of file auguria.lib.php.

print_end_menu_entry_auguria()

print_end_menu_entry_auguria

(

$showmode

)

Output end menu entry.

Parameters

int

$showmode

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

Returns

void

Definition at line 269 of file auguria.lib.php.

print_left_auguria_menu()

print_left_auguria_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 auguria Fill &$menu (example with $forcemainmenu='home' $forceleftmenu='all', return left menu tree of Home)

Parameters

DoliDB	$db	Database handler
array	$menu_array_before	Table of menu entries to show before entries of menu handler (menu->liste filled with menu->add)
array	$menu_array_after	Table of menu entries to show after entries of menu handler (menu->liste filled with menu->add)
array	$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

Definition at line 307 of file auguria.lib.php.

print_start_menu_array_auguria()

print_start_menu_array_auguria

(

)

Output start menu array.

Returns

void

Definition at line 194 of file auguria.lib.php.

print_start_menu_entry_auguria()

print_start_menu_entry_auguria	(		$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 210 of file auguria.lib.php.

print_text_menu_entry_auguria()

print_text_menu_entry_auguria	(		$text,
			$showmode,
			$url,
			$id,
			$idsel,
			$classname,
			$atarget
	)

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

Returns

void

Definition at line 231 of file auguria.lib.php.