class Navigation

The navigation panel - displays server, db and table selection tree

Methods

__construct(Template $template, Relation $relation, DatabaseInterface $dbi)

Navigation constructor.

string
getDisplay()

Renders the navigation tree, or part of it

void
hideNavigationItem(string $itemName, string $itemType, string $dbName, string $tableName = null)

Add an item of navigation tree to the hidden items list in PMA database.

void
unhideNavigationItem(string $itemName, string $itemType, string $dbName, string $tableName = null)

Remove a hidden item of navigation tree from the list of hidden items in PMA database.

string
getItemUnhideDialog(string $database, string $itemType = null, string $table = null)

Returns HTML for the dialog to show hidden navigation items.

Details

at line 55
__construct(Template $template, Relation $relation, DatabaseInterface $dbi)

Navigation constructor.

Parameters

Template $template Template instance
Relation $relation Relation instance
DatabaseInterface $dbi DatabaseInterface instance

at line 68
string getDisplay()

Renders the navigation tree, or part of it

Return Value

string The navigation tree

at line 150
void hideNavigationItem(string $itemName, string $itemType, string $dbName, string $tableName = null)

Add an item of navigation tree to the hidden items list in PMA database.

Parameters

string $itemName name of the navigation tree item
string $itemType type of the navigation tree item
string $dbName database name
string $tableName table name if applicable

Return Value

void

at line 181
void unhideNavigationItem(string $itemName, string $itemType, string $dbName, string $tableName = null)

Remove a hidden item of navigation tree from the list of hidden items in PMA database.

Parameters

string $itemName name of the navigation tree item
string $itemType type of the navigation tree item
string $dbName database name
string $tableName table name if applicable

Return Value

void

at line 212
string getItemUnhideDialog(string $database, string $itemType = null, string $table = null)

Returns HTML for the dialog to show hidden navigation items.

Parameters

string $database database name
string $itemType type of the items to include
string $table table name

Return Value

string HTML for the dialog to show hidden navigation items