SamlIdpCredentialPromotion
in package
implements
JsonSerializable
What promoting the `next` credential did.
Table of Contents
Interfaces
- JsonSerializable
Properties
Methods
- __construct() : mixed
- Constructs a SamlIdpCredentialPromotion.
- fromArray() : self
- Rebuilds a SamlIdpCredentialPromotion 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
$active read-only
public
SamlIdpCredential
$active
$retired read-only
public
SamlIdpCredential|null
$retired
= null
Methods
__construct()
Constructs a SamlIdpCredentialPromotion.
public
__construct(SamlIdpCredential $active[, SamlIdpCredential|null $retired = null ]) : mixed
Parameters
- $active : SamlIdpCredential
-
The credential that is now
active. - $retired : SamlIdpCredential|null = null
-
the server's
retiredfield (optional)
fromArray()
Rebuilds a SamlIdpCredentialPromotion from one decoded JSON object.
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
-
The raw wire object.
Return values
selfjsonSerialize()
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).
Rendering for a log line never fails: an unknown union arm renders its discriminator and
an unrecognised enum value its empty Unknown spelling here, and only self::toArray() -- the request path -- refuses to send it (CONTRACT.md §31.2, §34.2
P12.2).
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.