Inttegro PHP SDK

Params extends DomainValue
in package

FinalYes

Typed parameters for creating a reusable catalog price.

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

$about  : string|null
Optional. PHP type: `string|null`; wire field: `about` (`string`).
$customerSelectedAmount  : CustomerSelectedAmountParams|null
Required for selected prices. PHP type: `CustomerSelectedAmountParams|null`; wire field: `customer_selected_amount` (`object`).
$fixedAmount  : AmountParams|null
Required for fixed prices. PHP type: `AmountParams|null`; wire field: `fixed_amount` (`object`).
$label  : string|null
Optional. PHP type: `string|null`; wire field: `label` (`string`).
$productId  : string|null
Optional. PHP type: `string|null`; wire field: `product_id` (`string`).
$type  : Type
Required. PHP type: `Type`; wire field: `type` (`string`).

Methods

__construct()  : mixed
Creates typed parameters for a catalog price.
fromArray()  : static
Creates a Params 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>
Returns the API wire object and omits every optional field whose value is null.

Properties

$about read-only

Optional. PHP type: `string|null`; wire field: `about` (`string`).

public string|null $about = null

$customerSelectedAmount read-only

Required for selected prices. PHP type: `CustomerSelectedAmountParams|null`; wire field: `customer_selected_amount` (`object`).

public CustomerSelectedAmountParams|null $customerSelectedAmount = null

$fixedAmount read-only

Required for fixed prices. PHP type: `AmountParams|null`; wire field: `fixed_amount` (`object`).

public AmountParams|null $fixedAmount = null

$label read-only

Optional. PHP type: `string|null`; wire field: `label` (`string`).

public string|null $label = null

$productId read-only

Optional. PHP type: `string|null`; wire field: `product_id` (`string`).

public string|null $productId = null

$type read-only

Required. PHP type: `Type`; wire field: `type` (`string`).

public Type $type

Methods

__construct()

Creates typed parameters for a catalog price.

public __construct(Type $type[, string|null $productId = null ][, string|null $label = null ][, string|null $about = null ][, AmountParams|null $fixedAmount = null ][, CustomerSelectedAmountParams|null $customerSelectedAmount = null ]) : mixed

Nullable properties are omitted by toArray() so the API can apply its defaults.

Parameters
$type : Type

Required price definition discriminator. Wire field: type (string).

$productId : string|null = null

Optional for fixed prices and required for customer-selected prices. Wire field: product_id (string).

$label : string|null = null

Optional customer-facing label. Wire field: label (string).

$about : string|null = null

Optional explanatory text. Wire field: about (string).

$fixedAmount : AmountParams|null = null
$customerSelectedAmount : CustomerSelectedAmountParams|null = null

fromArray()

Creates a Params 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 Params 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 API wire object and omits every optional field whose value is null.

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

A snake_case request payload.

On this page

Search results