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.
	getFieldInputTitle ()
	Return description of module.

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	$db	Database handler
Conf	$conf	Handler de conf
Translate	$langs	Handler de langue
User	$user	Handler du user connected

Definition at line 60 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_self

An URL for the a href link

Returns

string The HTML code to output

Reimplemented from ModeleCaptcha.

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

References dol_escape_js(), and img_picto().

getDescription()

modCaptchaStandard::getDescription

(

)

Return description of module.

Returns

string Description of module

Reimplemented from ModeleCaptcha.

Definition at line 75 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 86 of file modCaptchaStandard.class.php.

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 183 of file modCaptchaStandard.class.php.

---

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

• dolibarr_23.0/htdocs/core/modules/security/captcha/modCaptchaStandard.class.php