NodeDatabaseChild
abstract class NodeDatabaseChild extends Node (View source)
Represents a node that is a child of a database node This may either be a concrete child such as table or a container such as table container
Properties
| string | $realName | from Node | |
| bool | $visible | from Node | |
| Node|null | $parent | from Node | |
| Node[] | $children | from Node | |
| string[] | $separators | from Node | |
| int | $separatorDepth | from Node | |
| array<string,string> | $icon | For the IMG tag, used when rendering the node. |
from Node |
| array<string,mixed> | $links | An array of A tags, used when rendering the node. |
from Node |
| string | $title | from Node | |
| string | $classes | from Node | |
| bool | $isNew | from Node | |
| int | $pos2 | from Node | |
| int | $pos3 | from Node | |
| string|null | $urlParamName | from Node |
Methods
Initialises the class by setting the mandatory variables
Instantiates a Node object that will be used only for "New db/table/etc.." objects
Returns a child node given it's name
Retrieves the parents for a node
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.
This function checks if the node has children nodes associated with it
Returns true if the node has some siblings (other nodes on the same tree level, in the same branch), false otherwise.
Returns the actual path and the virtual paths for a node both as clean arrays and base64 encoded strings
Returns the names of children of type $type present inside this container This method is overridden by the PhpMyAdmin\Navigation\Nodes\NodeDatabase and PhpMyAdmin\Navigation\Nodes\NodeTable classes
Returns the number of children of type $type present inside this container This method is overridden by the PhpMyAdmin\Navigation\Nodes\NodeDatabase and PhpMyAdmin\Navigation\Nodes\NodeTable classes
Returns HTML for control buttons displayed infront of a node
Gets the count of hidden elements for each database
Returns the type of the item represented by the node.
Details
in
Node at line 121
__construct(Config $config, string $name = '', NodeType $type = NodeType::Object, bool $isGroup = false)
Initialises the class by setting the mandatory variables
in
Node at line 136
Node
getInstanceForNewNode(string $name, string $classes)
Instantiates a Node object that will be used only for "New db/table/etc.." objects
in
Node at line 153
void
addChild(Node $child)
Adds a child node to this node
in
Node at line 169
Node|null
getChild(string $name, bool $realName = false)
Returns a child node given it's name
in
Node at line 189
void
removeChild(string $name)
Removes a child node from this node
in
Node at line 208
array
parents(bool $self = false, bool $containers = false, bool $groups = false)
Retrieves the parents for a node
in
Node at line 229
Node|false
getRealParent()
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.
..
in
Node at line 250
bool
hasChildren(bool $countEmptyContainers = true)
This function checks if the node has children nodes associated with it
in
Node at line 273
bool
hasSiblings()
Returns true if the node has some siblings (other nodes on the same tree level, in the same branch), false otherwise.
The only exception is for nodes on the third level of the tree (columns and indexes), for which the function always returns true. This is because we want to render the containers for these nodes
in
Node at line 299
array
getPaths()
Returns the actual path and the virtual paths for a node both as clean arrays and base64 encoded strings
in
Node at line 336
array
getData(UserPrivileges $userPrivileges, RelationParameters $relationParameters, string $type, int $pos, string $searchClause = '')
Returns the names of children of type $type present inside this container This method is overridden by the PhpMyAdmin\Navigation\Nodes\NodeDatabase and PhpMyAdmin\Navigation\Nodes\NodeTable classes
in
Node at line 363
int
getPresence(UserPrivileges $userPrivileges, string $type = '', string $searchClause = '')
Returns the number of children of type $type present inside this container This method is overridden by the PhpMyAdmin\Navigation\Nodes\NodeDatabase and PhpMyAdmin\Navigation\Nodes\NodeTable classes
string
getHtmlForControlButtons(NavigationItemsHidingFeature|null $navigationItemsHidingFeature)
Returns HTML for control buttons displayed infront of a node
in
Node at line 545
string
getCssClasses(bool $match)
Returns CSS classes for a node
in
Node at line 571
string
getIcon(bool $match)
Returns icon for the node
in
Node at line 591
array|null
getNavigationHidingData(NavigationItemsHidingFeature|null $navigationItemsHidingFeature)
Gets the count of hidden elements for each database
abstract protected string
getItemType()
Returns the type of the item represented by the node.