WorkflowEndpoint
extends BaseEndpoint
in package
Workflow router endpoint substitute.
Table of Contents
Properties
Methods
- __construct() : mixed
- executeWorkflowRequestPost() : array{data: string|bool, code: int}
- Sends a document for synchronous enqueuing.
- setFinalCurlOpts() : array{data: string|bool, code: int}
- initCurlSessionGet() : array{data: string|bool, code: int}
- Starts a CURL session using GET.
- initCurlSessionPost() : array{data: string|bool, code: int}
- Starts a CURL session using POST.
Properties
$settings
public
MindeeApi|MindeeWorkflowApi
$settings
Methods
__construct()
public
__construct(MindeeWorkflowApi $settings) : mixed
Parameters
- $settings : MindeeWorkflowApi
-
Settings for the endpoint.
executeWorkflowRequestPost()
Sends a document for synchronous enqueuing.
public
executeWorkflowRequestPost(InputSource $fileCurl, WorkflowOptions $workflowOptions) : array{data: string|bool, code: int}
Parameters
- $fileCurl : InputSource
-
File to upload.
- $workflowOptions : WorkflowOptions
-
Workflow options.
Return values
array{data: string|bool, code: int} —Final response.
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.
Return values
array{data: string|bool, code: int}initCurlSessionPost()
Starts a CURL session using POST.
private
initCurlSessionPost(InputSource $fileCurl, WorkflowOptions $workflowOptions) : array{data: string|bool, code: int}
Parameters
- $fileCurl : InputSource
-
File to upload.
- $workflowOptions : WorkflowOptions
-
Workflow options.
Return values
array{data: string|bool, code: int} —Final response.