1. class
  2. PhpMyAdmin
  3. \
  4. Navigation
  5. \
  6. Nodes
  7. \
  8. NodeTriggerContainer

NodeTriggerContainer

class NodeTriggerContainer extends Node (View source)

Represents a container for trigger nodes in the navigation tree

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
$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

__construct(Config $config)

Initialises the class by setting the mandatory variables

Node
getInstanceForNewNode(string $name, string $classes)

Instantiates a Node object that will be used only for "New db/table/etc.." objects

from  Node
void
addChild(Node $child)

Adds a child node to this node

from  Node
Node|null
getChild(string $name, bool $realName = false)

Returns a child node given it's name

from  Node
void
removeChild(string $name)

Removes a child node from this node

from  Node
array
parents(bool $self = false, bool $containers = false, bool $groups = false)

Retrieves the parents for a node

from  Node
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.

from  Node
bool
hasChildren(bool $countEmptyContainers = true)

This function checks if the node has children nodes associated with it

from  Node
bool
hasSiblings()

Returns true if the node has some siblings (other nodes on the same tree level, in the same branch), false otherwise.

from  Node
array
getPaths()

Returns the actual path and the virtual paths for a node both as clean arrays and base64 encoded strings

from  Node
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

from  Node
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

from  Node
string
getHtmlForControlButtons(NavigationItemsHidingFeature|null $navigationItemsHidingFeature)

Returns HTML for control buttons displayed infront of a node

from  Node
string
getCssClasses(bool $match)

Returns CSS classes for a node

from  Node
string
getIcon(bool $match)

Returns icon for the node

from  Node
array|null
getNavigationHidingData(NavigationItemsHidingFeature|null $navigationItemsHidingFeature)

Gets the count of hidden elements for each database

from  Node

Details

at line 21
__construct(Config $config)

Initialises the class by setting the mandatory variables

Parameters

Config $config

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

Parameters

string $name

An identifier for the new node
string $classes

Extra CSS classes for the node

Return Value

Node

in Node at line 153
void addChild(Node $child)

Adds a child node to this node

Parameters

Node $child

A child node

Return Value

void

in Node at line 169
Node|null getChild(string $name, bool $realName = false)

Returns a child node given it's name

Parameters

string $name

The name of requested child
bool $realName

Whether to use the "realName" instead of "name" in comparisons

Return Value

Node|null

The requested child node or null, if the requested node cannot be found

in Node at line 189
void removeChild(string $name)

Removes a child node from this node

Parameters

string $name

The name of child to be removed

Return Value

void

in Node at line 208
array parents(bool $self = false, bool $containers = false, bool $groups = false)

Retrieves the parents for a node

Parameters

bool $self

Whether to include the Node itself in the results
bool $containers

Whether to include nodes of type CONTAINER
bool $groups

Whether to include nodes which have $group == true

Return Value

array

An array of parent Nodes

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.

..

Return Value

Node|false

in Node at line 250
bool hasChildren(bool $countEmptyContainers = true)

This function checks if the node has children nodes associated with it

Parameters

bool $countEmptyContainers

Whether to count empty child containers as valid children

Return Value

bool

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

Return Value

bool

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

Return Value

array

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

Parameters

UserPrivileges $userPrivileges
RelationParameters $relationParameters
string $type

The type of item we are looking for ('tables', 'views', etc)
int $pos

The offset of the list within the results
string $searchClause

A string used to filter the results of the query

Return Value

array

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

Parameters

UserPrivileges $userPrivileges
string $type

The type of item we are looking for ('tables', 'views', etc)
string $searchClause

A string used to filter the results of the query

Return Value

int

in Node at line 533
string getHtmlForControlButtons(NavigationItemsHidingFeature|null $navigationItemsHidingFeature)

Returns HTML for control buttons displayed infront of a node

Parameters

NavigationItemsHidingFeature|null $navigationItemsHidingFeature

Return Value

string

HTML for control buttons

in Node at line 545
string getCssClasses(bool $match)

Returns CSS classes for a node

Parameters

bool $match

Whether the node matched loaded tree

Return Value

string

with html classes.

in Node at line 571
string getIcon(bool $match)

Returns icon for the node

Parameters

bool $match

Whether the node matched loaded tree

Return Value

string

with image name

in Node at line 591
array|null getNavigationHidingData(NavigationItemsHidingFeature|null $navigationItemsHidingFeature)

Gets the count of hidden elements for each database

Parameters

NavigationItemsHidingFeature|null $navigationItemsHidingFeature

Return Value

array|null

array containing the count of hidden elements for each database