class NavigationTree

Displays a collapsible of database objects in the navigation frame

Methods

__construct(Template $template, DatabaseInterface $dbi)

NavigationTree constructor.

void
groupTree(mixed $node = null)

Recursively groups tree nodes given a separator

void
groupNode(Node $node)

Recursively groups tree nodes given a separator

string
renderState()

Renders a state of the tree, used in light mode when either JavaScript and/or Ajax are disabled

string|false
renderPath()

Renders a part of the tree, used for Ajax requests in light mode

string
renderDbSelect()

Renders a database select box like the pre-4.0 navigation panel

static int
sortNode(Node $a, Node $b)

Called by usort() for sorting the nodes in a container

Details

at line 107
__construct(Template $template, DatabaseInterface $dbi)

NavigationTree constructor.

Parameters

Template $template Template instance
DatabaseInterface $dbi DatabaseInterface instance

at line 684
void groupTree(mixed $node = null)

Recursively groups tree nodes given a separator

Parameters

mixed $node The node to group or null to group the whole tree. If passed as an argument, $node must be of type CONTAINER

Return Value

void

at line 702
void groupNode(Node $node)

Recursively groups tree nodes given a separator

Parameters

Node $node The node to group

Return Value

void

at line 867
string renderState()

Renders a state of the tree, used in light mode when either JavaScript and/or Ajax are disabled

Return Value

string HTML code for the navigation tree

at line 914
string|false renderPath()

Renders a part of the tree, used for Ajax requests in light mode

Return Value

string|false HTML code for the navigation tree

at line 1272
string renderDbSelect()

Renders a database select box like the pre-4.0 navigation panel

Return Value

string HTML code

at line 1544
static int sortNode(Node $a, Node $b)

Called by usort() for sorting the nodes in a container

Parameters

Node $a The first element used in the comparison
Node $b The second element used in the comparison

Return Value

int See strnatcmp() and strcmp()