Skip to content

ReverseResult

Gatepost\Postcode\Client\ReverseResult

The postcode at a point. found can be true while unit is null: the gateway then found an area, but no unit within the radius.

  • bool $found: True when the gateway found a unit or an area within the radius.
  • ?float $radiusM: The radius that the gateway applied, in metres, or null when it sent none.
  • ?Client\ReverseUnit $unit: The nearest unit within the radius, or null.
  • ?string $area: The area, as the gateway sent it (the client does not parse it), or null.
  • ?string $district: The district, as the gateway sent it (the client does not parse it), or null.
  • ?string $state: The state code, such as FC, or null.

Unofficial. Not made or endorsed by NIPOST.