RetailCRM API Client

RequestTransformerInterface

Interface RequestTransformerInterface

Tags
category

RequestTransformerInterface

Table of Contents

Methods

createCustomPsrRequest()  : RequestInterface
Transforms provided custom request data into PSR-7 request model.
createPsrRequest()  : RequestInterface
Transforms provided request data into PSR-7 request model.
getHandler()  : HandlerInterface|null
Returns HandlerInterface.

Methods

createCustomPsrRequest()

Transforms provided custom request data into PSR-7 request model.

public createCustomPsrRequest(string $method, string $uri[, array<int|string, mixed> $requestForm = [] ]) : RequestInterface

This method should perform the following operations:

  • Transform request model into PSR-7 request.
  • Throw HandlerException instance if necessary.
Parameters
$method : string
$uri : string
$requestForm : array<int|string, mixed> = []
Tags
throws
HandlerException
Return values
RequestInterface

createPsrRequest()

Transforms provided request data into PSR-7 request model.

public createPsrRequest(string $method, string $uri[, RequestInterface|null $request = null ]) : RequestInterface

This method should perform the following operations:

  • Transform request model into PSR-7 request.
  • Throw HandlerException instance if necessary.
Parameters
$method : string
$uri : string
$request : RequestInterface|null = null
Tags
throws
HandlerException
Return values
RequestInterface

getHandler()

Returns HandlerInterface.

public getHandler() : HandlerInterface|null

This method can return null. ClientBuilder won't inject authenticator or additional handlers into the handlers chain if this method returns null. No error or exception will be raised.

Return values
HandlerInterface|null

        
On this page

Search results