ModeleGenPassword Class Reference

Parent class for password rules/management modules. More...

Inheritance diagram for ModeleGenPassword:

Public Member Functions
	isEnabled ()
	Return if a module can be used or not. More...
	getDescription ()
	Return description of module. More...
	getExample ()
	Return an example of password generated by this module. More...
	getNewGeneratedPassword ()
	Build new password. More...
	validatePassword ($password)
	Validate a password. More...

Detailed Description

Parent class for password rules/management modules.

Definition at line 30 of file modules_genpassword.php.

Member Function Documentation

getDescription()

ModeleGenPassword::getDescription

(

)

Return description of module.

Returns

string Description of text

Reimplemented in modGeneratePassStandard, modGeneratePassPerso, and modGeneratePassNone.

Definition at line 61 of file modules_genpassword.php.

getExample()

ModeleGenPassword::getExample

(

)

Return an example of password generated by this module.

Returns

string Example of password

Reimplemented in modGeneratePassStandard, modGeneratePassPerso, and modGeneratePassNone.

Definition at line 72 of file modules_genpassword.php.

getNewGeneratedPassword()

ModeleGenPassword::getNewGeneratedPassword

(

)

Build new password.

Returns

string Return a new generated password

Reimplemented in modGeneratePassStandard, modGeneratePassPerso, and modGeneratePassNone.

Definition at line 84 of file modules_genpassword.php.

isEnabled()

ModeleGenPassword::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 51 of file modules_genpassword.php.

validatePassword()

ModeleGenPassword::validatePassword

(

$password

)

Validate a password.

This function is called by User->setPassword() and internally to validate that the password matches the constraints.

Parameters

string

$password

Password to check

Returns

int 0 if KO, >0 if OK

Reimplemented in modGeneratePassStandard, modGeneratePassPerso, and modGeneratePassNone.

Definition at line 97 of file modules_genpassword.php.

---

The documentation for this class was generated from the following file:

• dolibarr_17.0/htdocs/core/modules/security/generate/modules_genpassword.php