KMP PHP API Reference

DefaultWorkflowEngine

in package

• Application

implements WorkflowEngineInterface

Default workflow execution engine.

Table of Contents

Interfaces

WorkflowEngineInterface

Contract for the workflow execution engine.

Constants

MAX_EXECUTION_DEPTH  : mixed = 200

Maximum node execution depth to prevent infinite recursion.

Properties

$container  : ContainerInterface

$ephemeral  : bool

Whether the current execution is ephemeral (in-memory, no persistence).

$executionDepth  : int

Current execution depth counter.

$isInTransaction  : bool

Whether we are currently inside a database transaction.

$visitedNodes  : array<string, bool>

Tracks visited nodes during a single execution pass to detect cycles.

Methods

__construct()  : mixed

Constructor.

cancelHumanTask()  : ServiceResult

Cancel a pending human task without resuming the workflow.

cancelWorkflow()  : ServiceResult

Cancel a running or waiting workflow instance.

completeHumanTask()  : ServiceResult

Complete a human task and resume the workflow.

dispatchTrigger()  : array<string|int, ServiceResult>

Dispatch a trigger event and start any matching workflows.

fireIntermediateApprovalActions()  : ServiceResult

Fire actions connected to an approval node's on_each_approval port.

getInstanceState()  : array<string|int, mixed>|null

Get the current state of a workflow instance.

resumeWorkflow()  : ServiceResult

Resume a waiting workflow instance from a specific node output.

startWorkflow()  : ServiceResult

Start a new workflow instance from a definition slug.

advanceToOutputs()  : void

Advance execution to all targets of a node's output port.

collectDescendants()  : void

Collect all descendant node IDs reachable from a starting node.

createExecutionLog()  : WorkflowExecutionLog|null

Create an execution log entry. Returns null for ephemeral workflows.

executeActionNode()  : void

Execute an action node via the WorkflowActionRegistry.

executeApprovalNode()  : void

Execute an approval node — creates approval record, sets instance to WAITING.

executeConditionNode()  : void

Execute a condition node and follow the matching output port.

executeDelayNode()  : void

Execute a delay node — sets instance to WAITING for later resumption.

executeEndNode()  : void

Execute an end node — completes this path, finishes instance if no active nodes remain.

executeForEachNode()  : void

Execute a forEach node — iterates over a collection, executing child nodes per item.

executeForkNode()  : void

Execute a fork node — marks complete and executes all output targets.

executeHumanTaskNode()  : void

Execute a humanTask node — creates a task record and pauses the workflow.

executeJoinNode()  : void

Execute a join node — waits for all input paths before advancing.

executeLoopNode()  : void

Execute a loop node — iterates until max count or exit condition.

executeNode()  : void

Execute a single workflow node and advance to connected outputs.

executeStateMachineNode()  : void

Execute a state machine node — validates and applies a state transition with configurable rules, status resolution, and audit logging.

executeSubworkflowNode()  : void

Execute a subworkflow node — starts a child workflow, sets instance to WAITING.

findContextValueByKey()  : mixed

Recursively find the first non-empty value for a key in workflow context.

findIncomingSource()  : string

Find which source node most recently completed execution leading into a join.

findNodesByType()  : array<string|int, mixed>

Find all nodes of a given type in the definition.

getAllOutputTargets()  : array<string|int, string>

Get all output targets for a node regardless of port.

getNodeInputSources()  : array<string|int, string>

Get all source node IDs that have edges leading into the given node.

getNodeOutputTargets()  : array<string|int, string>

Get target node IDs for a given node's output port.

getTriggerEntityIdField()  : string|null

Resolve the trigger-configured entity ID field name for a workflow.

hydrateInstanceEntityMetadata()  : void

Persist the workflow entity_id once it becomes available in context.

parseDeadline()  : DateTime|null

Parse a deadline duration string (e.g., "14d", "24h", "7d") into a future DateTime.

portsMatch()  : bool

Check if two port names are equivalent.

removeFromActiveNodes()  : void

Remove a node from the instance's active_nodes list.

resolveContextValue()  : mixed

Resolve a context value using a dot-path (e.g., '$.trigger.officer.id').

resolveInputData()  : array<string|int, mixed>

Resolve input data for a node from context using configured mappings.

resolveParamValue()  : mixed

Resolve a parameter value that may be a plain scalar, a $.path string, or a value descriptor object {type: '...', ...}.

resolveRequiredCount()  : int

Resolve a required count value that may be an integer or a config object.

saveLog()  : void

Save an execution log update. No-op if log is null (ephemeral mode).

setContextValue()  : void

Set a value in the context at the given dot-path.

updateInstance()  : void

Save instance changes to the database.

applyActionContextUpdates()  : mixed

Apply action-requested context updates and remove private payload data from output.

beginExecution()  : array<string, mixed>

Reset per-execution state and return the previous state for restoration.

executeActionService()  : mixed

Execute a workflow action service while suppressing model-trigger loops.

executeInTransaction()  : ServiceResult

Execute a callable inside a single database transaction, avoiding nesting.

markInstanceFailed()  : void

Mark a workflow instance as FAILED after a transaction rollback.

nodeHasOutput()  : bool

Check whether a node declares a connected output port.

normalizeActionResult()  : array<string, mixed>

Normalize action provider output into the standard result envelope.

refreshInstanceExecutionState()  : void

Synchronize an in-flight entity after a nested callback updated its row.

restoreExecution()  : void

Restore per-execution state after a public engine entry point completes.

startWorkflowInternal()  : ServiceResult

Start a workflow with optional parent callback metadata.