AXIAM PHP SDK

NetworkReplyProfileInput
in package
implements JsonSerializable

FinalYes

What a writer supplies for a profile. Closed: an unknown key is a refusal naming it, never ignored (design note §3.4).

Table of Contents

Interfaces

JsonSerializable

Properties

$dictionary  : string|null
$filterId  : string|null
$idleTimeoutSecs  : int|null
$serviceType  : RadiusServiceType|null
$sessionTimeoutSecs  : int
$terminationAction  : RadiusTerminationAction|null

Methods

__construct()  : mixed
Constructs a NetworkReplyProfileInput.
fromArray()  : self
Rebuilds a NetworkReplyProfileInput 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.
unknownEnumValue()  : string|null
The string the server sent for an open-enum member this SDK has no name for, or `null`.

Properties

Methods

__construct()

Constructs a NetworkReplyProfileInput.

public __construct(int $sessionTimeoutSecs[, string|null $dictionary = null ][, string|null $filterId = null ][, int|null $idleTimeoutSecs = null ][, RadiusServiceType|null $serviceType = null ][, RadiusTerminationAction|null $terminationAction = null ]) : mixed
Parameters
$sessionTimeoutSecs : int

Session-Timeout, seconds: [SESSION_TIMEOUT_FLOOR_SECS] up to the tenant cap. Never zero.

$dictionary : string|null = null

The dictionary version the profile is written against; defaults to [REPLY_DICTIONARY_V1]. An unknown version is refused. (optional)

$filterId : string|null = null

Filter-Id: one of the owning segment's declared filter_ids. (optional)

$idleTimeoutSecs : int|null = null

Idle-Timeout, seconds: [IDLE_TIMEOUT_FLOOR_SECS] up to session_timeout_secs. (optional)

$serviceType : RadiusServiceType|null = null

the server's service_type field (optional)

$terminationAction : RadiusTerminationAction|null = null

Termination-Action; defaults to RADIUS-Request. (optional)

fromArray()

Rebuilds a NetworkReplyProfileInput 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>

unknownEnumValue()

The string the server sent for an open-enum member this SDK has no name for, or `null`.

public unknownEnumValue(string $wire) : string|null

Only a model decoded by self::fromArray() knows it, and only for a member that decoded to Unknown (CONTRACT.md §27.6.2 item 4, §34.8 (c)): it lets a refusal name the value. It is for messages -- it is never rendered by self::toArray() or self::jsonSerialize() and so is never sent.

Parameters
$wire : string

The member's wire name.

Return values
string|null
On this page

Search results