Documentation

WorkflowClientInterface extends ClientContextInterface
in

Table of Contents

Methods

countWorkflowExecutions()  : CountWorkflowExecutions
Get count of workflow executions using List Filter Query syntax.
getServiceClient()  : ServiceClientInterface
getWorkflowHistory()  : WorkflowExecutionHistory
listWorkflowExecutions()  : Paginator<string|int, WorkflowExecutionInfo>
Get paginated list of workflow executions using List Filter Query syntax.
newActivityCompletionClient()  : ActivityCompletionClientInterface
Creates a new `ActivityCompletionClient` that can be used to complete activities asynchronously.
newRunningWorkflowStub()  : T
Returns workflow stub associated with running workflow.
newUntypedRunningWorkflowStub()  : WorkflowStubInterface
Returns untyped workflow stub associated with running workflow.
newUntypedWorkflowStub()  : WorkflowStubInterface
Creates workflow untyped client stub that can be used to start a single workflow execution. After workflow is started it can be also used to send signals or queries to it.
newWorkflowStub()  : T
Creates workflow client stub that can be used to start a single workflow execution.
start()  : WorkflowRunInterface
Starts untyped and typed workflow stubs in async mode.
startWithSignal()  : WorkflowRunInterface
Starts untyped and typed workflow stubs in async mode. Sends signal on start.
withDeadline()  : static
Set the deadline for any service requests
withMetadata()  : static
A metadata map to send to the server
withRetryOptions()  : static
withTimeout()  : static
All the service client calls will be made with the specified timeout.

Methods

countWorkflowExecutions()

Get count of workflow executions using List Filter Query syntax.

public countWorkflowExecutions(non-empty-string $query[, non-empty-string|null $namespace = null ]) : CountWorkflowExecutions

Query example:

WorkflowType='MyWorkflow' and StartTime between '2022-08-22T15:04:05+00:00' and '2023-08-22T15:04:05+00:00'
Parameters
$query : non-empty-string
$namespace : non-empty-string|null = null

If null, the preconfigured namespace will be used.

Tags
link
https://docs.temporal.io/visibility
see
self::listWorkflowExecutions()
Return values
CountWorkflowExecutions

getWorkflowHistory()

public getWorkflowHistory(WorkflowExecution $execution[, non-empty-string|null $namespace = null ][, bool $waitNewEvent = false ][, int $historyEventFilterType = HistoryEventFilterType::HISTORY_EVENT_FILTER_TYPE_ALL_EVENT ][, bool $skipArchival = false ][, int<0, max> $pageSize = 0 ]) : WorkflowExecutionHistory
Parameters
$execution : WorkflowExecution
$namespace : non-empty-string|null = null

If null, the preconfigured namespace will be used.

$waitNewEvent : bool = false

If set to true, the RPC call will not resolve until there is a new event which matches, the $historyEventFilterType, or a timeout is hit. The RPC call will be resolved immediately if the workflow was already finished.

$historyEventFilterType : int = HistoryEventFilterType::HISTORY_EVENT_FILTER_TYPE_ALL_EVENT
$skipArchival : bool = false
$pageSize : int<0, max> = 0

Size of the pages to be requested. It affects internal queries only. Use it if you want to load limited number of events from the history.

Return values
WorkflowExecutionHistory

listWorkflowExecutions()

Get paginated list of workflow executions using List Filter Query syntax.

public listWorkflowExecutions(non-empty-string $query[, non-empty-string|null $namespace = null ][, int<0, max> $pageSize = 10 ]) : Paginator<string|int, WorkflowExecutionInfo>

Query example:

WorkflowType='MyWorkflow' and StartTime  between '2022-08-22T15:04:05+00:00' and  '2023-08-22T15:04:05+00:00'
Parameters
$query : non-empty-string
$namespace : non-empty-string|null = null

If null, the preconfigured namespace will be used.

$pageSize : int<0, max> = 10

Maximum number of workflow info per page.

Tags
link
https://docs.temporal.io/visibility
see
self::countWorkflowExecutions()
Return values
Paginator<string|int, WorkflowExecutionInfo>

newRunningWorkflowStub()

Returns workflow stub associated with running workflow.

public newRunningWorkflowStub(T> $class, string $workflowID[, string|null $runID = null ]) : T
Parameters
$class : T>
$workflowID : string
$runID : string|null = null
Tags
psalm-template

T of object

Return values
T

newUntypedRunningWorkflowStub()

Returns untyped workflow stub associated with running workflow.

public newUntypedRunningWorkflowStub(string $workflowID[, string|null $runID = null ][, string|null $workflowType = null ]) : WorkflowStubInterface
Parameters
$workflowID : string
$runID : string|null = null
$workflowType : string|null = null
Return values
WorkflowStubInterface

newUntypedWorkflowStub()

Creates workflow untyped client stub that can be used to start a single workflow execution. After workflow is started it can be also used to send signals or queries to it.

public newUntypedWorkflowStub(string $workflowType[, WorkflowOptions|null $options = null ]) : WorkflowStubInterface

Use WorkflowClient->start($workflowStub, ...$args) to start workflow asynchronously.

IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.

Parameters
$workflowType : string
$options : WorkflowOptions|null = null
Return values
WorkflowStubInterface

newWorkflowStub()

Creates workflow client stub that can be used to start a single workflow execution.

public newWorkflowStub(T> $class[, WorkflowOptions|null $options = null ]) : T

The first call must be to a method annotated with WorkflowMethod. After workflow is started it can be also used to send signals or queries to it.

Use WorkflowClient->start($workflowStub, ...$args) to start workflow asynchronously.

IMPORTANT! Stub is per workflow instance. So new stub should be created for each new one.

Parameters
$class : T>
$options : WorkflowOptions|null = null
Tags
psalm-template

T of object

Return values
T

startWithSignal()

Starts untyped and typed workflow stubs in async mode. Sends signal on start.

public startWithSignal(object|WorkflowStubInterface $workflow, string $signal[, array<string|int, mixed> $signalArgs = [] ][, array<string|int, mixed> $startArgs = [] ]) : WorkflowRunInterface
Parameters
$workflow : object|WorkflowStubInterface
$signal : string
$signalArgs : array<string|int, mixed> = []
$startArgs : array<string|int, mixed> = []
Return values
WorkflowRunInterface

withDeadline()

Set the deadline for any service requests

public withDeadline(DateTimeInterface $deadline) : static
Parameters
$deadline : DateTimeInterface
Return values
static

withMetadata()

A metadata map to send to the server

public withMetadata(array<string, array<string|int, string>> $metadata) : static
Parameters
$metadata : array<string, array<string|int, string>>
Return values
static

withTimeout()

All the service client calls will be made with the specified timeout.

public withTimeout(float $timeout) : static
Parameters
$timeout : float

in seconds

Return values
static 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results