Class Password

Responsibility: Validate raw user password by configured password strength rules. Password still could contain very dangerous characters for XSS, SQL or any other attacks. Be careful!!! This doesn't escape everything. It only check if configured character groups are presented and how much and that's all.

MvcCore\Ext\Forms\Validator implements MvcCore\Ext\Forms\IValidator

MvcCore\Ext\Forms\Validators\Password

Namespace: MvcCore\Ext\Forms\Validators
Located at ext-form-field-text/src/MvcCore/Ext/Forms/Validators/Password.php

Methods summary
`public integer`	# `GetMustHaveMinLength( )` Get global minimum password characters length, default value is 12. Get global minimum password characters length, default value is 12. Returns integer
`public MvcCore\Ext\Forms\Validators\Password`	# `SetMustHaveMinLength( integer $mustHaveMinLength = self::MIN_LENGTH )` Set global minimum password characters length, default value is 12. Set global minimum password characters length, default value is 12. Parameters `$mustHaveMinLength` Returns `MvcCore\Ext\Forms\Validators\Password`
`public integer`	# `GetMustHaveMaxLength( )` Get global maximum password characters length, default value is 255. Get global maximum password characters length, default value is 255. Returns integer
`public MvcCore\Ext\Forms\Validators\Password`	# `SetMustHaveMaxLength( integer $mustHaveMaxLength = self::MAX_LENGTH )` Set global maximum password characters length, default value is 255. Set global maximum password characters length, default value is 255. Parameters `$mustHaveMaxLength` Returns `MvcCore\Ext\Forms\Validators\Password`
`public array`	# `GetMustHaveLowerCaseChars( boolean $getWithMinCount = TRUE )` Get password strength rule to have any lower case character presented in password. Default value is `TRUE` to must have lower case character in password. Lower case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. Get password strength rule to have any lower case character presented in password. Default value is `TRUE` to must have lower case character in password. Lower case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. This function returns array with the rule `boolean` as first item and second item is minimum lower case characters count i n password as `integer`. If you set function first argument to `FALSE`, function returns only array `[TRUE]`, if the rule is `TRUE` or an empty array `[]` if the rule is `FALSE`. Parameters `$getWithMinCount` Returns array
`public MvcCore\Ext\Forms\Validators\Password`	# `SetMustHaveLowerCaseChars( boolean $mustHaveLowerCaseChars = TRUE, integer $minCount = self::MIN_LOWERCASE_CHARS_COUNT )` Set password strength rule to have any lower case character presented in password. Default value is `TRUE` to must have lower case character in password. Lower case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. Set password strength rule to have any lower case character presented in password. Default value is `TRUE` to must have lower case character in password. Lower case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. Function has second argument to set minimum lower case characters in password. Default value is at least one lower case character in password. Parameters `$mustHaveLowerCaseChars` `$minCount` Returns `MvcCore\Ext\Forms\Validators\Password`
`public array`	# `GetMustHaveUpperCaseChars( boolean $getWithMinCount = TRUE )` Get password strength rule to have any upper case character presented in password. Default value is `TRUE` to must have upper case character in password. Upper case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. Get password strength rule to have any upper case character presented in password. Default value is `TRUE` to must have upper case character in password. Upper case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. This function returns array with the rule `boolean` as first item and second item is minimum upper case characters count i n password as `integer`. If you set function first argument to `FALSE`, function returns only array `[TRUE]`, if the rule is `TRUE` or an empty array `[]` if the rule is `FALSE`. Parameters `$getWithMinCount` Returns array
`public MvcCore\Ext\Forms\Validators\Password`	# `SetMustHaveUpperCaseChars( boolean $mustHaveUpperCaseChars = TRUE, integer $minCount = self::MIN_UPPERCASE_CHARS_COUNT )` Set password strength rule to have any upper case character presented in password. Default value is `TRUE` to must have upper case character in password. Upper case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. Set password strength rule to have any upper case character presented in password. Default value is `TRUE` to must have upper case character in password. Upper case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. Function has second argument to set minimum upper case characters in password. Default value is at least one upper case character in password. Parameters `$mustHaveUpperCaseChars` `$minCount` Returns `MvcCore\Ext\Forms\Validators\Password`
`public array\|boolean`	# `GetMustHaveDigits( boolean $getWithMinCount = TRUE )` Get password strength rule to have any digit presented in password. Default value is `TRUE` to must have digit characters in password. Digit (arabian) characters from arabian alphabet: 0123456789. Get password strength rule to have any digit presented in password. Default value is `TRUE` to must have digit characters in password. Digit (arabian) characters from arabian alphabet: 0123456789. This function returns array with the rule `boolean` as first item and second item is minimum digit characters count i n password as `integer`. If you set function first argument to `FALSE`, function returns only array `[TRUE]`, if the rule is `TRUE` or an empty array `[]` if the rule is `FALSE`. Parameters `$getWithMinCount` Returns array\|boolean
`public MvcCore\Ext\Forms\Validators\Password`	# `SetMustHaveDigits( boolean $mustHaveDigits = TRUE, integer $minCount = self::MIN_DIGIT_CHARS_COUNT )` Set password strength rule to have any digit presented in password. Default value is `TRUE` to must have digit characters in password. Digit (arabian) characters from arabian alphabet: 0123456789. Set password strength rule to have any digit presented in password. Default value is `TRUE` to must have digit characters in password. Digit (arabian) characters from arabian alphabet: 0123456789. Function has second argument to set minimum digit characters in password. Default value is at least one digit character in password. Parameters `$mustHaveDigits` `$minCount` Returns `MvcCore\Ext\Forms\Validators\Password`
`public array\|boolean`	# `GetMustHaveSpecialChars( boolean $getWithMinCount = TRUE )` Get password strength rule to have any special character presented in password. Default value is `TRUE` to must have special character in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Get password strength rule to have any special character presented in password. Default value is `TRUE` to must have special character in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. This function returns array with the rule `boolean` as first item and second item is minimum special characters count i n password as `integer`. If you set function first argument to `FALSE`, function returns only array `[TRUE]`, if the rule is `TRUE` or an empty array `[]` if the rule is `FALSE`. It's possible to configure own collection of special characters to check if any of them is presented in password by method: `$validator->SetSpecialChars('...');` or by constructor configuration record: `new \MvcCore\Ext\Forms\Validators\Password(['specialChars' => '...']); Parameters `$getWithMinCount` Returns array\|boolean
`public MvcCore\Ext\Forms\Validators\Password`	# `SetMustHaveSpecialChars( boolean $mustHaveSpecialChars = TRUE, integer $minCount = self::MIN_SPECIAL_CHARS_COUNT )` Set password strength rule to have any special character presented in password. Default value is `TRUE` to must have special character in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Set password strength rule to have any special character presented in password. Default value is `TRUE` to must have special character in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Function has second argument to set minimum special characters in password. Default value is at least one digit character in password. It's possible to configure own collection of special characters to check if any of them is presented in password by method: `$validator->SetSpecialChars('...');` or by constructor configuration record: `new \MvcCore\Ext\Forms\Validators\Password(['specialChars' => '...']); Parameters `$mustHaveSpecialChars` `$minCount` Returns `MvcCore\Ext\Forms\Validators\Password`
`public string`	# `GetSpecialChars( )` Get special characters collection to check if any of them is presented in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Get special characters collection to check if any of them is presented in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Returns string
`public MvcCore\Ext\Forms\Validators\Password`	# `SetSpecialChars( string $specialChars = self::SPECIAL_CHARS )` Set special characters collection to check if any of them is presented in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Set special characters collection to check if any of them is presented in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. It's possible to configure own collection of special characters to check if any of them is presented in password by this method: `$validator->SetSpecialChars('...');` or by constructor configuration record: `new \MvcCore\Ext\Forms\Validators\Password(['specialChars' => '...']); Parameters `$specialChars` Returns `MvcCore\Ext\Forms\Validators\Password`
`public`	# `__construct( array $cfg = [] )` Create new password strength rules validator instance. This validator accepts first argument to be an array with camel case keyed records representing protected properties (password strength rules) you need to configure. Example: $validator = new \MvcCore\Ext\Forms\Validators\Password([ 'mustHaveMinLength' => 12, 'mustHaveMaxLength' => 255, 'mustHaveLowerCaseChars' => TRUE, 'mustHaveLowerCaseCharsCount' => 1, 'mustHaveUpperCaseChars' => TRUE, 'mustHaveUpperCaseCharsCount' => 1, 'mustHaveDigits' => TRUE, 'mustHaveDigitsCount' => 1, 'mustHaveSpecialChars' => TRUE, 'mustHaveSpecialCharsCount' => 1, 'specialChars' => '!"#$%&\'()+,-./:;<=>?@[\\]^_`{\|}~', ); Create new password strength rules validator instance. This validator accepts first argument to be an array with camel case keyed records representing protected properties (password strength rules) you need to configure. Example: $validator = new \MvcCore\Ext\Forms\Validators\Password([ 'mustHaveMinLength' => 12, 'mustHaveMaxLength' => 255, 'mustHaveLowerCaseChars' => TRUE, 'mustHaveLowerCaseCharsCount' => 1, 'mustHaveUpperCaseChars' => TRUE, 'mustHaveUpperCaseCharsCount' => 1, 'mustHaveDigits' => TRUE, 'mustHaveDigitsCount' => 1, 'mustHaveSpecialChars' => TRUE, 'mustHaveSpecialCharsCount' => 1, 'specialChars' => '!"#$%&\'()+,-./:;<=>?@[\\]^_`{\|}~', ); Parameters `$cfg` Overrides `MvcCore\Ext\Forms\Validator::__construct()`
`public string\|null`	# `Validate( string\|array $rawSubmittedValue )` Validate raw user password by configured rules. Password still could contain very dangerous characters for XSS, SQL or any other attacks. Be careful!!! Validate raw user password by configured rules. Password still could contain very dangerous characters for XSS, SQL or any other attacks. Be careful!!! Parameters `$rawSubmittedValue` Raw submitted value from user. Returns string\|null Safe submitted value or `NULL` if not possible to return safe value.

Methods inherited from MvcCore\Ext\Forms\Validator
`CreateInstance(), GetErrorMessage(), SetField(), SetForm(), setUpFieldProps(), throwNewInvalidArgumentException()`

Constants summary
`integer`	`MIN_LENGTH` Default minimum password characters length - 12. Default minimum password characters length - 12.	# `12`
`integer`	`MAX_LENGTH` Default maximum password characters length - 255. Default maximum password characters length - 255.	# `255`
`string`	`SPECIAL_CHARS` Default special characters collection - !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Default special characters collection - !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~.	# '!"#$%&\'()*+,-./:;<=>?@[\\]^_`{\|}~'
`integer`	`MIN_LOWERCASE_CHARS_COUNT` Default lower case chars count presented in password - 1; Default lower case chars count presented in password - 1;	# `1`
`integer`	`MIN_UPPERCASE_CHARS_COUNT` Default upper case chars count presented in password - 1; Default upper case chars count presented in password - 1;	# `1`
`integer`	`MIN_DIGIT_CHARS_COUNT` Default digit chars count presented in password - 1; Default digit chars count presented in password - 1;	# `1`
`integer`	`MIN_SPECIAL_CHARS_COUNT` Default special chars count presented in password - 1; Default special chars count presented in password - 1;	# `1`
`integer`	`ERROR_MIN_LENGTH` Error message index(es). Error message index(es).	# `0`
`integer`	`ERROR_MAX_LENGTH`	# `1`
`integer`	`ERROR_LOWERCASE_CHARS`	# `2`
`integer`	`ERROR_LOWERCASE_CHARS_MIN`	# `3`
`integer`	`ERROR_UPPERCASE_CHARS`	# `4`
`integer`	`ERROR_UPPERCASE_CHARS_MIN`	# `5`
`integer`	`ERROR_DIGIT_CHARS`	# `6`
`integer`	`ERROR_DIGIT_CHARS_MIN`	# `7`
`integer`	`ERROR_SPECIAL_CHARS`	# `8`
`integer`	`ERROR_SPECIAL_CHARS_MIN`	# `9`

Properties summary
`protected integer`	`$mustHaveMinLength` Global minimum password characters length, default value is 12. Global minimum password characters length, default value is 12.	# `self::MIN_LENGTH`
`protected integer`	`$mustHaveMaxLength` Global maximum password characters length, default value is 255. Global maximum password characters length, default value is 255.	# `self::MAX_LENGTH`
`protected boolean`	`$mustHaveLowerCaseChars` Password strength rule to have any lower case character presented in password. Default value is `TRUE` to must have lower case character in password. Lower case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. Password strength rule to have any lower case character presented in password. Default value is `TRUE` to must have lower case character in password. Lower case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz.	# `TRUE`
`protected integer`	`$mustHaveLowerCaseCharsCount` Password strength rule to have minimum lower case characters count presented in password. Default value is `1` to must have at least one lower case character in password. Lower case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz. Password strength rule to have minimum lower case characters count presented in password. Default value is `1` to must have at least one lower case character in password. Lower case characters from latin alphabet: abcdefghijklmnopqrstuvwxyz.	# `self::MIN_LOWERCASE_CHARS_COUNT`
`protected boolean`	`$mustHaveUpperCaseChars` Password strength rule to have any upper case character presented in password. Default value is `TRUE` to must have upper case character in password. Upper case characters from latin alphabet: ABCDEFGHIJKLMNOPQRSTUVWXYZ. Password strength rule to have any upper case character presented in password. Default value is `TRUE` to must have upper case character in password. Upper case characters from latin alphabet: ABCDEFGHIJKLMNOPQRSTUVWXYZ.	# `TRUE`
`protected integer`	`$mustHaveUpperCaseCharsCount` Password strength rule to have minimum upper case characters count presented in password. Default value is `1` to must have at least one upper case character in password. Upper case characters from latin alphabet: ABCDEFGHIJKLMNOPQRSTUVWXYZ. Password strength rule to have minimum upper case characters count presented in password. Default value is `1` to must have at least one upper case character in password. Upper case characters from latin alphabet: ABCDEFGHIJKLMNOPQRSTUVWXYZ.	# `self::MIN_UPPERCASE_CHARS_COUNT`
`protected boolean`	`$mustHaveDigits` Password strength rule to have any digit presented in password. Default value is `TRUE` to must have digit characters in password. Digit (arabian) characters from arabian alphabet: 0123456789. Password strength rule to have any digit presented in password. Default value is `TRUE` to must have digit characters in password. Digit (arabian) characters from arabian alphabet: 0123456789.	# `TRUE`
`protected integer`	`$mustHaveDigitsCount` Password strength rule to have minimum digits count presented in password. Default value is `1` to must have at least one digit character in password. Digit (arabian) characters from arabian alphabet: 0123456789. Password strength rule to have minimum digits count presented in password. Default value is `1` to must have at least one digit character in password. Digit (arabian) characters from arabian alphabet: 0123456789.	# `self::MIN_DIGIT_CHARS_COUNT`
`protected boolean`	`$mustHaveSpecialChars` Password strength rule to have any special character presented in password. Default value is `TRUE` to must have special character in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Password strength rule to have any special character presented in password. Default value is `TRUE` to must have special character in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. It's possible to configure own collection of special characters to check if any of them is presented in password by method: `$validator->SetSpecialChars('...');` or by constructor configuration record: `new \MvcCore\Ext\Forms\Validators\Password(['specialChars' => '...']);	# `TRUE`
`protected integer`	`$mustHaveSpecialCharsCount` Password strength rule to have minimum special characters count presented in password. Default value is `1` to must have at least one special character in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Password strength rule to have minimum special characters count presented in password. Default value is `1` to must have at least one special character in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. It's possible to configure own collection of special characters to check if any of them is presented in password by method: `$validator->SetSpecialChars('...');` or by constructor configuration record: `new \MvcCore\Ext\Forms\Validators\Password(['specialChars' => '...']);	# `self::MIN_SPECIAL_CHARS_COUNT`
`protected string`	`$specialChars` Special characters collection to check if any of them is presented in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. Special characters collection to check if any of them is presented in password. Default special characters are: !"#$%&\'()+,-./:;<=>?@[\]^_`{\|}~. It's possible to configure own collection of special characters to check if any of them is presented in password by method: `$validator->SetSpecialChars('...');` or by constructor configuration record: `new \MvcCore\Ext\Forms\Validators\Password(['specialChars' => '...']);	# `self::SPECIAL_CHARS`
`protected static array`	`$errorMessages` Validation failure message template definitions. Validation failure message template definitions.	# [ self::ERROR_MIN_LENGTH => "Password must have a minimum length of {1} characters.", self::ERROR_MAX_LENGTH => "Password must have a maximum length of {1} characters.", self::ERROR_LOWERCASE_CHARS => "Password must contain lower case characters ({1}).", self::ERROR_LOWERCASE_CHARS_MIN => "Password must contain at minimum {1} lower case characters ({2}).", self::ERROR_UPPERCASE_CHARS => "Password must contain upper case characters ({1}).", self::ERROR_UPPERCASE_CHARS_MIN => "Password must contain at minimum {1} upper case characters ({2}).", self::ERROR_DIGIT_CHARS => "Password must contain digits ({1}).", self::ERROR_DIGIT_CHARS_MIN => "Password must contain at minimum {1} digits ({2}).", self::ERROR_SPECIAL_CHARS => "Password must contain special characters ( {1} ).", self::ERROR_SPECIAL_CHARS_MIN => "Password must contain at minimum {1} special characters ( {2} ).", ]

Properties inherited from MvcCore\Ext\Forms\Validator
`$field, $fieldSpecificProperties, $form, $toolClass`

Classes

Interfaces

Traits

Exceptions

Functions

Class Password

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Overrides

Parameters

Returns