class Navigation

Methods

clearDynTreeCache(Controller|null $instanceController = null, int $userID = null)

Clears cached dyntree entries

string
getDynTreeCacheKey(Controller|null $instanceController = null, int|null $userID = null)

Get Cache Key Prefix for Dyntree

array|false
getFullNavArray()

Returns the navigation array including hidden values

mixed
getNavNode($id)

Get information about nav node, if visible to user

int
get_current_nav_id(mixed $guess_if_unknown = false)

proxy function

array|false
get_nav_array(bool $force = false, bool $load_dyntree = true, bool $includeHidden = false)

No description

array|false
get_nav_tree(int $node, int $level = 1)

No description

array|false
get_navid_path(int $origin_nav_id = false)

No description

array
get_navigation_details(int $nav_id)

put your comment there.

int
guess_navid(string $instance_id, string $page_id, string|array $args, $load_dyntree = false)

Tries to get the navigation ID for the given instance, page and cmd args

rebuild_navigation_tree(bool $event = false, string $table_name = "system_navigation_0")

rebuilds the navigation-tree and updates the left- and right- boundaries (see also: NestedSet SQL)

set_current_guess_context($instance, $page, $cmd)

Sets the current Guess Context Will be used to determine the current navid where requested

set_current_nav_id(int $nav_id = false)

Sets the current Navigation ID Will be internally used as default if no further parameters are specified. The ID is being set during the XF->view init

Details

at line 894
clearDynTreeCache(Controller|null $instanceController = null, int $userID = null)

Clears cached dyntree entries

Parameters

Controller|null $instanceController
int $userID

at line 910
string getDynTreeCacheKey(Controller|null $instanceController = null, int|null $userID = null)

Get Cache Key Prefix for Dyntree

Parameters

Controller|null $instanceController
int|null $userID

Return Value

string

at line 471
array|false getFullNavArray()

Returns the navigation array including hidden values

Return Value

array|false

at line 150
mixed getNavNode($id)

Get information about nav node, if visible to user

Parameters

$id

Return Value

mixed

at line 931
int get_current_nav_id(mixed $guess_if_unknown = false)

proxy function

Parameters

mixed $guess_if_unknown

Return Value

int

the current Nav_ID

at line 166
array|false get_nav_array(bool $force = false, bool $load_dyntree = true, bool $includeHidden = false)

No description

Parameters

bool $force

if true, the cached nav_tree is reloaded

bool $load_dyntree

If true, all dyntrees are being loaded

bool $includeHidden

If true, we will get all hidden elements as well (with hidden=1)

Return Value

array|false

Returns the nav tree or false if no navigation entries are accessible or available

at line 107
array|false get_nav_tree(int $node, int $level = 1)

No description

Parameters

int $node

ID of the parent node

int $level

Number of levels below parent node which should be returned

Return Value

array|false

Recursive array, false is return if level is 0 or less

at line 483
array|false get_navid_path(int $origin_nav_id = false)

No description

Parameters

int $origin_nav_id

Nav ID for which to retrieve the navid path. If not specified, the current nav id will be used

Return Value

array|false

at line 945
array get_navigation_details(int $nav_id)

put your comment there.

..

Parameters

int $nav_id

Return Value

array

at line 541
int guess_navid(string $instance_id, string $page_id, string|array $args, $load_dyntree = false)

Tries to get the navigation ID for the given instance, page and cmd args

Parameters

string $instance_id
string $page_id
string|array $args
$load_dyntree

Return Value

int

at line 966
rebuild_navigation_tree(bool $event = false, string $table_name = "system_navigation_0")

rebuilds the navigation-tree and updates the left- and right- boundaries (see also: NestedSet SQL)

Parameters

bool $event

unused

string $table_name

table name of the navigation

at line 97
set_current_guess_context($instance, $page, $cmd)

Sets the current Guess Context Will be used to determine the current navid where requested

Parameters

$instance
$page
$cmd

at line 79
set_current_nav_id(int $nav_id = false)

Sets the current Navigation ID Will be internally used as default if no further parameters are specified. The ID is being set during the XF->view init

Parameters

int $nav_id