PasswordPolicy
in package
implements
JsonSerializable
Password complexity and history requirements.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $hibpCheckEnabled : bool
- $minLength : int
- $passwordHistoryCount : int
- $requireDigits : bool
- $requireLowercase : bool
- $requireSymbols : bool
- $requireUppercase : bool
Methods
- __construct() : mixed
- Constructs a PasswordPolicy.
- fromArray() : self
- Rebuilds a PasswordPolicy 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
$hibpCheckEnabled read-only
public
bool
$hibpCheckEnabled
$minLength read-only
public
int
$minLength
$passwordHistoryCount read-only
public
int
$passwordHistoryCount
$requireDigits read-only
public
bool
$requireDigits
$requireLowercase read-only
public
bool
$requireLowercase
$requireSymbols read-only
public
bool
$requireSymbols
$requireUppercase read-only
public
bool
$requireUppercase
Methods
__construct()
Constructs a PasswordPolicy.
public
__construct(bool $hibpCheckEnabled, int $minLength, int $passwordHistoryCount, bool $requireDigits, bool $requireLowercase, bool $requireSymbols, bool $requireUppercase) : mixed
Parameters
- $hibpCheckEnabled : bool
-
the server's
hibp_check_enabledfield - $minLength : int
-
the server's
min_lengthfield - $passwordHistoryCount : int
-
the server's
password_history_countfield - $requireDigits : bool
-
the server's
require_digitsfield - $requireLowercase : bool
-
the server's
require_lowercasefield - $requireSymbols : bool
-
the server's
require_symbolsfield - $requireUppercase : bool
-
the server's
require_uppercasefield
fromArray()
Rebuilds a PasswordPolicy 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.