File that defines environment for Dolibarr GUI pages only (file not required by scripts) More...

Functions
if(!empty($_SERVER['MAIN_SHOW_TUNING_INFO']))	realCharForNumericEntities ($matches)
	Return the real char for a numeric entities. More...

	testSqlAndScriptInject ($val, $type)
	Security: WAF layer for SQL Injection and XSS Injection (scripts) protection (Filters on GET, POST, PHP_SELF). More...

	analyseVarsForSqlAndScriptsInjection (&$var, $type)
	Return true if security check on parameters are OK, false otherwise. More...

if(!defined('NOREQUIREMENU')) if(!function_exists("llxHeader"))	top_httphead ($contenttype='text/html', $forcenocache=0)
	Show HTTP header. More...

	top_htmlhead ($head, $title='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $disableforlogin=0, $disablenofollow=0, $disablenoindex=0)
	Ouput html header of a page. More...

	top_menu ($head, $title='', $target='', $disablejs=0, $disablehead=0, $arrayofjs='', $arrayofcss='', $morequerystring='', $helppagename='')
	Show an HTML header + a BODY + The top menu bar. More...

	top_menu_user ($hideloginname=0, $urllogout='')
	Build the tooltip on user login. More...

	top_menu_quickadd ()
	Build the tooltip on top menu quick add. More...

	printDropdownQuickadd ()
	Generate list of quickadd items. More...

	top_menu_bookmark ()
	Build the tooltip on top menu bookmark. More...

	top_menu_search ()
	Build the tooltip on top menu tsearch. More...

	left_menu ($menu_array_before, $helppagename='', $notused='', $menu_array_after='', $leftmenuwithoutmainarea=0, $title='', $acceptdelayedhtml=0)
	Show left menu bar. More...

	main_area ($title='')
	Begin main area. More...

	getHelpParamFor ($helppagename, $langs)
	Return helpbaseurl, helppage and mode. More...

	printSearchForm ($urlaction, $urlobject, $title, $htmlmorecss, $htmlinputname, $accesskey='', $prefhtmlinputname='', $img='', $showtitlebefore=0, $autofocus=0)
	Show a search area. More...

Detailed Description

File that defines environment for Dolibarr GUI pages only (file not required by scripts)

Definition in file main.inc.php.

Function Documentation

◆ analyseVarsForSqlAndScriptsInjection()

analyseVarsForSqlAndScriptsInjection	(	&	$var,
			$type
	)

Return true if security check on parameters are OK, false otherwise.

Parameters

string \| array	$var	Variable name
string	$type	1=GET, 0=POST, 2=PHP_SELF

Returns: boolean|null true if there is no injection. Stop code if injection found.

Show HTML header HTML + BODY + Top menu + left menu + DIV

Parameters

string	$head	Optionnal head lines
string	$title	HTML title
string	$help_url	Url links to help page Syntax is: For a wiki page: EN:EnglishPage\|FR:FrenchPage\|ES:SpanishPage For other external page: http://server/url
string	$target	Target to use on links
int	$disablejs	More content into html header
int	$disablehead	More content into html header
array \| string	$arrayofjs	Array of complementary js files
array \| string	$arrayofcss	Array of complementary css files
string	$morequerystring	Query string to add to the link "print" to get same parameters (use only if autodetect fails)
string	$morecssonbody	More CSS on body tag. For example 'classforhorizontalscrolloftabs'.
string	$replacemainareaby	Replace call to main_area() by a print of this string
int	$disablenofollow	Disable the "nofollow" on meta robot header
int	$disablenoindex	Disable the "noindex" on meta robot header

Returns: void

Definition at line 210 of file main.inc.php.

◆ getHelpParamFor()

getHelpParamFor	(	$helppagename,
		$langs
	)

Return helpbaseurl, helppage and mode.

Parameters

string	$helppagename	Page name ('EN:xxx,ES:eee,FR:fff...' or 'http://localpage')
Translate	$langs	Language

Returns: array Array of help urls

Definition at line 3142 of file main.inc.php.

◆ left_menu()

left_menu	(	$menu_array_before,
		$helppagename = `''`,
		$notused = `''`,
		$menu_array_after = `''`,
		$leftmenuwithoutmainarea = `0`,
		$title = `''`,
		$acceptdelayedhtml = `0`
	)

Show left menu bar.

Parameters

array	$menu_array_before	Table of menu entries to show before entries of menu handler. This param is deprectaed 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 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	$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
string	$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)

Returns: void

Definition at line 2859 of file main.inc.php.

◆ main_area()

main_area ( $title = '' )

Begin main area.

Parameters

string $title Title

Returns: void

Definition at line 3080 of file main.inc.php.

◆ printDropdownQuickadd()

printDropdownQuickadd ( )

Generate list of quickadd items.

Returns: string HTML output

Definition at line 2458 of file main.inc.php.

◆ printSearchForm()

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.

Parameters

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
string	$showtitlebefore	Show title before input text instead of into placeholder. This can be set when output is dedicated for text browsers.
string	$autofocus	Set autofocus on field

Returns: string

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.

Parameters

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 diplaying them

Returns: void

Definition at line 3196 of file main.inc.php.

◆ realCharForNumericEntities()

if (!empty( $_SERVER[ 'MAIN_SHOW_TUNING_INFO'])) realCharForNumericEntities ( $matches )

Return the real char for a numeric entities.

WARNING: This function is required by testSqlAndScriptInject() and the GETPOST 'restricthtml'. Regex calling must be similar.

Parameters

string $matches String of numeric entity

Returns: string New value

Definition at line 61 of file main.inc.php.

◆ testSqlAndScriptInject()

testSqlAndScriptInject	(	$val,
		$type
	)

Security: WAF layer for SQL Injection and XSS Injection (scripts) protection (Filters on GET, POST, PHP_SELF).

Warning: Such a protection can't be enough. It is not reliable as it will always be possible to bypass this. Good protection can only be guaranted by escaping data during output.

Parameters

string	$val	Brute value found into $_GET, $_POST or PHP_SELF
string	$type	0=POST, 1=GET, 2=PHP_SELF, 3=GET without sql reserved keywords (the less tolerant test)

Returns: int >0 if there is an injection, 0 if none

Definition at line 87 of file main.inc.php.

◆ top_htmlhead()

top_htmlhead	(	$head,
		$title = `''`,
		$disablejs = `0`,
		$disablehead = `0`,
		$arrayofjs = `''`,
		$arrayofcss = `''`,
		$disableforlogin = `0`,
		$disablenofollow = `0`,
		$disablenoindex = `0`
	)

Ouput html header of a page.

It calls also top_httphead() This code is also duplicated into security2.lib.php::dol_loginfunction

Parameters

string	$head	Optionnal head lines
string	$title	HTML title
int	$disablejs	Disable js output
int	$disablehead	Disable head output
array	$arrayofjs	Array of complementary js files
array	$arrayofcss	Array of complementary css files
int	$disableforlogin	Do not load heavy js and css for login pages
int	$disablenofollow	Disable nofollow tag for meta robots
int	$disablenoindex	Disable noindex tag for meta robots

Returns: void

Definition at line 1530 of file main.inc.php.

◆ top_httphead()

if (!defined( 'NOREQUIREMENU')) if (!function_exists("llxHeader")) top_httphead	(	$contenttype = `'text/html'`,
		$forcenocache = `0`
	)

Show HTTP header.

Called by top_htmlhead().

Parameters

string	$contenttype	Content type. For example, 'text/html'
int	$forcenocache	Force disabling of cache for the page

Returns: void

Definition at line 1436 of file main.inc.php.

◆ top_menu()

top_menu	(	$head,
		$title = `''`,
		$target = `''`,
		$disablejs = `0`,
		$disablehead = `0`,
		$arrayofjs = `''`,
		$arrayofcss = `''`,
		$morequerystring = `''`,
		$helppagename = `''`
	)

Show an HTML header + a BODY + The top menu bar.

Parameters

string	$head	Lines in the HEAD
string	$title	Title of web page
string	$target	Target to use in menu links (Example: '' or '_top')
int	$disablejs	Do not output links to js (Ex: qd fonction utilisee par sous formulaire Ajax)
int	$disablehead	Do not output head section
array	$arrayofjs	Array of js files to add in header
array	$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 For other external page: http://server/url

Returns: void

Definition at line 1932 of file main.inc.php.

◆ top_menu_bookmark()

top_menu_bookmark ( )

Build the tooltip on top menu bookmark.

Returns: string HTML content

Definition at line 2637 of file main.inc.php.

◆ top_menu_quickadd()

top_menu_quickadd ( )

Build the tooltip on top menu quick add.

Returns: string HTML content

Definition at line 2409 of file main.inc.php.

◆ top_menu_search()

top_menu_search ( )

Build the tooltip on top menu tsearch.

Returns: string HTML content

Definition at line 2710 of file main.inc.php.

◆ top_menu_user()

top_menu_user	(	$hideloginname = `0`,
		$urllogout = `''`
	)

Build the tooltip on user login.

Parameters

int	$hideloginname	Hide login name. Show only the image.
string	$urllogout	URL for logout (Will use DOL_URL_ROOT.'/user/logout.php?token=...' if empty)

Returns: string HTML content

Definition at line 2167 of file main.inc.php.

Functions

Detailed Description

Function Documentation

◆ analyseVarsForSqlAndScriptsInjection()

◆ getHelpParamFor()

◆ left_menu()

◆ main_area()

◆ printDropdownQuickadd()

◆ printSearchForm()

◆ realCharForNumericEntities()

◆ testSqlAndScriptInject()

◆ top_htmlhead()

◆ top_httphead()

◆ top_menu()

◆ top_menu_bookmark()

◆ top_menu_quickadd()

◆ top_menu_search()

◆ top_menu_user()