AXIAM PHP SDK

ComplianceReportEntry
in package
implements JsonSerializable

FinalYes

One credential's compliance outcome (D9).

Table of Contents

Interfaces

JsonSerializable

Properties

$aaguid  : string|null
$authenticatorName  : string|null
$compliant  : bool
$credentialId  : string
$name  : string
$reason  : string|null
$userId  : string

Methods

__construct()  : mixed
Constructs a ComplianceReportEntry.
fromArray()  : self
Rebuilds a ComplianceReportEntry from one decoded JSON object.
jsonSerialize()  : array<string, mixed>
Renders this object for `json_encode()`.
toArray()  : array<string, mixed>
Renders this object back to its wire form.

Properties

Methods

__construct()

Constructs a ComplianceReportEntry.

public __construct(bool $compliant, string $credentialId, string $name, string $userId[, string|null $aaguid = null ][, string|null $authenticatorName = null ][, string|null $reason = null ]) : mixed
Parameters
$compliant : bool

false only for a genuine policy violation ([ComplianceStatus::NonCompliant]) — a credential with no recorded AAGUID ([ComplianceStatus::Unknown], D9's pre-X3 case) is always true here, never reported as a violation.

$credentialId : string

the server's credential_id field

$name : string

The credential's user-assigned name (WebauthnCredential::name), not the owning user's account name.

$userId : string

the server's user_id field

$aaguid : string|null = null

the server's aaguid field (optional)

$authenticatorName : string|null = null

the server's authenticator_name field (optional)

$reason : string|null = null

None only when compliant and the credential has a recorded AAGUID; set for every non-compliant and every "unknown" (pre-X3) credential. (optional)

fromArray()

Rebuilds a ComplianceReportEntry from one decoded JSON object.

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>

The raw wire object.

Return values
self

jsonSerialize()

Renders this object for `json_encode()`.

public jsonSerialize() : array<string, mixed>

Any Sensitive it carries stays WRAPPED here, so a log line or a json_encode($model) in application code prints [SENSITIVE]. The one place a secret is revealed is ManagementTransport, on the way to the wire and nowhere else (§27.5).

Return values
array<string, mixed>

toArray()

Renders this object back to its wire form.

public toArray() : array<string, mixed>

§27.4 rule 5: a null property is OMITTED, not emitted as null. On a sparse update those two say opposite things — "leave this alone" versus "set this to nothing" — and only omission means the first.

Return values
array<string, mixed>
On this page

Search results