Inttegro PHP SDK

Media extends DomainValue
in package

FinalYes

Media details associated with file.

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

$aspectRatio  : string|null
Aspect Ratio value for this media.
$codec  : string|null
Codec value for this media.
$colorSpace  : string|null
Color Space value for this media.
$durationMs  : int|null
Duration Ms value for this media.
$frameCount  : int|null
Frame Count value for this media.
$hasAlpha  : bool|null
Has Alpha value for this media.
$height  : int|null
Height value for this media.
$kind  : string|null
Kind value for this media.
$pageCount  : int|null
Page Count value for this media.
$width  : int|null
Width value for this media.

Methods

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

$aspectRatio read-only

Aspect Ratio value for this media.

public string|null $aspectRatio

Optional response field. PHP type: string|null; wire field: aspect_ratio (string).

$codec read-only

Codec value for this media.

public string|null $codec

Optional response field. PHP type: string|null; wire field: codec (string).

$colorSpace read-only

Color Space value for this media.

public string|null $colorSpace

Optional response field. PHP type: string|null; wire field: color_space (string).

$durationMs read-only

Duration Ms value for this media.

public int|null $durationMs

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

$frameCount read-only

Frame Count value for this media.

public int|null $frameCount

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

$hasAlpha read-only

Has Alpha value for this media.

public bool|null $hasAlpha

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

$height read-only

Height value for this media.

public int|null $height

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

$kind read-only

Kind value for this media.

public string|null $kind

Optional response field. PHP type: string|null; wire field: kind (string).

$pageCount read-only

Page Count value for this media.

public int|null $pageCount

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

$width read-only

Width value for this media.

public int|null $width

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

Methods

__construct()

Hydrates a Media 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 a Media 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 Media 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