MtlsTrustAnchorResponse
in package
implements
JsonSerializable
The acknowledgement, which is mostly about the restart.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $caCertificateId : string
- $message : string
- $mtlsTrustAnchor : bool
- $restartRequired : bool
- $trustedAnchors : int|null
Methods
- __construct() : mixed
- Constructs a MtlsTrustAnchorResponse.
- fromArray() : self
- Rebuilds a MtlsTrustAnchorResponse 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
$caCertificateId read-only
public
string
$caCertificateId
$message read-only
public
string
$message
$mtlsTrustAnchor read-only
public
bool
$mtlsTrustAnchor
$restartRequired read-only
public
bool
$restartRequired
$trustedAnchors read-only
public
int|null
$trustedAnchors
= null
Methods
__construct()
Constructs a MtlsTrustAnchorResponse.
public
__construct(string $caCertificateId, string $message, bool $mtlsTrustAnchor, bool $restartRequired[, int|null $trustedAnchors = null ]) : mixed
Parameters
- $caCertificateId : string
-
The CA this is about.
- $message : string
-
A sentence an operator can act on, rather than a bare boolean.
- $mtlsTrustAnchor : bool
-
The flag as now stored.
- $restartRequired : bool
-
Whether the change still needs a restart to take effect.
falsewhen the live listener accepted the new anchor set — the ordinary case on a TLS deployment.trueonly when there was no listener to reload into (plaintext, orclient_auth = off), where the flag is stored and applies at the next start. - $trustedAnchors : int|null = null
-
How many CAs the listener now trusts for client authentication, when it was reloaded.
Nonewhen nothing was reloaded. (optional)
fromArray()
Rebuilds a MtlsTrustAnchorResponse 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).
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.