Durable Workflow PHP SDK — API Reference

Guides

TraceCarrier
in package

FinalYes

Optional observations. A validated carrier never grants a receipt or lease.

Table of Contents

Constants

CAPABILITY  : mixed = ['supported' => true, 'schema' => self::SCHEMA,...
LIMITS  : mixed = ['traceparent' => 256, 'tracestate' => 512, 'ba...
SCHEMA  : mixed = 'durable-workflow.trace-context'

Methods

capture()  : array<string|int, mixed>|null
dispatch()  : array<string, mixed>|null
identity()  : bool
normalize()  : array<string|int, mixed>|null
supported()  : bool
allowlistedBaggage()  : void
normalizeHeaders()  : array<string|int, mixed>|null
validHeaderValues()  : bool

Constants

CAPABILITY

private mixed CAPABILITY = ['supported' => true, 'schema' => self::SCHEMA, 'version' => 1, 'dispatch_schema' => 'durable-workflow.queue-trace', 'links_schema' => 'durable-workflow.trace-links', 'max_context_bytes' => 4096, 'max_links' => 32, 'max_links_bytes' => 4096]

LIMITS

private mixed LIMITS = ['traceparent' => 256, 'tracestate' => 512, 'baggage' => 2048]

SCHEMA

private mixed SCHEMA = 'durable-workflow.trace-context'

Methods

capture()

public static capture([array<int, string> $allowlist = [] ][, string|null &$diagnostic = null ]) : array<string|int, mixed>|null
Parameters
$allowlist : array<int, string> = []

@return array<string, mixed>|null

$diagnostic : string|null = null
Return values
array<string|int, mixed>|null

dispatch()

public static dispatch(mixed $value, string $taskId[, string|null &$diagnostic = null ]) : array<string, mixed>|null
Parameters
$value : mixed
$taskId : string
$diagnostic : string|null = null
Return values
array<string, mixed>|null

identity()

public static identity(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

normalize()

public static normalize(mixed $value[, array<int, string> $allowlist = [] ][, string|null &$diagnostic = null ]) : array<string|int, mixed>|null
Parameters
$value : mixed
$allowlist : array<int, string> = []

@return array<string, mixed>|null

$diagnostic : string|null = null
Return values
array<string|int, mixed>|null

supported()

public static supported(array<string, mixed> $clusterInfo) : bool
Parameters
$clusterInfo : array<string, mixed>
Return values
bool

allowlistedBaggage()

private static allowlistedBaggage(array<string, string> $headers, array<string|int, mixed> $allowlist, array<string|int, mixed> &$normalized) : void
Parameters
$headers : array<string, string>

@param list $allowlist @param array<string, string> $normalized

$allowlist : array<string|int, mixed>
$normalized : array<string|int, mixed>

normalizeHeaders()

private static normalizeHeaders(array<string, string> $headers, array<string|int, mixed> $allowlist) : array<string|int, mixed>|null
Parameters
$headers : array<string, string>

@param list $allowlist @return array<string, string>|null

$allowlist : array<string|int, mixed>
Return values
array<string|int, mixed>|null

validHeaderValues()

private static validHeaderValues(array<string, mixed> $headers) : bool
Parameters
$headers : array<string, mixed>

@phpstan-assert-if-true array<string, string> $headers

Return values
bool
On this page

Search results