WorkflowEndpoint
extends BaseEndpoint
in package
Workflow router endpoint substitute.
Table of Contents
Properties
Methods
- __construct() : mixed
- executeWorkflowRequestPost() : array<string|int, mixed>
- Sends a document for synchronous enqueuing.
- setFinalCurlOpts() : array<string|int, mixed>
- initCurlSessionGet() : array<string|int, mixed>
- Starts a CURL session, using GET.
- initCurlSessionPost() : array<string|int, mixed>
- Starts a CURL session, using POST.
Properties
$settings
public
MindeeApi|MindeeWorkflowApi
$settings
Settings of the endpoint.
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, string|null $alias, string|null $priority, bool $fullText, string|null $publicUrl) : array<string|int, mixed>
Parameters
- $fileCurl : InputSource
-
File to upload.
- $alias : string|null
-
Alias to give to the document.
- $priority : string|null
-
Priority to give to the document.
- $fullText : bool
-
Whether to include the full OCR text response in compatible APIs. This performs a full OCR operation on the server and may increase response time. This performs a cropping operation on the server and will increase response time.
- $publicUrl : string|null
-
One time use encrypted URL for authentication.
Return values
array<string|int, mixed>setFinalCurlOpts()
public
setFinalCurlOpts(resource $ch, string $suffix, array<string|int, mixed>|null $postFields) : array<string|int, mixed>
Parameters
- $ch : resource
-
Curl Channel.
- $suffix : string
-
Optional suffix for the url call.
- $postFields : array<string|int, mixed>|null
-
Post fields.
Return values
array<string|int, mixed>initCurlSessionGet()
Starts a CURL session, using GET.
protected
initCurlSessionGet(string $queueId) : array<string|int, mixed>
Parameters
- $queueId : string
-
ID of the queue to poll.
Return values
array<string|int, mixed>initCurlSessionPost()
Starts a CURL session, using POST.
private
initCurlSessionPost(InputSource $fileCurl, string|null $alias, string|null $priority, bool $fullText, string|null $publicUrl) : array<string|int, mixed>
Parameters
- $fileCurl : InputSource
-
File to upload.
- $alias : string|null
-
Whether to include the full text for each page.
- $priority : string|null
-
Whether to include the full text for each page.
- $fullText : bool
-
Whether to include the full OCR text response in compatible APIs. This performs a full OCR operation on the server and may increase response time.
- $publicUrl : string|null
-
One time use encrypted URL for authentication.