AXIAM PHP SDK

ScimTargetAuthUnknown
in package
implements ScimTargetAuthVariant

FinalYes

A {@see ScimTargetAuth} whose `type` this SDK's copy of the spec does not list.

Decoding one never fails, so a record using a newer variant still lists and reads. It keeps the type and nothing else of what the server sent (CONTRACT.md §31.2, §34.2 P12.1). It can never be sent: self::toArray(), the wire form, throws, because re-sending a body this SDK cannot represent would silently rewrite it; self::jsonSerialize() renders the discriminator, so a log line never fails (§34.2 P12.2).

Table of Contents

Interfaces

ScimTargetAuthVariant
How AXIAM authenticates to the downstream service provider, without the credential itself.

Properties

$tag  : string|null

Methods

__construct()  : mixed
Constructs the unknown arm from what the server sent.
fromArray()  : self
Keeps the `type` of one decoded JSON object, never throwing, and drops every other member: only declared members are kept, and an unknown arm declares none (CONTRACT.md §29.5, §31.2, §34.2 P12.1).
jsonSerialize()  : array<string, mixed>
Renders for `json_encode()` -- a log line -- as the `type` alone; never throws (CONTRACT.md §7 rule 1, §34.2 P12.2).
toArray()  : array<string, mixed>
Refuses to render the wire form: an unknown variant MUST NOT be sent, and the refusal is local, before anything is sent (CONTRACT.md §31.2, §34.2 P12.2).

Properties

Methods

__construct()

Constructs the unknown arm from what the server sent.

public __construct(string|null $tag) : mixed
Parameters
$tag : string|null

The unrecognised type value, or null when absent or not a string.

fromArray()

Keeps the `type` of one decoded JSON object, never throwing, and drops every other member: only declared members are kept, and an unknown arm declares none (CONTRACT.md §29.5, §31.2, §34.2 P12.1).

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

The raw wire object.

Return values
self

jsonSerialize()

Renders for `json_encode()` -- a log line -- as the `type` alone; never throws (CONTRACT.md §7 rule 1, §34.2 P12.2).

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

toArray()

Refuses to render the wire form: an unknown variant MUST NOT be sent, and the refusal is local, before anything is sent (CONTRACT.md §31.2, §34.2 P12.2).

public toArray() : array<string, mixed>
Tags
throws
AxiamException

always.

Return values
array<string, mixed>
On this page

Search results