Durable Workflowphp

Durable Workflow PHP SDK — API Reference

Guides

ServiceConfiguration
in package

FinalYes

Validated service-mode settings shared by the optional framework bridges.

Table of Contents

Properties

$controlToken  : string|null
$endpoint  : string
$handlers  : array<string|int, mixed>
$namespace  : string
$pollTimeoutSeconds  : int
$requestTimeoutSeconds  : float|null
$stickyCacheCapacity  : int
$stickyCacheTtlSeconds  : int
$taskQueue  : string
$token  : string|null
$workerRequestTimeoutSeconds  : float|null
$workerToken  : string|null

Methods

__construct()  : mixed
assertWorkerExtensions()  : void
client()  : Client
Build the application-facing client without access to a scoped worker credential.
controlClient()  : Client
Build the application-facing client without access to a scoped worker credential.
fromArray()  : self
taskQueue()  : string
workerClient()  : Client
Build the worker client without access to a scoped control credential.
cacheInteger()  : int
handlers()  : array<int, string>
integer()  : int
nullableString()  : string|null
requestTimeout()  : float|null
string()  : string
validate()  : void

Properties

Methods

__construct()

public __construct(string $endpoint, string $namespace, string $taskQueue, array<int, string> $handlers[, string|null $token = null ][, string|null $controlToken = null ][, string|null $workerToken = null ][, int $pollTimeoutSeconds = 5 ][, int $stickyCacheCapacity = 100 ][, int $stickyCacheTtlSeconds = 300 ][, float|null $requestTimeoutSeconds = null ][, float|null $workerRequestTimeoutSeconds = null ]) : mixed
Parameters
$endpoint : string
$namespace : string
$taskQueue : string
$handlers : array<int, string>
$token : string|null = null
$controlToken : string|null = null
$workerToken : string|null = null
$pollTimeoutSeconds : int = 5
$stickyCacheCapacity : int = 100
$stickyCacheTtlSeconds : int = 300
$requestTimeoutSeconds : float|null = null
$workerRequestTimeoutSeconds : float|null = null

fromArray()

public static fromArray(array<string, mixed> $values) : self
Parameters
$values : array<string, mixed>
Return values
self

taskQueue()

public taskQueue([string|null $override = null ]) : string
Parameters
$override : string|null = null
Return values
string

cacheInteger()

private static cacheInteger(array<string, mixed> $values, string $key, int $default) : int
Parameters
$values : array<string, mixed>
$key : string
$default : int
Return values
int

handlers()

private static handlers(array<int, mixed> $handlers) : array<int, string>
Parameters
$handlers : array<int, mixed>
Return values
array<int, string>

integer()

private static integer(array<string, mixed> $values, string $key, int $default) : int
Parameters
$values : array<string, mixed>
$key : string
$default : int
Return values
int

nullableString()

private static nullableString(array<string, mixed> $values, string $key) : string|null
Parameters
$values : array<string, mixed>
$key : string
Return values
string|null

requestTimeout()

private static requestTimeout(array<string, mixed> $values[, string $key = 'request_timeout_seconds' ]) : float|null
Parameters
$values : array<string, mixed>
$key : string = 'request_timeout_seconds'
Return values
float|null

string()

private static string(array<string, mixed> $values, string $key[, string|null $default = null ]) : string
Parameters
$values : array<string, mixed>
$key : string
$default : string|null = null
Return values
string
On this page

Search results