Inttegro PHP SDK

Address extends DomainValue
in package

FinalYes

Postal address details associated with order.

This immutable value hydrates decoded API snake_case data into typed camelCase properties. Use fromArray() for wire data; toArray(), array access, and JSON serialization expose the API wire representation. Nullable properties correspond to optional API fields.

Tags
see
DomainValue

Table of Contents

Properties

$city  : string|null
City value for this address.
$country  : string
Country value for this address.
$line1  : string|null
Line1 value for this address.
$line2  : string|null
Line2 value for this address.
$name  : string|null
Human-readable name.
$phoneNumber  : string|null
Phone Number value for this address.
$postCode  : string|null
Post Code value for this address.
$region  : string|null
Region value for this address.

Methods

__construct()  : mixed
Hydrates an Address from decoded Inttegro API data.
fromArray()  : static
Creates an Address from its decoded API wire representation.
jsonSerialize()  : array<string, mixed>
Returns the same API wire object as `toArray()` for `json_encode()`.
offsetExists()  : bool
Reports whether a non-null property exists for a PHP or API field name.
offsetGet()  : mixed
Reads a typed property through PHP `ArrayAccess`.
offsetSet()  : void
Rejects mutation because domain values are immutable.
offsetUnset()  : void
Rejects unsetting because domain values are immutable.
toArray()  : array<string, mixed>
Converts typed properties back to the API's wire representation.

Properties

$city read-only

City value for this address.

public string|null $city

Optional response field. PHP type: string|null; wire field: city (string).

$country read-only

Country value for this address.

public string $country

Required response field. PHP type: string; wire field: country (string).

$line1 read-only

Line1 value for this address.

public string|null $line1

Optional response field. PHP type: string|null; wire field: line1 (string).

$line2 read-only

Line2 value for this address.

public string|null $line2

Optional response field. PHP type: string|null; wire field: line2 (string).

$name read-only

Human-readable name.

public string|null $name

Optional response field. PHP type: string|null; wire field: name (string).

$phoneNumber read-only

Phone Number value for this address.

public string|null $phoneNumber

Optional response field. PHP type: string|null; wire field: phone_number (string).

$postCode read-only

Post Code value for this address.

public string|null $postCode

Optional response field. PHP type: string|null; wire field: post_code (string).

$region read-only

Region value for this address.

public string|null $region

Optional response field. PHP type: string|null; wire field: region (string).

Methods

__construct()

Hydrates an Address from decoded Inttegro API data.

public __construct(array<string, mixed> $data) : mixed
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

fromArray()

Creates an Address from its decoded API wire representation.

public static fromArray(array<string, mixed> $data) : static
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

Return values
static —

A typed, immutable Address value.

jsonSerialize()

Returns the same API wire object as `toArray()` for `json_encode()`.

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

offsetExists()

Reports whether a non-null property exists for a PHP or API field name.

public offsetExists(mixed $offset) : bool

Both paymentId and payment_id address the same typed property.

Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
bool

offsetGet()

Reads a typed property through PHP `ArrayAccess`.

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
mixed —

The PHP-native property value.

offsetSet()

Rejects mutation because domain values are immutable.

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed

Ignored field name.

$value : mixed

Ignored replacement value.

Tags
throws
LogicException

Always.

offsetUnset()

Rejects unsetting because domain values are immutable.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

Ignored field name.

Tags
throws
LogicException

Always.

toArray()

Converts typed properties back to the API's wire representation.

public toArray() : array<string, mixed>

Property names become snake_case. Nested values, arrays, backed enums, and timestamps are normalized recursively so the result is safe to pass to json_encode().

Return values
array<string, mixed> —

The recursively normalized API object.

On this page

Search results