|
dolibarr 21.0.0-alpha
|
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. | |
| print_start_menu_array_auguria () | |
| Output start menu array. | |
| print_start_menu_entry_auguria ($idsel, $classname, $showmode) | |
| Output start menu entry. | |
| print_text_menu_entry_auguria ($text, $showmode, $url, $id, $idsel, $classname, $atarget, $menuval=array()) | |
| Output menu entry. | |
| print_end_menu_entry_auguria ($showmode) | |
| Output end menu entry. | |
| print_end_menu_array_auguria () | |
| Output menu array. | |
| 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) | |
| dol_auguria_showmenu ($type_user, &$menuentry, &$listofmodulesforexternal) | |
| Function to test if an entry is enabled or not. | |
Library for file auguria menus.
Definition in file auguria.lib.php.
| dol_auguria_showmenu | ( | $type_user, | |
| & | $menuentry, | ||
| & | $listofmodulesforexternal ) |
Function to test if an entry is enabled or not.
| int | $type_user | 0=We need backoffice menu, 1=We need frontoffice menu |
| 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,module:string} | $menuentry Array for menu entry | |
| string[] | $listofmodulesforexternal | Array with list of modules allowed to external users |
Definition at line 702 of file auguria.lib.php.
References getDolGlobalString().
Referenced by print_auguria_menu().
| print_auguria_menu | ( | $db, | |
| $atarget, | |||
| $type_user, | |||
| & | $tabMenu, | ||
| & | $menu, | ||
| $noout = 0, | |||
| $mode = '' ) |
Core function to output top menu auguria.
| 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) | |
| Menu | $menu | Object Menu to return back list of menu entries |
| int<0,1> | $noout 1=Disable output (Initialise &$menu only). | |
| string | $mode | 'top', 'topnb', 'left', 'jmobile' |
Definition at line 42 of file auguria.lib.php.
References $id, dol_auguria_showmenu(), dol_buildpath(), dol_escape_htmltag(), dol_sort_array(), getCommonSubstitutionArray(), getDolGlobalInt(), getDolGlobalString(), GETPOSTINT(), make_substitutions(), print_end_menu_array_auguria(), print_end_menu_entry_auguria(), print_start_menu_array_auguria(), print_start_menu_entry_auguria(), and print_text_menu_entry_auguria().
Referenced by MenuManager\showmenu().
| print_end_menu_array_auguria | ( | ) |
Output menu array.
Definition at line 305 of file auguria.lib.php.
Referenced by print_auguria_menu().
| print_end_menu_entry_auguria | ( | $showmode | ) |
Output end menu entry.
| int | $showmode | 0 = hide, 1 = allowed or 2 = not allowed |
Definition at line 292 of file auguria.lib.php.
Referenced by print_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)
| 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<0,1> | $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<string,string> | $moredata An array with more data to output | |
| int<0,1> | $type_user 0=Menu for backoffice, 1=Menu for front office |
Definition at line 330 of file auguria.lib.php.
References dol_buildpath(), dol_print_error(), dol_string_nohtmltag(), dol_trunc(), getCommonSubstitutionArray(), getDolGlobalString(), make_substitutions(), and Account\TYPE_CASH.
Referenced by MenuManager\showmenu().
| print_start_menu_array_auguria | ( | ) |
Output start menu array.
Definition at line 204 of file auguria.lib.php.
Referenced by print_auguria_menu().
| print_start_menu_entry_auguria | ( | $idsel, | |
| $classname, | |||
| $showmode ) |
Output start menu entry.
| string | $idsel | Text |
| string | $classname | String to add a css class |
| int | $showmode | 0 = hide, 1 = allowed or 2 = not allowed |
Definition at line 218 of file auguria.lib.php.
Referenced by print_auguria_menu().
| print_text_menu_entry_auguria | ( | $text, | |
| $showmode, | |||
| $url, | |||
| $id, | |||
| $idsel, | |||
| $classname, | |||
| $atarget, | |||
| $menuval = array() ) |
Output menu entry.
| string | $text | Text |
| int<0,2> | $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{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}|array{} | $menuval The full $menuval array |
Definition at line 240 of file auguria.lib.php.
References dol_escape_htmltag(), and getDolGlobalString().
Referenced by print_auguria_menu().