Documentation

AddressField extends StringField
in package

A field representing an address.

Table of Contents

Properties

$addressComplement  : string|null
$boundingBox  : Polygon|null
$city  : string|null
$confidence  : float
$country  : string|null
$pageId  : int|mixed|null
$poBox  : string|null
$polygon  : Polygon
$postalCode  : string|null
$rawValue  : string|null
$reconstructed  : bool
$state  : string|null
$streetName  : string|null
$streetNumber  : string|null
$value  : string|null

Methods

__compare()  : bool
Compares with the value of another field.
__construct()  : mixed
__toString()  : string
Prettier string representation (same semantics as StringField).
setConfidence()  : void
Sets the confidence score.
setPosition()  : void
Sets the position of a field.

Properties

$addressComplement

public string|null $addressComplement

Additional address complement.

$pageId

public int|mixed|null $pageId

The document page on which the information was found.

$postalCode

public string|null $postalCode

Postal / ZIP code.

$rawValue

public string|null $rawValue

The value as it appears on the document.

$reconstructed

public bool $reconstructed

Whether the field was reconstructed from other fields.

$state

public string|null $state

State, province or region.

$streetNumber

public string|null $streetNumber

Street number.

Methods

__compare()

Compares with the value of another field.

public __compare(BaseField $obj) : bool
Parameters
$obj : BaseField

Field to compare.

Return values
bool

__construct()

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

Raw prediction array as returned by the Mindee API.

$pageId : int|null = null

Page number for multi-page documents.

$reconstructed : bool = false

Whether the field was reconstructed.

$valueKey : string = 'value'

Key to use for the full address value.

__toString()

Prettier string representation (same semantics as StringField).

public __toString() : string
Return values
string

setConfidence()

Sets the confidence score.

protected setConfidence(array<string|int, mixed> $rawPrediction) : void
Parameters
$rawPrediction : array<string|int, mixed>

Raw prediction array.

setPosition()

Sets the position of a field.

protected setPosition(array<string|int, mixed> $rawPrediction) : void
Parameters
$rawPrediction : array<string|int, mixed>

Raw prediction array.


        
On this page

Search results