Documentation

ListField
in package

A list of value or words.

Table of Contents

Properties

$confidence  : float
$reconstructed  : bool
$values  : array<string|int, mixed>

Methods

__construct()  : mixed
__toString()  : string
contentsList()  : array<string|int, mixed>
Returns the contents of the list as an array of values.
contentsString()  : string
Returns the contents of a list as a concatenated string.

Properties

$confidence

public float $confidence

Confidence score.

$reconstructed

public bool $reconstructed

Whether the field was reconstructed from other fields.

$values

public array<string|int, mixed> $values

List of word values.

Methods

__construct()

public __construct(array<string|int, mixed> $rawPrediction[, bool $reconstructed = false ][, int|null $pageId = null ]) : mixed
Parameters
$rawPrediction : array<string|int, mixed>

Raw prediction array.

$reconstructed : bool = false

Whether the field has been reconstructed.

$pageId : int|null = null

Page number for multi pages document.

__toString()

public __toString() : string
Return values
string

String representation.

contentsList()

Returns the contents of the list as an array of values.

public contentsList() : array<string|int, mixed>
Return values
array<string|int, mixed>

Contents as an array.

contentsString()

Returns the contents of a list as a concatenated string.

public contentsString([string $separator = ' ' ]) : string
Parameters
$separator : string = ' '

Separator to repeat and insert between lines.

Return values
string

        
On this page

Search results