KMP PHP API Reference

AwardsPlugin extends BasePlugin
in package
implements KMPPluginInterface

Awards Plugin - Award recommendation management with state machine workflow.

Tags
see

/docs/5.2-awards-plugin.md For complete documentation

Table of Contents

Interfaces

KMPPluginInterface
Plugin architecture contract for KMP plugins.

Properties

$_migrationOrder  : int

Methods

__construct()  : mixed
bootstrap()  : void
Initialize navigation, view cells, and version-controlled configuration.
console()  : CommandCollection
getMigrationOrder()  : int
Get migration order for plugin initialization.
middleware()  : MiddlewareQueue
routes()  : void
Configure plugin routes with JSON, PDF, and CSV format support.
services()  : void

Properties

$_migrationOrder

protected int $_migrationOrder = 0

Migration order priority for database setup

Methods

__construct()

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

Plugin configuration including migrationOrder

bootstrap()

Initialize navigation, view cells, and version-controlled configuration.

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

The host application

console()

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

The command collection to update

Return values
CommandCollection

Updated command collection

getMigrationOrder()

Get migration order for plugin initialization.

public getMigrationOrder() : int
Return values
int

Migration order priority

middleware()

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

The middleware queue to update

Return values
MiddlewareQueue

Updated middleware queue

routes()

Configure plugin routes with JSON, PDF, and CSV format support.

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

The route builder to update

services()

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

The container to update


        
On this page

Search results