Inttegro PHP SDK

SafetyResult extends DomainValue
in package

FinalYes

Result of the email safety scan.

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

$contentHash  : string
Content Hash value for this safety result.
$links  : array<int, ScannedLink>|null
Links value for this safety result.
$normalizedText  : string
Normalized Text value for this safety result.
$quarantineNotes  : string|null
Quarantine Notes value for this safety result.
$reasonCodes  : array<int, string>|null
Reason Codes value for this safety result.
$sanitizedHtml  : string|null
Sanitized Html value for this safety result.
$scanner  : string
Scanner value for this safety result.
$status  : string
Current lifecycle state.

Methods

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

$contentHash read-only

Content Hash value for this safety result.

public string $contentHash

Required response field. PHP type: string; wire field: content_hash (string).

$links read-only

Links value for this safety result.

public array<int, ScannedLink>|null $links

Optional response field. PHP type: list<\Inttegro\MessageTemplate\ScannedLink>|null; wire field: links (array<object>). When the field is absent, the SDK exposes an empty collection.

$normalizedText read-only

Normalized Text value for this safety result.

public string $normalizedText

Required response field. PHP type: string; wire field: normalized_text (string).

$quarantineNotes read-only

Quarantine Notes value for this safety result.

public string|null $quarantineNotes

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

$reasonCodes read-only

Reason Codes value for this safety result.

public array<int, string>|null $reasonCodes

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

$sanitizedHtml read-only

Sanitized Html value for this safety result.

public string|null $sanitizedHtml

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

$scanner read-only

Scanner value for this safety result.

public string $scanner

Required response field. PHP type: string; wire field: scanner (string).

$status read-only

Current lifecycle state.

public string $status

Required response field. PHP type: string; wire field: status (string). Compare against Status cases by using their ->value strings.

Methods

__construct()

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