|
dolibarr 24.0.0-beta
|
File that defines environment for Dolibarr GUI pages only (file not required by scripts) More...
Go to the source code of this file.
Functions | |
| if(!defined( 'NOREQUIREMENU')) if(!empty(GETPOST('seteventmessages', 'alpha'))) if(!function_exists("llxHeader")) | top_httphead ($contenttype='text/html', $forcenocache=0) |
| Show HTTP header. | |
| top_htmlhead ($head, $title='', $disablejs=0, $disablehead=0, $arrayofjs=array(), $arrayofcss=array(), $disableforlogin=0, $disablenofollow=0, $disablenoindex=0) | |
| Output html header of a page. | |
| top_menu ($head, $title='', $target='', $disablejs=0, $disablehead=0, $arrayofjs=array(), $arrayofcss=array(), $morequerystring='', $helppagename='') | |
| Show an HTML header + a BODY + The top menu bar. | |
| top_menu_user ($hideloginname=0, $urllogout='') | |
| Build the tooltip on user login. | |
| top_menu_ai () | |
| Build the HTML for the AI Assistant entry of the top menu: a toggle icon and a floating popover panel (vanilla JS + CSS) whose chat content is loaded once via AJAX from /ai/assistant/popover.php, then kept in the DOM so the conversation persists across open/close while staying on the same page. | |
| top_menu_quickadd () | |
| Build the tooltip on top menu quick add. | |
| top_menu_importfile () | |
| Build the tooltip on top menu quick add. | |
| printDropdownQuickadd ($mode=0) | |
| Generate list of quickadd items. | |
| top_menu_bookmark () | |
| Build the tooltip on top menu bookmark. | |
| top_menu_search () | |
| Build the tooltip on top menu search. | |
| left_menu ($menu_array_before, $helppagename='', $notused='', $menu_array_after=array(), $leftmenuwithoutmainarea=0, $title='', $acceptdelayedhtml=0) | |
| Show left menu bar. | |
| main_area ($title='') | |
| Begin main area. | |
| getHelpParamFor ($helppagename, $langs) | |
| Return helpbaseurl, helppage and mode. | |
| printSearchForm ($urlaction, $urlobject, $title, $htmlmorecss, $htmlinputname, $accesskey='', $prefhtmlinputname='', $img='', $showtitlebefore=0, $autofocus=0) | |
| Show a search area. | |
File that defines environment for Dolibarr GUI pages only (file not required by scripts)
Definition in file main.inc.php.
| getHelpParamFor | ( | $helppagename, | |
| $langs ) |
Return helpbaseurl, helppage and mode.
| string | $helppagename | Page name ('EN:xxx,ES:eee,FR:fff,DE:ddd...' or 'http://localpage') |
| Translate | $langs | Language |
Definition at line 3702 of file main.inc.php.
Referenced by top_menu().
| left_menu | ( | $menu_array_before, | |
| $helppagename = '', | |||
| $notused = '', | |||
| $menu_array_after = array(), | |||
| $leftmenuwithoutmainarea = 0, | |||
| $title = '', | |||
| $acceptdelayedhtml = 0 ) |
Show left menu bar.
| '' | $menu_array_before Table of menu entries to show before entries of menu handler. This param is deprecated and must be provided to ''. | |
| string | $helppagename | Name of wiki page for help ('' by default). Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage|DE:GermanPage For other external page: http://server/url |
| string | $notused | Deprecated. Used in past to add content into left menu. Hooks can be used now. |
| 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,showtopmenuinframe:int,level?:int,prefix:string}> | $menu_array_after Table of menu entries to show after entries of menu handler | |
| int | $leftmenuwithoutmainarea | Must be set to 1. 0 by default for backward compatibility with old modules. |
| string | $title | Title of web page |
| int<0,1> | $acceptdelayedhtml 1 if caller request to have html delayed content not returned but saved into global $delayedhtmlcontent (so caller can show it at end of page to avoid flash FOUC effect) |
Definition at line 3388 of file main.inc.php.
References $conf, $db, dol_escape_htmltag(), dol_syslog(), getDolGlobalInt(), getDolGlobalString(), main_area(), and printSearchForm().
| main_area | ( | $title = '' | ) |
Begin main area.
| string | $title | Title |
Definition at line 3640 of file main.inc.php.
References $conf, dol_escape_htmltag(), getDolGlobalString(), GETPOST(), and info_admin().
Referenced by left_menu().
| printDropdownQuickadd | ( | $mode = 0 | ) |
Generate list of quickadd items.
| int | $mode | 1=No scroll |
Definition at line 2953 of file main.inc.php.
References getDolGlobalString(), img_picto(), and isModEnabled().
Referenced by top_menu_quickadd().
| printSearchForm | ( | $urlaction, | |
| $urlobject, | |||
| $title, | |||
| $htmlmorecss, | |||
| $htmlinputname, | |||
| $accesskey = '', | |||
| $prefhtmlinputname = '', | |||
| $img = '', | |||
| $showtitlebefore = 0, | |||
| $autofocus = 0 ) |
Show a search area.
Used when the javascript quick search is not used.
| string | $urlaction | Url post |
| string | $urlobject | Url of the link under the search box |
| string | $title | Title search area |
| string | $htmlmorecss | Add more css |
| string | $htmlinputname | Field Name input form |
| string | $accesskey | Accesskey |
| string | $prefhtmlinputname | Complement for id to avoid multiple same id in the page |
| string | $img | Image to use |
| int | $showtitlebefore | Show title before input text instead of into placeholder. This can be set when output is dedicated for text browsers. |
| int | $autofocus | Set autofocus on field |
Show HTML footer Close div /DIV class=fiche + /DIV id-right + /DIV id-container + /BODY + /HTML. If global var $delayedhtmlcontent was filled, we output it just before closing the body.
Note: also called by functions.lib:recordNotFound
| string | $comment | A text to add as HTML comment into HTML generated page |
| string | $zone | 'private' (for private pages) or 'public' (for public pages) |
| int | $disabledoutputofmessages | Clear all messages stored into session without displaying them |
Definition at line 3762 of file main.inc.php.
References img_picto().
Referenced by left_menu().
| top_htmlhead | ( | $head, | |
| $title = '', | |||
| $disablejs = 0, | |||
| $disablehead = 0, | |||
| $arrayofjs = array(), | |||
| $arrayofcss = array(), | |||
| $disableforlogin = 0, | |||
| $disablenofollow = 0, | |||
| $disablenoindex = 0 ) |
Output html header of a page.
It calls also top_httphead() This code is also duplicated into security2.lib.php\dol_loginfunction
| string | $head | Optional head lines |
| string | $title | HTML title |
| int<0,2> | $disablejs Disable js output (1) or disable output except jquery (2) | |
| int<0,1> | $disablehead Disable head output | |
| string[] | $arrayofjs | Array of complementary js files |
| string[] | $arrayofcss | Array of complementary css files |
| int<0,1> | $disableforlogin Do not load heavy js and css for login pages | |
| int<0,1> | $disablenofollow Disable nofollow tag for meta robots | |
| int<0,1> | $disablenoindex Disable noindex tag for meta robots |
see Documentation at admin/tools/ui/dolibarr-context/index.php
Definition at line 1683 of file main.inc.php.
References $conf, $db, $mysoc, dol_buildpath(), dol_htmlentities(), dol_syslog(), dolibarr_set_const(), getDolGlobalInt(), getDolGlobalString(), GETPOST(), GETPOSTINT(), isModEnabled(), and top_httphead().
Referenced by Documentation\docHeader(), llxHeaderSubscriptionOk(), llxHeaderSurvey(), llxHeaderTicket(), llxHeaderVierge(), and top_menu().
| if(!defined('NOREQUIREMENU')) if(!empty(GETPOST( 'seteventmessages', 'alpha'))) if(!function_exists("llxHeader")) top_httphead | ( | $contenttype = 'text/html', | |
| $forcenocache = 0 ) |
Show HTTP header.
Called by top_htmlhead().
| string | $contenttype | Content type. For example, 'text/html' |
| int<0,1> | $forcenocache Force disabling of cache for the page |
Definition at line 1512 of file main.inc.php.
References $conf, $db, and getDolGlobalString().
Referenced by barcode_outimage(), DocumentController\display(), AccountancyExport\export(), httponly_accessforbidden(), llxHeaderVierge(), and top_htmlhead().
| top_menu | ( | $head, | |
| $title = '', | |||
| $target = '', | |||
| $disablejs = 0, | |||
| $disablehead = 0, | |||
| $arrayofjs = array(), | |||
| $arrayofcss = array(), | |||
| $morequerystring = '', | |||
| $helppagename = '' ) |
Show an HTML header + a BODY + The top menu bar.
| string | $head | Lines in the HEAD |
| string | $title | Title of web page |
| string | $target | Target to use in menu links (Example: '' or '_top') |
| int<0,1> | $disablejs Do not output links to js (Ex: qd fonction utilisee par sous formulaire Ajax) | |
| int<0,1> | $disablehead Do not output head section | |
| string[] | $arrayofjs | Array of js files to add in header |
| string[] | $arrayofcss | Array of css files to add in header |
| string | $morequerystring | Query string to add to the link "print" to get same parameters (use only if autodetect fails) |
| string | $helppagename | Name of wiki page for help ('' by default). Syntax is: For a wiki page: EN:EnglishPage|FR:FrenchPage|ES:SpanishPage|DE:GermanPage For other external page: http://server/url |
Definition at line 2178 of file main.inc.php.
References $conf, $db, dol_escape_htmltag(), dolBuildUrl(), getDolGlobalInt(), getDolGlobalString(), getHelpParamFor(), GETPOSTINT(), img_picto(), isModEnabled(), top_htmlhead(), top_menu_ai(), top_menu_bookmark(), top_menu_importfile(), top_menu_quickadd(), top_menu_search(), and top_menu_user().
| top_menu_ai | ( | ) |
Build the HTML for the AI Assistant entry of the top menu: a toggle icon and a floating popover panel (vanilla JS + CSS) whose chat content is loaded once via AJAX from /ai/assistant/popover.php, then kept in the DOM so the conversation persists across open/close while staying on the same page.
Definition at line 2721 of file main.inc.php.
References $conf, dol_escape_js(), getDolGlobalString(), and isModEnabled().
Referenced by top_menu().
| top_menu_bookmark | ( | ) |
Build the tooltip on top menu bookmark.
Definition at line 3144 of file main.inc.php.
References $conf, getDolGlobalString(), isModEnabled(), and printDropdownBookmarksList().
Referenced by top_menu().
| top_menu_importfile | ( | ) |
Build the tooltip on top menu quick add.
Called when MAIN_USE_TOP_MENU_IMPORT_FILE is set to 1 or to an URL string.
Definition at line 2920 of file main.inc.php.
References $conf, and getDolGlobalString().
Referenced by top_menu().
| top_menu_quickadd | ( | ) |
Build the tooltip on top menu quick add.
Called when option MAIN_USE_TOP_MENU_QUICKADD_DROPDOWN is set
Definition at line 2850 of file main.inc.php.
References $conf, getDolGlobalString(), and printDropdownQuickadd().
Referenced by top_menu().
| top_menu_search | ( | ) |
Build the tooltip on top menu search.
Definition at line 3230 of file main.inc.php.
Referenced by top_menu().
| top_menu_user | ( | $hideloginname = 0, | |
| $urllogout = '' ) |
Build the tooltip on user login.
| int<0,1> | $hideloginname Hide login name. Show only the image. | |
| string | $urllogout | URL for logout (Will use DOL_URL_ROOT.'/user/logout.php?token=...' if empty) |
Definition at line 2449 of file main.inc.php.
References $conf, $db, $mysoc, dol_escape_htmltag(), dol_print_date(), dol_print_profids(), dolBuildUrl(), dolButtonToOpenUrlInDialogPopup(), getDolCurrency(), getDolGlobalString(), img_picto(), isModEnabled(), picto_from_langcode(), Form\showphoto(), and yn().
Referenced by top_menu().