ModeleCaptcha Class Reference

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

Inheritance diagram for ModeleCaptcha:

Public Member Functions
	isEnabled ()
	Return if a module can be used or not.
	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.

Detailed Description

Parent class for password rules/management modules.

Definition at line 32 of file modules_captcha.php.

Member Function Documentation

getCaptchaCodeForForm()

ModeleCaptcha::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 in modCaptchaStandard.

Definition at line 115 of file modules_captcha.php.

getDescription()

ModeleCaptcha::getDescription

(

)

Return description of module.

Returns

string Description of module

Reimplemented in modCaptchaStandard.

Definition at line 91 of file modules_captcha.php.

getExample()

ModeleCaptcha::getExample

(

)

Return an example of password generated by this module.

Returns

string Example of captcha

Reimplemented in modCaptchaStandard.

Definition at line 102 of file modules_captcha.php.

isEnabled()

ModeleCaptcha::isEnabled

(

)

Return if a module can be used or not.

Returns

boolean true if module can be used

Definition at line 80 of file modules_captcha.php.

validateCodeAfterLoginSubmit()

ModeleCaptcha::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 in modCaptchaStandard.

Definition at line 126 of file modules_captcha.php.

---

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

• dolibarr_dev/htdocs/core/modules/security/captcha/modules_captcha.php