RetailCRM API Client

SuccessRequestEvent extends AbstractRequestEvent
in package

Class SuccessRequestEvent

Tags
category

SuccessRequestEvent

Table of Contents

Methods

__construct()  : mixed
SuccessRequestEvent constructor.
getApiDomain()  : string
Returns RetailCRM domain for request.
getApiKey()  : string
Returns API key for request in the event.
getApiUrl()  : string
Returns RetailCRM URL for request in the event without trailing slash.
getRequest()  : RequestInterface
Returns a request for which an event was thrown.
getResponse()  : ResponseInterface|null
Returns a response for which an event was thrown.
getResponseArray()  : array<int|string, mixed>
Returns a response array. It will be present only if custom request was used.
getResponseModel()  : ResponseInterface|null

Methods

__construct()

SuccessRequestEvent constructor.

public __construct(string $baseUrl, RequestInterface $request, ResponseInterface $response, ResponseInterface|null $responseModel[, array<int|string, mixed> $responseArray = [] ]) : mixed
Parameters
$baseUrl : string
$request : RequestInterface
$response : ResponseInterface
$responseModel : ResponseInterface|null
$responseArray : array<int|string, mixed> = []

getApiDomain()

Returns RetailCRM domain for request.

public getApiDomain() : string
Return values
string

getApiKey()

Returns API key for request in the event.

public getApiKey() : string
Return values
string

getApiUrl()

Returns RetailCRM URL for request in the event without trailing slash.

public getApiUrl() : string
Return values
string

getRequest()

Returns a request for which an event was thrown.

public getRequest() : RequestInterface
Return values
RequestInterface

getResponse()

Returns a response for which an event was thrown.

public getResponse() : ResponseInterface|null
Return values
ResponseInterface|null

getResponseArray()

Returns a response array. It will be present only if custom request was used.

public getResponseArray() : array<int|string, mixed>
Return values
array<int|string, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results