Documentation Class Reference

Class to manage UI documentation. More...

Public Member Functions
	__construct (DoliDB $db)
	Constructor.
	docHeader ($title='', $arrayofjs=[], $arrayofcss=[])
	Output header + body.
	docFooter ()
	Output close body + html.
	showSidebar ()
	Output sidebar.
	showBreadcrumb ()
	Output breadcrumb.
	showSummary ($showsubmenu=1, $showsubmenu_summary=1)
	Output summary.
	displaySummary ($menu, $level=0, $showsubmenu=1, $showsubmenu_summary=1)
	Recursive function for Automatic Summary.
	showCode ($lines=array())
	Output a View Code area.

Private Member Functions
	setMenu ()
	Set Documentation Menu.
	displayMenu ($menu, $level=0)
	Recursive function to set Menu.

Detailed Description

Class to manage UI documentation.

Definition at line 27 of file documentation.class.php.

Constructor & Destructor Documentation

__construct()

Documentation::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 61 of file documentation.class.php.

References setMenu().

Member Function Documentation

displayMenu()

Documentation::displayMenu ( $menu, $level = 0 )

private

Recursive function to set Menu.

Parameters

array	$menu	$this->menu or submenus
int	$level	level of menu

Returns

void

Definition at line 258 of file documentation.class.php.

References displayMenu().

Referenced by displayMenu(), and showSidebar().

displaySummary()

Documentation::displaySummary	(		$menu,
			$level = 0,
			$showsubmenu = 1,
			$showsubmenu_summary = 1 )

Recursive function for Automatic Summary.

Parameters

array	$menu	$this->menu or submenus
int	$level	level of menu
int	$showsubmenu	Show Sub menus: 0 = No, 1 = Yes
int	$showsubmenu_summary	Show summary of sub menus: 0 = No, 1 = Yes

Returns

void

Definition at line 352 of file documentation.class.php.

References displaySummary().

Referenced by displaySummary(), and showSummary().

docFooter()

Documentation::docFooter

(

)

Output close body + html.

Returns

void

Definition at line 206 of file documentation.class.php.

References dol_htmloutput_events().

docHeader()

Documentation::docHeader	(		$title = '',
			$arrayofjs = [],
			$arrayofcss = [] )

Output header + body.

Parameters

string	$title	Title of page
string[]	$arrayofjs	Array of complementary js files
string[]	$arrayofcss	Array of complementary css files

Returns

void

Definition at line 190 of file documentation.class.php.

References dol_escape_htmltag(), and top_htmlhead().

setMenu()

Documentation::setMenu ( )

private

Set Documentation Menu.

Returns

mixed false if error, void if no errors

Definition at line 76 of file documentation.class.php.

References dol_buildpath().

Referenced by __construct().

showBreadcrumb()

Documentation::showBreadcrumb

(

)

Output breadcrumb.

Returns

void

Definition at line 286 of file documentation.class.php.

showCode()

Documentation::showCode

(

$lines = array()

)

Output a View Code area.

Parameters

array

$lines

Lines of code to show

Returns

void

Definition at line 389 of file documentation.class.php.

References dol_htmlentities().

showSidebar()

Documentation::showSidebar

(

)

Output sidebar.

Returns

void

Definition at line 229 of file documentation.class.php.

References displayMenu().

showSummary()

Documentation::showSummary	(		$showsubmenu = 1,
			$showsubmenu_summary = 1 )

Output summary.

Parameters

int	$showsubmenu	Show Sub menus: 0 = No, 1 = Yes
int	$showsubmenu_summary	Show summary of sub menus: 0 = No, 1 = Yes

Returns

void

Definition at line 320 of file documentation.class.php.

References displaySummary().

---

The documentation for this class was generated from the following file:

• dolibarr_dev/htdocs/admin/tools/ui/class/documentation.class.php