Inttegro PHP SDK

Access extends DomainValue
in package

FinalYes

Access details associated with file link.

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

$accessCount  : int|null
Access Count value for this access.
$allowDownload  : bool|null
Allow Download value for this access.
$allowedOrigins  : array<int, string>|null
Allowed Origins value for this access.
$lastAccessedAt  : DateTimeImmutable|null
Timestamp associated with last accessed.
$maxAccesses  : int|null
Max Accesses value for this access.

Methods

__construct()  : mixed
Hydrates an Access from decoded Inttegro API data.
fromArray()  : static
Creates an Access 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

$accessCount read-only

Access Count value for this access.

public int|null $accessCount

Optional response field. PHP type: int|null; wire field: access_count (integer).

$allowDownload read-only

Allow Download value for this access.

public bool|null $allowDownload

Optional response field. PHP type: bool|null; wire field: allow_download (boolean).

$allowedOrigins read-only

Allowed Origins value for this access.

public array<int, string>|null $allowedOrigins

Optional response field. PHP type: list<string>|null; wire field: allowed_origins (array<string>).

$lastAccessedAt read-only

Timestamp associated with last accessed.

public DateTimeImmutable|null $lastAccessedAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: last_accessed_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$maxAccesses read-only

Max Accesses value for this access.

public int|null $maxAccesses

Optional response field. PHP type: int|null; wire field: max_accesses (integer).

Methods

__construct()

Hydrates an Access 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 Access 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 Access 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