AXIAM PHP SDK

AuditLogEntry
in package
implements JsonSerializable

FinalYes

The `AuditLogEntry` schema from the server's OpenAPI document.

Table of Contents

Interfaces

JsonSerializable

Properties

$action  : string
$actorId  : string
$actorType  : ActorType
$id  : string
$ipAddress  : string|null
$metadata  : mixed
$outcome  : AuditOutcome
$resourceId  : string|null
$tenantId  : string
$timestamp  : string

Methods

__construct()  : mixed
Constructs a AuditLogEntry.
fromArray()  : self
Rebuilds a AuditLogEntry 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

Methods

__construct()

Constructs a AuditLogEntry.

public __construct(string $action, string $actorId, ActorType $actorType, string $id, mixed $metadata, AuditOutcome $outcome, string $tenantId, string $timestamp[, string|null $ipAddress = null ][, string|null $resourceId = null ]) : mixed
Parameters
$action : string

the server's action field

$actorId : string

the server's actor_id field

$actorType : ActorType

the server's actor_type field

$id : string

the server's id field

$metadata : mixed

the server's metadata field

$outcome : AuditOutcome

the server's outcome field

$tenantId : string

the server's tenant_id field

$timestamp : string

the server's timestamp field

$ipAddress : string|null = null

the server's ip_address field (optional)

$resourceId : string|null = null

the server's resource_id field (optional)

fromArray()

Rebuilds a AuditLogEntry from one decoded JSON object.

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

The raw wire object.

Return values
self

jsonSerialize()

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.

Return values
array<string, mixed>
On this page

Search results