AXIAM PHP SDK

CreateNetworkReplyProfileRequest
in package
implements JsonSerializable

FinalYes

The body of `POST /api/v1/network/profiles`.

Table of Contents

Interfaces

JsonSerializable

Properties

$profile  : NetworkReplyProfileInput
$segmentId  : string
$segmentVersion  : int

Methods

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

public __construct(NetworkReplyProfileInput $profile, string $segmentId, int $segmentVersion) : mixed
Parameters
$profile : NetworkReplyProfileInput

The profile: a typed record of the axiam-radius-reply/1 dictionary. The VLAN is never a field; it is the segment's.

$segmentId : string

The segment the profile belongs to (at most one profile per segment).

$segmentVersion : int

The segment's version as the caller read it: the envelope the profile was written against. A segment written since is 409.

fromArray()

Rebuilds a CreateNetworkReplyProfileRequest 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).

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.

Return values
array<string, mixed>
On this page

Search results