dolibarr  17.0.3
Public Member Functions | List of all members
modGeneratePassStandard Class Reference

Class to generate a password according to a dolibarr standard rule (12 random chars) More...

Inheritance diagram for modGeneratePassStandard:
Inheritance graph
[legend]
Collaboration diagram for modGeneratePassStandard:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db, $conf, $langs, $user)
 Constructor. 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 This function is called by User->setPassword() and internally to validate that the password matches the constraints. More...
 
- Public Member Functions inherited from ModeleGenPassword
 isEnabled ()
 Return if a module can be used or not. More...
 

Detailed Description

Class to generate a password according to a dolibarr standard rule (12 random chars)

Definition at line 31 of file modGeneratePassStandard.class.php.

Constructor & Destructor Documentation

◆ __construct()

modGeneratePassStandard::__construct (   $db,
  $conf,
  $langs,
  $user 
)

Constructor.

Parameters
DoliDB$dbDatabase handler
Conf$confHandler de conf
Translate$langsHandler de langue
User$userHandler du user connecte

Definition at line 72 of file modGeneratePassStandard.class.php.

Member Function Documentation

◆ getDescription()

modGeneratePassStandard::getDescription ( )

Return description of module.

Returns
string Description of module

Reimplemented from ModeleGenPassword.

Definition at line 89 of file modGeneratePassStandard.class.php.

◆ getExample()

modGeneratePassStandard::getExample ( )

Return an example of password generated by this module.

Returns
string Example of password

Reimplemented from ModeleGenPassword.

Definition at line 100 of file modGeneratePassStandard.class.php.

References getNewGeneratedPassword().

◆ getNewGeneratedPassword()

modGeneratePassStandard::getNewGeneratedPassword ( )

Build new password.

Returns
string Return a new generated password

Reimplemented from ModeleGenPassword.

Definition at line 110 of file modGeneratePassStandard.class.php.

Referenced by getExample().

◆ validatePassword()

modGeneratePassStandard::validatePassword (   $password)

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

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

Reimplemented from ModeleGenPassword.

Definition at line 147 of file modGeneratePassStandard.class.php.


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