PHP Class PMA\libraries\navigation\nodes\NodeTable

Inheritance: extends NodeDatabaseChild
Show file Open project: phpmyadmin/phpmyadmin Class Usage Examples

Public Methods

Method Description
__construct ( string $name, integer $type = Node::OBJECT, boolean $is_group = false ) Initialises the class
getData ( string $type, integer $pos, string $searchClause = '' ) : array Returns the names of children of type $type present inside this container This method is overridden by the PMA\libraries\navigation\nodes\NodeDatabase and PMA\libraries\navigation\nodes\NodeTable classes
getPresence ( string $type = '', string $searchClause = '' ) : integer Returns the number of children of type $type present inside this container This method is overridden by the PMA\libraries\navigation\nodes\NodeDatabase and PMA\libraries\navigation\nodes\NodeTable classes

Protected Methods

Method Description
getItemType ( ) : string Returns the type of the item represented by the node.

Private Methods

Method Description
_addIcon ( string $page ) : void Add an icon to navigation tree

Method Details

__construct() public method

Initialises the class
public __construct ( string $name, integer $type = Node::OBJECT, boolean $is_group = false )
$name string An identifier for the new node
$type integer Type of node, may be one of CONTAINER or OBJECT
$is_group boolean Whether this object has been created while grouping nodes

getData() public method

Returns the names of children of type $type present inside this container This method is overridden by the PMA\libraries\navigation\nodes\NodeDatabase and PMA\libraries\navigation\nodes\NodeTable classes
public getData ( string $type, integer $pos, string $searchClause = '' ) : array
$type string The type of item we are looking for ('tables', 'views', etc)
$pos integer The offset of the list within the results
$searchClause string A string used to filter the results of the query
return array

getItemType() protected method

Returns the type of the item represented by the node.
protected getItemType ( ) : string
return string type of the item

getPresence() public method

Returns the number of children of type $type present inside this container This method is overridden by the PMA\libraries\navigation\nodes\NodeDatabase and PMA\libraries\navigation\nodes\NodeTable classes
public getPresence ( string $type = '', string $searchClause = '' ) : integer
$type string The type of item we are looking for ('columns' or 'indexes')
$searchClause string A string used to filter the results of the query
return integer