WorkflowCommand
in package
FinalYes
A replayable command yielded by workflow code.
Table of Contents
Properties
- $attributes : array<string|int, mixed>
- $historyShape : string
- $localResult : mixed
- $type : string
- $sideEffect : Closure|null
Methods
- __construct() : mixed
- activity() : self
- childWorkflow() : self
- continueAsNew() : self
- sideEffect() : self
- timer() : self
- toWire() : array<string, mixed>
- upsertSearchAttributes() : self
Properties
$attributes read-only
public
array<string|int, mixed>
$attributes
= []
$historyShape read-only
public
string
$historyShape
$localResult read-only
public
mixed
$localResult
= null
$type read-only
public
string
$type
$sideEffect read-only
private
Closure|null
$sideEffect
= null
Methods
__construct()
public
__construct(string $type, string $historyShape[, array<string, mixed> $attributes = [] ][, mixed $localResult = null ][, callable(): mixed|null $sideEffect = null ]) : mixed
Parameters
- $type : string
- $historyShape : string
- $attributes : array<string, mixed> = []
- $localResult : mixed = null
- $sideEffect : callable(): mixed|null = null
activity()
public
static activity(string $activityType, array<int, mixed> $arguments[, array<string, mixed> $options = [] ]) : self
Parameters
- $activityType : string
- $arguments : array<int, mixed>
- $options : array<string, mixed> = []
Return values
selfchildWorkflow()
public
static childWorkflow(string $workflowType, array<int, mixed> $arguments[, array<string, mixed> $options = [] ]) : self
Parameters
- $workflowType : string
- $arguments : array<int, mixed>
- $options : array<string, mixed> = []
Return values
selfcontinueAsNew()
public
static continueAsNew(array<int, mixed> $arguments[, string|null $workflowType = null ][, string|null $taskQueue = null ]) : self
Parameters
- $arguments : array<int, mixed>
- $workflowType : string|null = null
- $taskQueue : string|null = null
Return values
selfsideEffect()
public
static sideEffect(callable(): mixed $operation) : self
Parameters
- $operation : callable(): mixed
Return values
selftimer()
public
static timer(int $seconds) : self
Parameters
- $seconds : int
Return values
selftoWire()
public
toWire(PayloadCodec $codec, string $defaultTaskQueue) : array<string, mixed>
Parameters
- $codec : PayloadCodec
- $defaultTaskQueue : string
Return values
array<string, mixed>upsertSearchAttributes()
public
static upsertSearchAttributes(array<string, mixed> $attributes) : self
Parameters
- $attributes : array<string, mixed>