Durable Workflow PHP SDK — API Reference

Guides

Application

Table of Contents

Interfaces

Authentication
Supplies request headers without coupling the SDK to an auth provider.
PayloadCodec
Transport
WorkflowClientInterface
The application-facing workflow operations implemented by Client and its test fake.
WorkflowHandleInterface
Workflow interactions shared by live and in-memory handles.

Classes

Activity
Marks a public method as an activity handler.
Query
Marks a public workflow method as a query handler.
Signal
Marks a workflow method whose signature declares an accepted signal contract.
Update
Marks a public workflow method as an update handler.
Workflow
Marks the public entry method of a class-oriented workflow.
StaticHeadersAuthentication
Authentication adapter for API keys, signed headers, and gateway identities.
TokenAuthentication
Bearer authentication with optional independent control and worker tokens.
WorkerDiagnosticEvent
A worker lifecycle, retry, shutdown, or handler diagnostic.
FrameworkRuntimeException
Actionable console-facing error for a framework-managed worker.
DurableWorkflowServiceProvider
Auto-discovered Laravel registration for the optional service-mode bridge.
DurableWorkflow
Laravel facade for application workflow interactions and test fakes.
ProcessCredentialResolver
Resolves role credentials only when a Laravel client is constructed.
WorkerCommand
Runs a supervised service-mode worker from Artisan.
WorkerFactory
Builds workers whose attributed handlers come from Laravel's container.
ServiceConfiguration
Validated service-mode settings shared by the optional framework bridges.
Configuration
Symfony configuration schema for Server and Cloud service-mode connections.
DurableWorkflowExtension
Registers validated, autowired Symfony services without owning durable state.
DurableWorkflowBundle
Optional Symfony Bundle for Durable Workflow service mode.
WorkerCommand
Runs a supervised service-mode worker from Symfony Console.
WorkerFactory
Builds workers from Symfony's tagged, autowired handler services.
Client
Synchronous control-plane and worker-plane client for the standalone server.
AvroBinaryValue
Explicit binary adapter for PHP strings intended for Avro `bytes`.
AvroMapValue
Explicit adapter for Avro maps that PHP arrays cannot represent faithfully.
AvroPayloadCodec
Fixed durable_workflow.protocol.Value codec using Avro single-object encoding.
ValueDatumDecoder
Enforces the fixed Value policy where Apache Avro PHP decodes permissively.
ValueDatumReader
Apache PHP adapter for warning-free recursive named-union resolution.
ValueDatumWriter
Selects fixed Value branches without collapsing PHP map keys.
ActivityCancelled
ActivityFailed
CodecException
DurableWorkflowException
InvalidWorkerDefinition
A handler class or method cannot form a valid worker contract.
NonDeterministicWorkflow
QueryFailed
ServerException
SignalFailed
TransportException
UpdateFailed
WorkflowCancelled
WorkflowFailed
WorkflowTerminated
WorkflowTimedOut
ClusterInfo
Public compatibility and capability manifest returned by cluster discovery.
NamespaceDescription
ScheduleAction
Workflow-start action run by a schedule.
ScheduleDescription
SchedulePage
One namespace-scoped page from the schedule list API.
ScheduleSpec
Portable cron and fixed-interval schedule specification.
SearchAttributeCollection
Search attribute definitions available in one namespace.
SearchAttributeDefinition
Result of creating or deleting a custom search attribute.
ServiceOperationDescription
Current server view of a durable service operation call.
ServiceOperationOptions
Immutable routing and waiting options for a service operation.
WorkflowExecution
WorkflowPage
One page from the workflow visibility API.
WorkflowRun
ScheduleHandle
Operations bound to a schedule ID.
SdkIdentity
Resolves the SDK package identity from Composer's installed-package metadata.
ServiceOperationHandle
Operations bound to one durable service call.
AssertionFailed
A framework-independent Durable Workflow test assertion failed.
TestWorkflowHandle
In-memory workflow handle returned by WorkflowClientFake.
WorkerTestHarness
Executes and asserts registered worker handlers without polling a server.
WorkflowClientFake
Records workflow client interactions and supplies configured test results.
Psr18Transport
Default PSR-18 JSON transport.
Version
Protocol versions advertised to the standalone server.
ActivityContext
Activity attempt metadata and heartbeat/cancellation support.
HandlerResolver
Resolves class-oriented handlers through PSR-11 or a no-container default.
PollResponse
Classifies full worker poll response envelopes using protocol fields.
QueryContext
Immutable committed state supplied to query and update handlers.
Replayer
Re-executes a straight-line workflow Fiber against committed, sequence-ordered history.
ReplayResult
WorkflowCommand
A replayable command emitted when straight-line workflow code suspends.
WorkflowContext
Straight-line deterministic operations available while a workflow Fiber is replayed.
Worker
Managed synchronous remote worker for workflow, activity, query, and update tasks.
WorkflowHandle
Operations bound to one stable workflow ID and, optionally, its originally selected run.

Traits

InteractsWithDurableWorkflow
Replaces the autowired workflow client in a Symfony KernelTestCase container.
On this page

Search results