ClientBuilder
in package
implements
BuilderInterface, EventDispatcherAwareInterface
Uses
EventDispatcherAwareTrait
Class ClientBuilder
Tags
Table of Contents
Interfaces
- BuilderInterface
- Interface BuilderInterface
- EventDispatcherAwareInterface
- Interface EventDispatcherAwareInterface
Methods
- appendRequestHandler() : ClientBuilder
- Appends an additional request handler into the request processing chain.
- appendRequestHandlers() : ClientBuilder
- Appends additional request handlers into the request processing chain.
- appendResponseHandler() : ClientBuilder
- Appends an additional response handler into the response processing chain.
- appendResponseHandlers() : ClientBuilder
- Appends additional response handlers into the response processing chain.
- build() : mixed
- Builds client with provided dependencies.
- setApiUrl() : ClientBuilder
- API URL. Looks like this: "https://test.retailcrm.pro/"
- setAuthenticatorHandler() : ClientBuilder
- Request authenticator to append into request transformer pipeline.
- setDebugLogger() : ClientBuilder
- Set debug logger.
- setEventDispatcher() : object
- Sets PSR-14 compatible event dispatcher. Useful if you want to handle specific errors in one place.
- setFormEncoder() : ClientBuilder
- Set form encoder into API client.
- setHttpClient() : ClientBuilder
- Set your PSR-18 HTTP client.
- setRequestFactory() : ClientBuilder
- Sets PSR-17 compatible request factory. You can skip this step if you want to use service discovery.
- setRequestTransformer() : ClientBuilder
- Set request transformer into API client.
- setResponseTransformer() : ClientBuilder
- Set response transformer into API client.
- setStreamFactory() : ClientBuilder
- Sets PSR-17 compatible stream factory. You can skip this step if you want to use service discovery.
- setUriFactory() : ClientBuilder
- Sets PSR-17 compatible URI factory. You can skip this step if you want to use service discovery.
Methods
appendRequestHandler()
Appends an additional request handler into the request processing chain.
public
appendRequestHandler(HandlerInterface $handler) : ClientBuilder
Parameters
- $handler : HandlerInterface
Return values
ClientBuilderappendRequestHandlers()
Appends additional request handlers into the request processing chain.
public
appendRequestHandlers(array<string|int, HandlerInterface> $handlers) : ClientBuilder
Parameters
- $handlers : array<string|int, HandlerInterface>
Return values
ClientBuilderappendResponseHandler()
Appends an additional response handler into the response processing chain.
public
appendResponseHandler(HandlerInterface $handler) : ClientBuilder
Parameters
- $handler : HandlerInterface
Return values
ClientBuilderappendResponseHandlers()
Appends additional response handlers into the response processing chain.
public
appendResponseHandlers(array<string|int, HandlerInterface> $handlers) : ClientBuilder
Parameters
- $handlers : array<string|int, HandlerInterface>
Return values
ClientBuilderbuild()
Builds client with provided dependencies.
public
build() : mixed
Tags
setApiUrl()
API URL. Looks like this: "https://test.retailcrm.pro/"
public
setApiUrl(string $apiUrl) : ClientBuilder
Parameters
- $apiUrl : string
Return values
ClientBuildersetAuthenticatorHandler()
Request authenticator to append into request transformer pipeline.
public
setAuthenticatorHandler(HandlerInterface|null $authenticator) : ClientBuilder
Do not use it if you already added a proper authenticator in the pipeline manually. You can use this method to drop authenticator from client builder (use null).
Parameters
- $authenticator : HandlerInterface|null
Return values
ClientBuildersetDebugLogger()
Set debug logger.
public
setDebugLogger(LoggerInterface|null $debugLogger) : ClientBuilder
The provided logger will be used to record all requests and responses. This feature consumes a lot of resources and shouldn't be used in production.
Parameters
- $debugLogger : LoggerInterface|null
Return values
ClientBuildersetEventDispatcher()
Sets PSR-14 compatible event dispatcher. Useful if you want to handle specific errors in one place.
public
setEventDispatcher(EventDispatcherInterface|null $eventDispatcher) : object
Parameters
- $eventDispatcher : EventDispatcherInterface|null
Return values
objectsetFormEncoder()
Set form encoder into API client.
public
setFormEncoder(FormEncoderInterface $formEncoder) : ClientBuilder
Form encoder is a vital part of the API client. Its purpose is to transform provided request models into form-data. The result will be used as a query or POST body (depends on request type).
Parameters
- $formEncoder : FormEncoderInterface
Return values
ClientBuildersetHttpClient()
Set your PSR-18 HTTP client.
public
setHttpClient(ClientInterface|null $httpClient) : ClientBuilder
Service discovery will be used if no client has been provided.
Parameters
- $httpClient : ClientInterface|null
Return values
ClientBuildersetRequestFactory()
Sets PSR-17 compatible request factory. You can skip this step if you want to use service discovery.
public
setRequestFactory(RequestFactoryInterface|null $requestFactory) : ClientBuilder
Parameters
- $requestFactory : RequestFactoryInterface|null
Return values
ClientBuildersetRequestTransformer()
Set request transformer into API client.
public
setRequestTransformer(RequestTransformerInterface|null $requestTransformer) : ClientBuilder
You can use this method to set your request transformer which will execute the pipeline. The default request transformer doesn't do anything besides calling provided chain of handlers.
Parameters
- $requestTransformer : RequestTransformerInterface|null
Return values
ClientBuildersetResponseTransformer()
Set response transformer into API client.
public
setResponseTransformer(ResponseTransformerInterface|null $responseTransformer) : ClientBuilder
You can use this method to set your response transformer which will execute the pipeline. The default response transformer doesn't do anything besides calling provided chain of handlers. The serializer instance for the request pipeline can be inferred from the provided FormEncoder instance.
Parameters
- $responseTransformer : ResponseTransformerInterface|null
Return values
ClientBuildersetStreamFactory()
Sets PSR-17 compatible stream factory. You can skip this step if you want to use service discovery.
public
setStreamFactory(StreamFactoryInterface|null $streamFactory) : ClientBuilder
Parameters
- $streamFactory : StreamFactoryInterface|null
Return values
ClientBuildersetUriFactory()
Sets PSR-17 compatible URI factory. You can skip this step if you want to use service discovery.
public
setUriFactory(UriFactoryInterface|null $uriFactory) : ClientBuilder
Parameters
- $uriFactory : UriFactoryInterface|null