AXIAM PHP SDK

LockoutPolicy
in package
implements JsonSerializable

FinalYes

Account lockout rules.

Table of Contents

Interfaces

JsonSerializable

Properties

$lockoutBackoffMultiplier  : float
$lockoutDurationSecs  : int
$maxFailedLoginAttempts  : int
$maxLockoutDurationSecs  : int

Methods

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

$lockoutBackoffMultiplier read-only

public float $lockoutBackoffMultiplier

$lockoutDurationSecs read-only

public int $lockoutDurationSecs

$maxFailedLoginAttempts read-only

public int $maxFailedLoginAttempts

$maxLockoutDurationSecs read-only

public int $maxLockoutDurationSecs

Methods

__construct()

Constructs a LockoutPolicy.

public __construct(float $lockoutBackoffMultiplier, int $lockoutDurationSecs, int $maxFailedLoginAttempts, int $maxLockoutDurationSecs) : mixed
Parameters
$lockoutBackoffMultiplier : float

the server's lockout_backoff_multiplier field

$lockoutDurationSecs : int

the server's lockout_duration_secs field

$maxFailedLoginAttempts : int

the server's max_failed_login_attempts field

$maxLockoutDurationSecs : int

the server's max_lockout_duration_secs field

fromArray()

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