BulkOperation
in package
implements
BulkOperationInterface
Class to use with billing bulk/concurrent operation method
Out-of-the-box Implementation of AsyncOperationInterface.
Interfaces, Classes, Traits and Enums
- BulkOperationInterface
- Interface for element of bulk/concurrent call to the billing. Represents one API call task.
Table of Contents
- __construct() : mixed
- Setup bulk/concurrent operation data
- executed() : bool
- Return true if the call was executed
- getException() : PortaException|null
- Will return exception object of failed call
- getResponse() : array<string|int, mixed>|null
- Will return resul array on success call.
- success() : bool
- Return true if call was success
Methods
__construct()
Setup bulk/concurrent operation data
public
__construct(string $endpoint[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $endpoint : string
-
Billing API endpoint like '/Customer/get_customer_info'
- $params : array<string|int, mixed> = []
-
Billing API call params, which will be placed to { "params": /HERE/ } of API call
Return values
mixed —executed()
Return true if the call was executed
public
executed() : bool
Return values
bool —getException()
Will return exception object of failed call
public
getException() : PortaException|null
Return values
PortaException|null —exception, happened ahile processing the call. May return null if called before processed
getResponse()
Will return resul array on success call.
public
getResponse() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —billing call dataset array, nul if called before processed
success()
Return true if call was success
public
success() : bool