phpBB API Documentation
Class

phpbb\captcha\plugins\recaptcha

class recaptcha extends captcha_abstract

Properties

$confirm_id
$confirm_code
$code
$seed
$attempts
$type
$solved
$captcha_vars
$recaptcha_server
$recaptcha_server_secure
$response

Methods

init($type)

execute_demo()

execute()

get_template()

get_demo_template($id)

get_hidden_fields()

garbage_collect($type)

from captcha_abstract
uninstall()

install()

validate()

generate_code()

The old way to generate code, suitable for GD and non-GD.

from captcha_abstract
regenerate_code()

New Question, if desired.

from captcha_abstract
new_attempt()

New Question, if desired.

from captcha_abstract
load_code()

Look up everything we need for painting&checking.

from captcha_abstract
check_code()

from captcha_abstract
get_attempt_count()

from captcha_abstract
reset()

from captcha_abstract
is_solved()

from captcha_abstract
has_config()

API function

string get_service_name()

from captcha_abstract
set_name(string $name)

Set the name of the plugin

from captcha_abstract
__construct()

Constructor

is_available()

static  get_name()

get_generator_class()

This function is implemented because required by the upper class, but is never used for reCaptcha.

acp_page($id, $module)

bool|string recaptcha_check_answer()

Calls an HTTP POST function to verify if the user's guess was correct

Details

at line 32
public init($type)

Parameters

$type

at line 122
public execute_demo()

at line 127
public execute()

at line 131
public get_template()

at line 157
public get_demo_template($id)

Parameters

$id

at line 162
public get_hidden_fields()

in captcha_abstract at line 152
public garbage_collect($type)

Parameters

$type

at line 175
public uninstall()

at line 180
public install()

at line 185
public validate()

in captcha_abstract at line 233
public generate_code()

The old way to generate code, suitable for GD and non-GD.

Resets the internal state.

in captcha_abstract at line 257
public regenerate_code()

New Question, if desired.

in captcha_abstract at line 279
public new_attempt()

New Question, if desired.

in captcha_abstract at line 302
public load_code()

Look up everything we need for painting&checking.

in captcha_abstract at line 326
public check_code()

in captcha_abstract at line 331
public get_attempt_count()

in captcha_abstract at line 336
public reset()

in captcha_abstract at line 349
public is_solved()

at line 51
public has_config()

API function

in captcha_abstract at line 371
public string get_service_name()

Return Value

string the name of the service corresponding to the plugin

in captcha_abstract at line 381
public set_name(string $name)

Set the name of the plugin

Parameters

string $name

at line 26
public __construct()

Constructor

at line 41
public is_available()

at line 56
static public get_name()

at line 64
public get_generator_class()

This function is implemented because required by the upper class, but is never used for reCaptcha.

at line 69
public acp_page($id, $module)

Parameters

$id
$module

at line 202
public bool|string recaptcha_check_answer()

Calls an HTTP POST function to verify if the user's guess was correct

Return Value

bool|string Returns false on success or error string on failure.