class MySQLDocumentation (View source)

Generate HTML for MySQL Documentation

Methods

static string
show(string $link, bool $bigIcon = false, string|null $url = null, string|null $text = null, string $anchor = '')

Displays a link to the official MySQL documentation

static string
showDocumentation(string $page, string $anchor = '', bool $bbcode = false)

Displays a link to the phpMyAdmin documentation

static string
getDocumentationLink(string $page, string $anchor = '', string $pathPrefix = './')

Returns link to documentation.

Details

static string show(string $link, bool $bigIcon = false, string|null $url = null, string|null $text = null, string $anchor = '')

Displays a link to the official MySQL documentation

Parameters

string $link

contains name of page/anchor that is being linked

bool $bigIcon

whether to use big icon (like in left frame)

string|null $url

href attribute

string|null $text

text of link

string $anchor

anchor to page part

Return Value

string

the html link

static string showDocumentation(string $page, string $anchor = '', bool $bbcode = false)

Displays a link to the phpMyAdmin documentation

Parameters

string $page

Page in documentation

string $anchor

Optional anchor in page

bool $bbcode

Optional flag indicating whether to output bbcode

Return Value

string

the html link

Returns link to documentation.

Parameters

string $page

Page in documentation

string $anchor

Optional anchor in page

string $pathPrefix

Optional path in case it is called in a folder (e.g. setup)

Return Value

string URL