Documentation

ListField extends BaseField
in package

A field containing a list of other fields.

Table of Contents

Properties

$confidence  : FieldConfidence|null
$items  : array<string|int, ListField|ObjectField|SimpleField>
Items contained in the list.
$locations  : array<string|int, FieldLocation>
$indentLevel  : int

Methods

__construct()  : mixed
__toString()  : string
createField()  : BaseField

Properties

$indentLevel

protected int $indentLevel

Level of indentation for rst display.

Methods

__construct()

public __construct(array<string|int, mixed> $serverResponse[, int $indentLevel = 0 ]) : mixed
Parameters
$serverResponse : array<string|int, mixed>

Raw server response array.

$indentLevel : int = 0

Level of indentation for rst display.

Tags
throws
MindeeApiException

Throws if deserialization fails.

__toString()

public __toString() : string
Return values
string

createField()

public static createField(array<string|int, mixed> $rawPrediction[, int $indentLevel = 0 ]) : BaseField
Parameters
$rawPrediction : array<string|int, mixed>

Raw prediction array.

$indentLevel : int = 0

Level of indentation for rst display.

Tags
throws
MindeeApiException

Throws if the field type isn't recognized.

Return values
BaseField

        
On this page

Search results