MigrateCustodyResponse
in package
implements
JsonSerializable
What a custody migration did.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $caCertificateId : string
- $keyCustody : string
- $keyLocator : string|null
- $previousCustody : string
Methods
- __construct() : mixed
- Constructs a MigrateCustodyResponse.
- fromArray() : self
- Rebuilds a MigrateCustodyResponse 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
$keyCustody read-only
public
string
$keyCustody
$keyLocator read-only
public
string|null
$keyLocator
= null
$previousCustody read-only
public
string
$previousCustody
Methods
__construct()
Constructs a MigrateCustodyResponse.
public
__construct(string $caCertificateId, string $keyCustody, string $previousCustody[, string|null $keyLocator = null ]) : mixed
Parameters
- $caCertificateId : string
-
The CA whose key moved.
- $keyCustody : string
-
Where it is now.
- $previousCustody : string
-
Where the key was.
- $keyLocator : string|null = null
-
Where the new custodian filed it, when the custodian has a path. (optional)
fromArray()
Rebuilds a MigrateCustodyResponse 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.