reCaptcha
extends _zp_captcha
in package
Standins for when no captcha is enabled
Table of Contents
Properties
- $name : mixed
Methods
- __construct() : captcha
- Class instantiator
- checkCaptcha() : bool
- Called by form (wherever reCaptcha is enabled) on submit to check whether or not the capture has succeeded. $s1, $s2 are required.
- getCaptcha() : type
- Called by form (wherever reCaptcha is enabled) to add reCaptcha widget
- getCaptchaHTML() : type
- Returns HTML for reCaptcha (including required reCaptcha script)
- getOptionsSupported() : array<string|int, mixed>
- Returns array of supported options for the admin-options handler
Properties
$name
public
mixed
$name
= 'reCaptcha'
Methods
__construct()
Class instantiator
public
__construct() : captcha
Return values
captchacheckCaptcha()
Called by form (wherever reCaptcha is enabled) on submit to check whether or not the capture has succeeded. $s1, $s2 are required.
public
checkCaptcha(type $s1, type $s2) : bool
Parameters
- $s1 : type
-
Not used
- $s2 : type
-
Not used
Return values
boolgetCaptcha()
Called by form (wherever reCaptcha is enabled) to add reCaptcha widget
public
getCaptcha(type $prompt) : type
Parameters
- $prompt : type
Return values
typegetCaptchaHTML()
Returns HTML for reCaptcha (including required reCaptcha script)
public
getCaptchaHTML(string $publicKey, string $theme, string $type, string $size) : type
Parameters
- $publicKey : string
-
The public key
- $theme : string
-
The theme to use "light" or "dark"
- $type : string
-
Type to use "audio" or "image"
- $size : string
-
Size to use "normal" or "compact"
Return values
typegetOptionsSupported()
Returns array of supported options for the admin-options handler
public
getOptionsSupported() : array<string|int, mixed>