KMP PHP API Reference

OfficersPlugin extends BasePlugin
in package
implements KMPPluginInterface, KMPApiPluginInterface

Officers Plugin - Officer assignment management and hierarchical organization

Provides complete officer lifecycle management including hierarchical organization, warrant integration, temporal assignments, and service-oriented architecture.

Tags
see

/docs/5.1-officers-plugin.md

Table of Contents

Interfaces

KMPPluginInterface
Plugin architecture contract for KMP plugins.
KMPApiPluginInterface
Contract for plugins that publish API routes.

Properties

$_migrationOrder  : int

Methods

__construct()  : mixed
bootstrap()  : void
Bootstrap plugin: register navigation, view cells, and manage configuration versioning.
console()  : CommandCollection
getMigrationOrder()  : int
Get migration order for plugin initialization.
middleware()  : MiddlewareQueue
registerApiRoutes()  : void
Register API endpoints for the Officers plugin.
routes()  : void
Configure plugin routes under /officers path.
services()  : void
Register OfficerManagerInterface service with DI container.

Properties

$_migrationOrder

protected int $_migrationOrder = 0

Plugin migration order

Methods

__construct()

public __construct([array<string|int, mixed> $config = [] ]) : mixed
Parameters
$config : array<string|int, mixed> = []

Plugin configuration including migrationOrder

bootstrap()

Bootstrap plugin: register navigation, view cells, and manage configuration versioning.

public bootstrap(PluginApplicationInterface $app) : void
Parameters
$app : PluginApplicationInterface

The host application

console()

public console(CommandCollection $commands) : CommandCollection
Parameters
$commands : CommandCollection

The command collection

Return values
CommandCollection

getMigrationOrder()

Get migration order for plugin initialization.

public getMigrationOrder() : int
Return values
int

Migration order (0 = run first)

middleware()

public middleware(MiddlewareQueue $middlewareQueue) : MiddlewareQueue
Parameters
$middlewareQueue : MiddlewareQueue

The middleware queue

Return values
MiddlewareQueue

registerApiRoutes()

Register API endpoints for the Officers plugin.

public registerApiRoutes(RouteBuilder $builder) : void
Parameters
$builder : RouteBuilder

API scope route builder

routes()

Configure plugin routes under /officers path.

public routes(RouteBuilder $routes) : void
Parameters
$routes : RouteBuilder

The route builder

services()

Register OfficerManagerInterface service with DI container.

public services(ContainerInterface $container) : void
Parameters
$container : ContainerInterface

The Container


        
On this page

Search results