Inttegro PHP SDK

ResourceSearchFacet extends DomainValue
in package

FinalYes

Immutable base for every closed-schema value returned or accepted by the Inttegro SDK.

Concrete values expose typed, readonly camelCase PHP properties while this base provides the API's snake_case wire view through ArrayAccess, toArray(), and JSON serialization. Nested domain values are exported recursively, backed enums become their string values, and DateTimeInterface values become offset-bearing RFC 3339 strings.

Array access is read-only. Assigning or unsetting a field throws LogicException.

Table of Contents

Properties

$field  : string
$limit  : int|null

Methods

__construct()  : mixed
fromArray()  : static
Creates a typed value from a decoded API 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>
Converts typed properties back to the API's wire representation.

Properties

$field read-only

public string $field

$limit read-only

public int|null $limit = null

Methods

__construct()

public __construct(string $field[, int|null $limit = null ]) : mixed
Parameters
$field : string
$limit : int|null = null

fromArray()

Creates a typed value from a decoded API object.

public static fromArray(array<string|int, mixed> $data) : static
Parameters
$data : array<string|int, 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()

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