dolibarr 21.0.0-beta
modCaptchaStandard Class Reference

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

Inheritance diagram for modCaptchaStandard:
Collaboration diagram for modCaptchaStandard:

Public Member Functions

 __construct ($db, $conf, $langs, $user)
 Constructor.
 
 getDescription ()
 Return description of module.
 
 getExample ()
 Return an example of password generated by this module.
 
 getCaptchaCodeForForm ($php_self='')
 Return the HTML content to output on a form that need the captcha.
 
 validateCodeAfterLoginSubmit ()
 Validate a captcha This function is called after a log to validate a captcha, before validating a password.
 
- Public Member Functions inherited from ModeleCaptcha
 isEnabled ()
 Return if a module can be used or not.
 

Detailed Description

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

Definition at line 34 of file modCaptchaStandard.class.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

Definition at line 54 of file modCaptchaStandard.class.php.

References conf(), and user.

Member Function Documentation

◆ getCaptchaCodeForForm()

modCaptchaStandard::getCaptchaCodeForForm ( $php_self = '')

Return the HTML content to output on a form that need the captcha.

Parameters
string$php_selfAn URL for the a href link
Returns
string The HTML code to output

Reimplemented from ModeleCaptcha.

Definition at line 108 of file modCaptchaStandard.class.php.

References img_picto().

◆ getDescription()

modCaptchaStandard::getDescription ( )

Return description of module.

Returns
string Description of module

Reimplemented from ModeleCaptcha.

Definition at line 69 of file modCaptchaStandard.class.php.

◆ getExample()

modCaptchaStandard::getExample ( )

Return an example of password generated by this module.

Returns
string Example of password

Reimplemented from ModeleCaptcha.

Definition at line 80 of file modCaptchaStandard.class.php.

References $conf.

◆ validateCodeAfterLoginSubmit()

modCaptchaStandard::validateCodeAfterLoginSubmit ( )

Validate a captcha This function is called after a log to validate a captcha, before validating a password.

Returns
int 0 if KO, >0 if OK

Reimplemented from ModeleCaptcha.

Definition at line 163 of file modCaptchaStandard.class.php.

References GETPOST().


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