PHP Class PMA\libraries\navigation\Navigation

Show file Open project: phpmyadmin/phpmyadmin Class Usage Examples

Public Methods

Method Description
getDisplay ( ) : string Renders the navigation tree, or part of it
getItemUnhideDialog ( string $dbName, string $itemType = null, string $tableName = null ) : string Returns HTML for the dialog to show hidden navigation items.
hideNavigationItem ( string $itemName, string $itemType, string $dbName, string $tableName = null ) : void Add an item of navigation tree to the hidden items list in PMA database.
unhideNavigationItem ( string $itemName, string $itemType, string $dbName, string $tableName = null ) : void Remove a hidden item of navigation tree from the list of hidden items in PMA database.

Private Methods

Method Description
_getDropHandler ( ) : string Inserts Drag and Drop Import handler

Method Details

getDisplay() public method

Renders the navigation tree, or part of it
public getDisplay ( ) : string
return string The navigation tree

getItemUnhideDialog() public method

Returns HTML for the dialog to show hidden navigation items.
public getItemUnhideDialog ( string $dbName, string $itemType = null, string $tableName = null ) : string
$dbName string database name
$itemType string type of the items to include
$tableName string table name
return string HTML for the dialog to show hidden navigation items

hideNavigationItem() public method

Add an item of navigation tree to the hidden items list in PMA database.
public hideNavigationItem ( string $itemName, string $itemType, string $dbName, string $tableName = null ) : void
$itemName string name of the navigation tree item
$itemType string type of the navigation tree item
$dbName string database name
$tableName string table name if applicable
return void

unhideNavigationItem() public method

Remove a hidden item of navigation tree from the list of hidden items in PMA database.
public unhideNavigationItem ( string $itemName, string $itemType, string $dbName, string $tableName = null ) : void
$itemName string name of the navigation tree item
$itemType string type of the navigation tree item
$dbName string database name
$tableName string table name if applicable
return void