ReCaptcha
extends AbstractBase
in package
ReCaptcha CAPTCHA.
Tags
Table of Contents
- $language : string
- Language
- $recaptcha : ReCaptcha
- ReCaptcha Service.
- __construct() : mixed
- Constructor
- getErrorMessage() : string
- Get any error message after a failed captcha verification. The message can be displayed to the user.
- getHtml() : string
- Generate HTML depending on CAPTCHA type.
- getId() : string
- Get ID for current CAPTCHA (to use e.g. in HTML forms)
- getJsIncludes() : array<string|int, mixed>
- Get list of URLs with JS dependencies to load for the active CAPTCHA type.
- verify() : bool
- Pull the captcha field from controller params and check them for accuracy
Properties
$language
Language
protected
string
$language
$recaptcha
ReCaptcha Service.
protected
ReCaptcha
$recaptcha
Methods
__construct()
Constructor
public
__construct(ReCaptcha $recaptcha, string $language) : mixed
Parameters
- $recaptcha : ReCaptcha
-
ReCaptcha Service
- $language : string
-
Translator locale
Return values
mixed —getErrorMessage()
Get any error message after a failed captcha verification. The message can be displayed to the user.
public
getErrorMessage() : string
Return values
string —getHtml()
Generate HTML depending on CAPTCHA type.
public
getHtml() : string
Return values
string —getId()
Get ID for current CAPTCHA (to use e.g. in HTML forms)
public
getId() : string
Return values
string —getJsIncludes()
Get list of URLs with JS dependencies to load for the active CAPTCHA type.
public
getJsIncludes() : array<string|int, mixed>
Return values
array<string|int, mixed> —verify()
Pull the captcha field from controller params and check them for accuracy
public
verify(Params $params) : bool
Parameters
- $params : Params
-
Controller params