dolibarr  7.0.0-beta
Public Member Functions | List of all members
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 31 of file modules_genpassword.php.

Member Function Documentation

ModeleGenPassword::getDescription ( )

Return description of module.

Returns
string Description of text

Definition at line 50 of file modules_genpassword.php.

ModeleGenPassword::getExample ( )

Return an example of password generated by this module.

Returns
string Example of password

Definition at line 61 of file modules_genpassword.php.

ModeleGenPassword::getNewGeneratedPassword ( )

Build new password.

Returns
string Return a new generated password

Definition at line 73 of file modules_genpassword.php.

ModeleGenPassword::isEnabled ( )

Return if a module can be used or not.

Returns
boolean true if module can be used

Definition at line 40 of file modules_genpassword.php.

ModeleGenPassword::validatePassword (   $password)

Validate a password.

Parameters
string$passwordPassword to check
Returns
int 0 if KO, >0 if OK

Definition at line 85 of file modules_genpassword.php.


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