KMP PHP API Reference

OfficersNavigationProvider
in package

Navigation provider for the Officers plugin.

Generates navigation menu items for officer management, department/office configuration, reporting, and roster operations when the plugin is enabled.

Tags
see

/docs/5.1-officers-plugin.md for plugin documentation

Table of Contents

Methods

getNavigationItems()  : array<string|int, mixed>
Builds navigation items for the Officers plugin.

Methods

getNavigationItems()

Builds navigation items for the Officers plugin.

public static getNavigationItems(Member $user[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Generates the structured navigation definitions for officer management, configuration, reporting, and roster actions. Items are produced only when the Officers plugin is enabled.

Parameters
$user : Member

The current authenticated user (context for visibility/permissions).

$params : array<string|int, mixed> = []

Optional request or context parameters to customize generation.

Return values
array<string|int, mixed>

An array of navigation item definitions. Each item includes keys such as type, mergePath, label, order, url (plugin/controller/action/model), icon, and optionally activePaths.


        
On this page

Search results