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, BaseField|null>
$locations  : array<string|int, FieldLocation>
$indentLevel  : int

Methods

__construct()  : mixed
__toString()  : string
Base str-rep. Do not use.
createField()  : ListField|ObjectField|SimpleField

Properties

Methods

__construct()

public __construct(array<string, int|float|string|bool|null|array<string|int, mixed>> $rawResponse[, int $indentLevel = 0 ]) : mixed
Parameters
$rawResponse : array<string, int|float|string|bool|null|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()

Base str-rep. Do not use.

public __toString() : string
Return values
string

createField()

public static createField(array<string, int|float|string|bool|null|array<string|int, mixed>> $rawPrediction[, int $indentLevel = 0 ]) : ListField|ObjectField|SimpleField
Parameters
$rawPrediction : array<string, int|float|string|bool|null|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
ListField|ObjectField|SimpleField
On this page

Search results