BaseEndpoint
in package
AbstractYes
Abstract class for endpoints.
Table of Contents
Properties
Methods
- __construct() : mixed
- setFinalCurlOpts() : array{data: string|bool, code: int}
- initCurlSessionGet() : array{data: string|bool, code: int}
- Starts a CURL session using GET.
Properties
$settings
public
MindeeApi|MindeeWorkflowApi
$settings
Methods
__construct()
public
__construct(MindeeApi|MindeeWorkflowApi $settings) : mixed
Parameters
- $settings : MindeeApi|MindeeWorkflowApi
-
Input settings.
setFinalCurlOpts()
public
setFinalCurlOpts(CurlHandle $ch, string $suffix, array<string, string|array<string|int, mixed>|bool>|null $postFields[, string|null $workflowId = null ]) : array{data: string|bool, code: int}
Parameters
- $ch : CurlHandle
-
Curl Channel.
- $suffix : string
-
Optional suffix for the url call.
- $postFields : array<string, string|array<string|int, mixed>|bool>|null
-
Post fields.
- $workflowId : string|null = null
-
Optional ID of the workflow.
Return values
array{data: string|bool, code: int} —Final response.
initCurlSessionGet()
Starts a CURL session using GET.
protected
initCurlSessionGet(string $queueId) : array{data: string|bool, code: int}
Parameters
- $queueId : string
-
ID of the queue to poll.