Documentation

class Documentation (View source)

Class to manage UI documentation

Properties

array $view Views
array $menu

Menu - Set in setMenu in order to use dol_buildpath and called in constructor
array $summary

Summary - Set in setSummary and called in constructor
DoliDB $db
string $baseUrl

Methods

void
__construct(DoliDB $db)

Constructor

void
docHeader(string $title = '', string[] $arrayofjs = [], string[] $arrayofcss = [], string $hidenavmenu = '')

Output header + body

void
docFooter()

Output close body + html

void
showSidebar()

Output sidebar

void
showBreadcrumb()

Output breadcrumb

void
showSummary(int $showsubmenu = 1, int $showsubmenu_summary = 1)

Output summary

void
displaySummary(array $menu, int $level = 0, int $showsubmenu = 1, int $showsubmenu_summary = 1)

Recursive function for Automatic Summary

void
showCode(array $lines = array(), string $option = 'html')

Output a View Code area

Details

at line 67
void __construct(DoliDB $db)

Constructor

Parameters

DoliDB $db

Database handler

Return Value

void

at line 306
void docHeader(string $title = '', string[] $arrayofjs = [], string[] $arrayofcss = [], string $hidenavmenu = '')

Output header + body

Parameters

string $title

Title of page
string[] $arrayofjs

Array of complementary js files
string[] $arrayofcss

Array of complementary css files
string $hidenavmenu

Hide nav menu

Return Value

void

at line 322
void docFooter()

Output close body + html

Return Value

void

at line 346
void showSidebar()

Output sidebar

Return Value

void

at line 404
void showBreadcrumb()

Output breadcrumb

Return Value

void

at line 439
void showSummary(int $showsubmenu = 1, int $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

Return Value

void

at line 472
void displaySummary(array $menu, int $level = 0, int $showsubmenu = 1, int $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

Return Value

void

at line 524
void showCode(array $lines = array(), string $option = 'html')

Output a View Code area

Parameters

array $lines

Lines of code to show
string $option

Source code language ('html', 'php' etc)

Return Value

void