PasswordStrengthResult
in package
Result of the password strength check.
Table of Contents
- $characterClassesCountOk : bool
- $characterClassesMinimumCount : int
- $characterClassesRulesCount : int
- $characterClassesRulesCountOk : bool
- $digitCountOk : bool
- $digitMinimumCount : int
- $externalPasswordCheckFailed : bool
- $lengthOk : bool
- $lowerCaseCountOk : bool
- $lowerCaseMinimumCount : int
- $minLength : int
- $passwordContainsPartialAttributes : bool
- $passwordContainsPartialUsername : bool
- $passwordContainsUsername : bool
- $symbolCountOk : bool
- $symbolMinimumCount : int
- $upperCaseCountOk : bool
- $upperCaseMinimumCount : int
- getIssues() : array<string|int, string>
- Returns details about failed rules.
- getTextMessage() : string|null
- Returns the error message or null if valid.
- isValid() : bool
- Returns if the password is valid.
- setCharacterClassesCountOk() : void
- The number of character classes is ok.
- setCharacterClassesRulesCount() : void
- Sets the number of character class checks to fulfill.
- setCharacterClassesRulesCountOk() : void
- Sets if the number of character class checks is fulfilled.
- setDigitCountOk() : void
- Sets if the number of digits is ok.
- setExternalPasswordCheckFailed() : void
- Sets if the external password check failed.
- setLengthOk() : void
- Sets if the length check is ok.
- setLowerCaseCountOk() : void
- Sets if the number of lower-case characters is ok.
- setPasswordContainsPartialAttributes() : void
- Sets if the password contains a part of the user attributes.
- setPasswordContainsPartialUsername() : void
- Sets if the password contains a part of the username.
- setPasswordContainsUsername() : void
- Sets if the password contains the username.
- setSymbolCountOk() : void
- Sets if the number of symbolic characters is ok.
- setUpperCaseCountOk() : void
- Sets if the number of upper-case characters is ok.
Properties
$characterClassesCountOk
private
bool
$characterClassesCountOk
= \false
$characterClassesMinimumCount
private
int
$characterClassesMinimumCount
= 0
$characterClassesRulesCount
private
int
$characterClassesRulesCount
= -1
$characterClassesRulesCountOk
private
bool
$characterClassesRulesCountOk
= \true
$digitCountOk
private
bool
$digitCountOk
= \false
$digitMinimumCount
private
int
$digitMinimumCount
= 0
$externalPasswordCheckFailed
private
bool
$externalPasswordCheckFailed
= \false
$lengthOk
private
bool
$lengthOk
= \false
$lowerCaseCountOk
private
bool
$lowerCaseCountOk
= \false
$lowerCaseMinimumCount
private
int
$lowerCaseMinimumCount
= 0
$minLength
private
int
$minLength
= 0
$passwordContainsPartialAttributes
private
bool
$passwordContainsPartialAttributes
= \false
$passwordContainsPartialUsername
private
bool
$passwordContainsPartialUsername
= \false
$passwordContainsUsername
private
bool
$passwordContainsUsername
= \false
$symbolCountOk
private
bool
$symbolCountOk
= \false
$symbolMinimumCount
private
int
$symbolMinimumCount
= 0
$upperCaseCountOk
private
bool
$upperCaseCountOk
= \false
$upperCaseMinimumCount
private
int
$upperCaseMinimumCount
= 0
Methods
getIssues()
Returns details about failed rules.
public
getIssues() : array<string|int, string>
Return values
array<string|int, string> —issues
getTextMessage()
Returns the error message or null if valid.
public
getTextMessage() : string|null
Return values
string|null —message
isValid()
Returns if the password is valid.
public
isValid() : bool
Return values
bool —is valid
setCharacterClassesCountOk()
The number of character classes is ok.
public
setCharacterClassesCountOk(bool $characterClassesCountOk, int $characterClassesMinimumCount) : void
Parameters
- $characterClassesCountOk : bool
-
ok
- $characterClassesMinimumCount : int
-
count
Return values
void —setCharacterClassesRulesCount()
Sets the number of character class checks to fulfill.
public
setCharacterClassesRulesCount(int $characterClassesRulesCount) : void
Parameters
- $characterClassesRulesCount : int
-
count
Return values
void —setCharacterClassesRulesCountOk()
Sets if the number of character class checks is fulfilled.
public
setCharacterClassesRulesCountOk(bool $characterClassesRulesCountOk) : void
Parameters
- $characterClassesRulesCountOk : bool
-
ok
Return values
void —setDigitCountOk()
Sets if the number of digits is ok.
public
setDigitCountOk(bool $digitCountOk, int $digitMinimumCount) : void
Parameters
- $digitCountOk : bool
-
ok
- $digitMinimumCount : int
-
count
Return values
void —setExternalPasswordCheckFailed()
Sets if the external password check failed.
public
setExternalPasswordCheckFailed(bool $externalPasswordCheckFailed) : void
Parameters
- $externalPasswordCheckFailed : bool
-
failed
Return values
void —setLengthOk()
Sets if the length check is ok.
public
setLengthOk(bool $isOk, int $minLength) : void
Parameters
- $isOk : bool
-
ok
- $minLength : int
-
minimum length
Return values
void —setLowerCaseCountOk()
Sets if the number of lower-case characters is ok.
public
setLowerCaseCountOk(bool $lowerCaseCountOk, int $lowerCaseMinimumCount) : void
Parameters
- $lowerCaseCountOk : bool
-
ok
- $lowerCaseMinimumCount : int
-
count
Return values
void —setPasswordContainsPartialAttributes()
Sets if the password contains a part of the user attributes.
public
setPasswordContainsPartialAttributes(bool $passwordContainsPartialAttributes) : void
Parameters
- $passwordContainsPartialAttributes : bool
-
invalid value found
Return values
void —setPasswordContainsPartialUsername()
Sets if the password contains a part of the username.
public
setPasswordContainsPartialUsername(bool $passwordContainsPartialUsername) : void
Parameters
- $passwordContainsPartialUsername : bool
-
invalid value found
Return values
void —setPasswordContainsUsername()
Sets if the password contains the username.
public
setPasswordContainsUsername(bool $passwordContainsUsername) : void
Parameters
- $passwordContainsUsername : bool
-
invalid value found
Return values
void —setSymbolCountOk()
Sets if the number of symbolic characters is ok.
public
setSymbolCountOk(bool $symbolCountOk, int $symbolMinimumCount) : void
Parameters
- $symbolCountOk : bool
-
ok
- $symbolMinimumCount : int
-
count
Return values
void —setUpperCaseCountOk()
Sets if the number of upper-case characters is ok.
public
setUpperCaseCountOk(bool $upperCaseCountOk, int $upperCaseMinimumCount) : void
Parameters
- $upperCaseCountOk : bool
-
ok
- $upperCaseMinimumCount : int
-
count