KMP PHP API Reference

AwardsNavigationProvider
in package

Provides navigation integration for the Awards plugin.

Generates navigation items for award recommendation workflows, administrative tools, configuration management, and reporting. Creates dynamic status-based navigation items for each recommendation workflow state.

Tags
see
StaticHelpers

Plugin availability checking

see
Recommendation

Recommendation status definitions

see

/docs/5.2.17-awards-services.md Full documentation

Table of Contents

Methods

getNavigationItems()  : array<string|int, mixed>
Builds the Awards plugin navigation tree with static sections and per-status recommendation links.

Methods

getNavigationItems()

Builds the Awards plugin navigation tree with static sections and per-status recommendation links.

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

The returned structure contains a parent header and core navigation items (Recommendations, Award Domains, Award Levels, Awards, Submit Award Rec.) plus additional links generated for each recommendation status that filter the Recommendations list. Items include mergePath, icon, order, URL, and active path metadata for UI integration.

Parameters
$user : Member

The current authenticated user used for authorization/context.

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

Optional request parameters that may influence active path or contextual navigation.

Return values
array<string|int, mixed>

An array of navigation item arrays organized hierarchically, including static items and status-filtered recommendation links.


        
On this page

Search results