KMPWorkflowPluginInterface
in
Interface for plugins that provide workflow components.
Plugins implementing this interface register their triggers, actions, conditions, and entity types with the workflow engine during bootstrap.
Table of Contents
Methods
- getWorkflowActions() : array<string|int, mixed>
- Register workflow actions that this plugin provides.
- getWorkflowConditions() : array<string|int, mixed>
- Register workflow conditions that this plugin provides.
- getWorkflowEntities() : array<string|int, mixed>
- Register entity types that this plugin's workflows operate on.
- getWorkflowTriggers() : array<string|int, mixed>
- Register workflow triggers that this plugin provides.
Methods
getWorkflowActions()
Register workflow actions that this plugin provides.
public
getWorkflowActions() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of action definitions, each with:
- action: string (unique key like 'PluginName.ActionName')
- label: string
- description: string
- inputSchema: array
- outputSchema: array
- serviceClass: string (FQCN)
- serviceMethod: string
- isAsync: bool
getWorkflowConditions()
Register workflow conditions that this plugin provides.
public
getWorkflowConditions() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of condition definitions, each with:
- condition: string (unique key like 'PluginName.ConditionName')
- label: string
- description: string
- inputSchema: array
- evaluatorClass: string (FQCN)
- evaluatorMethod: string
getWorkflowEntities()
Register entity types that this plugin's workflows operate on.
public
getWorkflowEntities() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of entity definitions, each with:
- entityType: string (unique key like 'PluginName.EntityName')
- label: string
- description: string
- tableClass: string (FQCN of CakePHP Table class)
- fields: array (field definitions with types)
getWorkflowTriggers()
Register workflow triggers that this plugin provides.
public
getWorkflowTriggers() : array<string|int, mixed>
Called during application bootstrap.
Return values
array<string|int, mixed> —Array of trigger definitions, each with:
- event: string (unique key like 'PluginName.EventName')
- label: string (human-readable name)
- description: string
- payloadSchema: array (describes data fields the event provides)