dolibarr  20.0.0-alpha
Functions
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, $menuval=array())
 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_user0=We need backoffice menu, 1=We need frontoffice menu
array$menuentryArray for menu entry
array$listofmodulesforexternalArray with list of modules allowed to external users
Returns
int 0=Hide, 1=Show, 2=Show gray

Definition at line 696 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$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,level:int,prefix:string}>$tabMenu If array with menu entries already loaded, we put this array here (in most cases, it's empty)
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 41 of file auguria.lib.php.

◆ print_end_menu_array_auguria()

print_end_menu_array_auguria ( )

Output menu array.

Returns
void

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

◆ print_end_menu_entry_auguria()

print_end_menu_entry_auguria (   $showmode)

Output end menu entry.

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

Definition at line 286 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$dbDatabase 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$menuObject Menu to return back list of menu entries
int$nooutDisable 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$moredataAn array with more data to output
int$type_user0=Menu for backoffice, 1=Menu for front office
Returns
int Nb of menu entries

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

◆ print_start_menu_array_auguria()

print_start_menu_array_auguria ( )

Output start menu array.

Returns
void

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

◆ print_start_menu_entry_auguria()

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

◆ print_text_menu_entry_auguria()

print_text_menu_entry_auguria (   $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$menuvalAll the $menuval array
Returns
void

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