• Accueil
• PMA
• libraries
• navigation
• nodes
• Node

PHP Class PMA\libraries\navigation\nodes\Node

Afficher le fichier Open project: phpmyadmin/phpmyadmin Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$children		An array of Node objects that are direct children of this node
$classes		Extra CSS classes for the node
$icon		An IMG tag, used when rendering the node
$isNew		Whether this node is a link for creating new objects
$is_group		Whether this object has been created while grouping nodes Only relevant if the node is of type CONTAINER
$links		An array of A tags, used when rendering the node The indexes in the array may be 'icon' and 'text'
$name		A non-unique identifier for the node This may be trimmed when grouping nodes
$parent		A reference to the parent object of this node, NULL for the root node.
$pos2		The position for the pagination of the branch at the second level of the tree
$pos3		The position for the pagination of the branch at the third level of the tree
$real_name		A non-unique identifier for the node This will never change after being assigned
$separator		A string used to group nodes, or an array of strings Only relevant if the node is of type CONTAINER
$separator_depth		How many time to recursively apply the grouping function Only relevant if the node is of type CONTAINER
$title		HTML title
$type		May be one of CONTAINER or OBJECT
$visible		Whether to add a "display: none;" CSS rule to the node when rendering it

Méthodes publiques

Méthode	Description
__construct ( string $name, integer $type = Node::OBJECT, boolean $is_group = false )	Initialises the class by setting the mandatory variables
addChild ( Node $child ) : void	Adds a child node to this node
getChild ( string $name, boolean $real_name = false ) : false | Node	Returns a child node given it's name
getCssClasses ( boolean $match ) : String	Returns CSS classes for a node
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
getHtmlForControlButtons ( ) : String	Returns HTML for control buttons displayed infront of a node
getIcon ( boolean $match ) : String	Returns icon for the node
getNavigationHidingData ( ) : array	Gets the count of hidden elements for each database
getPaths ( ) : array	Returns the actual path and the virtual paths for a node both as clean arrays and base64 encoded strings
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
hasChildren ( boolean $count_empty_containers = true ) : boolean	This function checks if the node has children nodes associated with it
hasSiblings ( ) : boolean	Returns true if the node has some siblings (other nodes on the same tree level, in the same branch), false otherwise.
numChildren ( ) : integer	Returns the number of child nodes that a node has associated with it
parents ( boolean $self = false, boolean $containers = false, boolean $groups = false ) : array	Retrieves the parents for a node
realParent ( ) : Node | false	Returns the actual parent of a node. If used twice on an index or columns node, it will return the table and database nodes. The names of the returned nodes can be used in SQL queries, etc.
removeChild ( string $name ) : void	Removes a child node from this node

Private Methods

Méthode	Description
_getDatabasesToSearch ( string $searchClause ) : array	Get the list of databases for 'SHOW DATABASES LIKE' queries.
_getWhereClause ( string $columnName, string $searchClause = '' ) : string	Returns the WHERE clause depending on the $searchClause parameter and the hide_db directive
_isHideDb ( string $db ) : boolean	Detemines whether a given database should be hidden according to 'hide_db'

Method Details

Property Details