ClientPluginContext
in package
FinalYes
Builder-style configuration context for workflow client plugins.
Plugins modify this builder in ClientPluginInterface::configureClient().
Table of Contents
Properties
- $clientOptions : ClientOptions
- $dataConverter : DataConverterInterface|null
- $interceptors : array<int, Interceptor>
Methods
- __construct() : mixed
- addInterceptor() : self
- Add an interceptor to the client pipeline.
- getClientOptions() : ClientOptions
- getDataConverter() : DataConverterInterface|null
- getInterceptors() : array<int, Interceptor>
- setClientOptions() : self
- setDataConverter() : self
- setInterceptors() : self
Properties
$clientOptions
private
ClientOptions
$clientOptions
$dataConverter
private
DataConverterInterface|null
$dataConverter
= null
$interceptors
private
array<int, Interceptor>
$interceptors
= []
Methods
__construct()
public
__construct(ClientOptions $clientOptions[, DataConverterInterface|null $dataConverter = null ]) : mixed
Parameters
- $clientOptions : ClientOptions
- $dataConverter : DataConverterInterface|null = null
addInterceptor()
Add an interceptor to the client pipeline.
public
addInterceptor(Interceptor $interceptor) : self
Parameters
- $interceptor : Interceptor
Return values
selfgetClientOptions()
public
getClientOptions() : ClientOptions
Return values
ClientOptionsgetDataConverter()
public
getDataConverter() : DataConverterInterface|null
Return values
DataConverterInterface|nullgetInterceptors()
public
getInterceptors() : array<int, Interceptor>
Return values
array<int, Interceptor>setClientOptions()
public
setClientOptions(ClientOptions $clientOptions) : self
Parameters
- $clientOptions : ClientOptions
Return values
selfsetDataConverter()
public
setDataConverter(DataConverterInterface|null $dataConverter) : self
Parameters
- $dataConverter : DataConverterInterface|null
Return values
selfsetInterceptors()
public
setInterceptors(array<int, Interceptor> $interceptors) : self
Parameters
- $interceptors : array<int, Interceptor>