SignedAuditBatch
in package
implements
JsonSerializable
A signed batch of audit log entries.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $batchId : string
- $entryIds : array<string|int, mixed>
- $signatureArmored : string
- $signedAt : string
- $signingKeyId : string
- $tenantId : string
Methods
- __construct() : mixed
- Constructs a SignedAuditBatch.
- fromArray() : self
- Rebuilds a SignedAuditBatch 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
$batchId read-only
public
string
$batchId
$entryIds read-only
public
array<string|int, mixed>
$entryIds
$signatureArmored read-only
public
string
$signatureArmored
$signedAt read-only
public
string
$signedAt
$signingKeyId read-only
public
string
$signingKeyId
$tenantId read-only
public
string
$tenantId
Methods
__construct()
Constructs a SignedAuditBatch.
public
__construct(string $batchId, array<int, string> $entryIds, string $signatureArmored, string $signedAt, string $signingKeyId, string $tenantId) : mixed
Parameters
- $batchId : string
-
the server's
batch_idfield - $entryIds : array<int, string>
-
the server's
entry_idsfield - $signatureArmored : string
-
ASCII-armored PGP signed message containing the audit batch payload.
- $signedAt : string
-
the server's
signed_atfield - $signingKeyId : string
-
the server's
signing_key_idfield - $tenantId : string
-
the server's
tenant_idfield
fromArray()
Rebuilds a SignedAuditBatch 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.