ResourceSearchRequest
extends DomainValue
in package
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
- $cursor : string|null
- $facets : array<string|int, mixed>|null
- $filters : array<string|int, mixed>|null
- $pageSize : int|null
- $sort : ResourceSearchSort|null
- $text : string|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
$cursor read-only
public
string|null
$cursor
= null
$facets read-only
public
array<string|int, mixed>|null
$facets
= null
$filters read-only
public
array<string|int, mixed>|null
$filters
= null
$pageSize read-only
public
int|null
$pageSize
= null
$sort read-only
public
ResourceSearchSort|null
$sort
= null
$text read-only
public
string|null
$text
= null
Methods
__construct()
public
__construct([string|null $text = null ][, array<int, ResourceSearchFilter>|null $filters = null ][, array<string|int, mixed>|null $facets = null ][, ResourceSearchSort|null $sort = null ][, int|null $pageSize = null ][, string|null $cursor = null ]) : mixed
Parameters
- $text : string|null = null
- $filters : array<int, ResourceSearchFilter>|null = null
-
@param list<ResourceSearchFacet>|null $facets
- $facets : array<string|int, mixed>|null = null
- $sort : ResourceSearchSort|null = null
- $pageSize : int|null = null
- $cursor : string|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_caseAPI 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
camelCaseor wiresnake_casefield name.
Return values
booloffsetGet()
Reads a typed property through PHP `ArrayAccess`.
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
-
PHP
camelCaseor wiresnake_casefield 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
offsetUnset()
Rejects unsetting because domain values are immutable.
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
-
Ignored field name.
Tags
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.