RetailCRM API Client

ClientBuilder
in package
implements BuilderInterface, EventDispatcherAwareInterface Uses EventDispatcherAwareTrait

Class ClientBuilder

Tags
category

ClientBuilder

SuppressWarnings

(PHPMD.CouplingBetweenObjects)

SuppressWarnings

(PHPMD.ExcessiveClassComplexity)

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

build()

Builds client with provided dependencies.

public build() : mixed
Tags
inheritDoc

setAuthenticatorHandler()

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
ClientBuilder

setDebugLogger()

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
ClientBuilder

setEventDispatcher()

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
object

setFormEncoder()

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
ClientBuilder

setHttpClient()

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
ClientBuilder

setRequestFactory()

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
ClientBuilder

setResponseTransformer()

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
ClientBuilder

setStreamFactory()

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
ClientBuilder

setUriFactory()

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
Return values
ClientBuilder 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results