APIClientActionGeneric
in package
Table of Contents
- $_actionId : string
- $_parameters : array<string|int, mixed>
- $_pSDKWrapper : SDKWrapper
- $_requestHandle : int
- $_resourceId : string
- $_resourceType : string
- $_result : array<string|int, mixed>
- $_resultCallback : callable
- __clone() : mixed
- __construct() : mixed
- addRequestToQueue() : $this
- getActionId() : string
- getErrorCode() : int
- getParameters() : array<string|int, mixed>
- getResourceId() : string
- getResourceType() : string
- getResultCallback() : callable
- getResultMeta() : array<string|int, mixed>
- getResultRecords() : array<string|int, mixed>
- getResultStatus() : bool
- getSDKWrapper() : SDKWrapper
- onAfterExecution() : mixed
- sendRequests() : mixed
- call addRequestToQueue() first
- setParameters() : mixed
- setResourceId() : mixed
- withActionIdAndResourceType() : self
- getResult() : array<string|int, mixed>
- setActionId() : mixed
- setResourceType() : mixed
- setResult() : mixed
- setResultCallback() : mixed
- generateException() : ApiClientException
Properties
$_actionId
private
string
$_actionId
= ''
$_parameters
private
array<string|int, mixed>
$_parameters
= []
$_pSDKWrapper
private
SDKWrapper
$_pSDKWrapper
= null
$_requestHandle
private
int
$_requestHandle
= null
$_resourceId
private
string
$_resourceId
= ''
$_resourceType
private
string
$_resourceType
= ''
$_result
private
array<string|int, mixed>
$_result
= []
$_resultCallback
private
callable
$_resultCallback
= null
Methods
__clone()
public
__clone() : mixed
Return values
mixed —__construct()
public
__construct(SDKWrapper $pSDKWrapper, string $actionId, string $resourceType) : mixed
Parameters
- $pSDKWrapper : SDKWrapper
- $actionId : string
- $resourceType : string
Return values
mixed —addRequestToQueue()
public
addRequestToQueue() : $this
Return values
$this —getActionId()
public
getActionId() : string
Return values
string —getErrorCode()
public
getErrorCode() : int
Return values
int —getParameters()
public
getParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getResourceId()
public
getResourceId() : string
Return values
string —getResourceType()
public
getResourceType() : string
Return values
string —getResultCallback()
public
getResultCallback() : callable
Return values
callable —getResultMeta()
public
getResultMeta() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getResultRecords()
public
getResultRecords() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getResultStatus()
public
getResultStatus() : bool
Return values
bool —getSDKWrapper()
public
getSDKWrapper() : SDKWrapper
Return values
SDKWrapper —onAfterExecution()
public
onAfterExecution(array<string|int, mixed> $result) : mixed
Parameters
- $result : array<string|int, mixed>
Return values
mixed —sendRequests()
call addRequestToQueue() first
public
sendRequests() : mixed
Return values
mixed —setParameters()
public
setParameters(array<string|int, mixed> $parameters) : mixed
Parameters
- $parameters : array<string|int, mixed>
Return values
mixed —setResourceId()
public
setResourceId(string $resourceId) : mixed
Parameters
- $resourceId : string
Return values
mixed —withActionIdAndResourceType()
public
withActionIdAndResourceType(string $actionId, string $resourceType) : self
Parameters
- $actionId : string
- $resourceType : string
Return values
self —getResult()
protected
getResult() : array<string|int, mixed>
Return values
array<string|int, mixed> —setActionId()
protected
setActionId(string $actionId) : mixed
Parameters
- $actionId : string
Return values
mixed —setResourceType()
protected
setResourceType(string $resourceType) : mixed
Parameters
- $resourceType : string
Return values
mixed —setResult()
protected
setResult(array<string|int, mixed> $result) : mixed
Parameters
- $result : array<string|int, mixed>
Return values
mixed —setResultCallback()
protected
setResultCallback(callable $resultCallback) : mixed
Parameters
- $resultCallback : callable
Return values
mixed —generateException()
private
generateException() : ApiClientException