Inttegro PHP SDK

SuggestedAmountParams extends DomainValue
in package

FinalYes

A convenient amount choice; suggestions do not restrict valid amounts.

Table of Contents

Properties

$id  : string
Required. PHP type: `string`; wire field: `id` (`string`).
$recommended  : bool|null
Optional. PHP type: `bool|null`; wire field: `recommended` (`boolean`).
$value  : int
Required. PHP type: `int`; wire field: `value` (`integer` minor units).

Methods

__construct()  : mixed
Creates one suggested amount in a catalog price request.
fromArray()  : static
Creates the suggestion parameters from a decoded API wire object.
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>
Returns the `snake_case` request payload without null optional fields.

Properties

$recommended read-only

Optional. PHP type: `bool|null`; wire field: `recommended` (`boolean`).

public bool|null $recommended = null

$value read-only

Required. PHP type: `int`; wire field: `value` (`integer` minor units).

public int $value

Methods

__construct()

Creates one suggested amount in a catalog price request.

public __construct(string $id, int $value[, bool|null $recommended = null ]) : mixed
Parameters
$id : string
$value : int
$recommended : bool|null = null

fromArray()

Creates the suggestion parameters from a decoded API wire object.

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 domain 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()

Returns the `snake_case` request payload without null optional fields.

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

The recursively normalized API object.

On this page

Search results