class incomplete extends base

Properties

protected config $config from  base
protected driver_interface $db from  base
protected language $language from  base
protected request_interface $request from  base
protected user $user from  base
protected int $attempts from  base
protected string $code from  base
protected bool $solved from  base
protected string $confirm_code from  base
protected string $confirm_id from  base
protected confirm_type $type from  base
protected string $last_error from  base

Methods

__construct(config $config, driver_interface $db, language $language, request_interface $request, template $template, user $user, string $phpbb_root_path, string $phpEx)

Constructor for incomplete captcha

void
init(confirm_type $type)

Display the captcha for the specified type

bool
validate()

Validate the captcha with the given request data

void
reset()

Reset captcha state, e.g. after checking if it's valid

from  base
int
get_attempt_count()

Get attempt count for this captcha and user

bool
load_confirm_data()

Look up attempts from confirm table

from  base
void
generate_confirm_data()

Generate confirm data for tracking attempts

from  base
void
increment_attempts()

Increment number of attempts for confirm ID and session

from  base
array
get_hidden_fields()

Get hidden form fields for this captcha plugin

from  base
bool
is_solved()

Return whether captcha was solved

string
get_error()

Get error string from captcha

void
garbage_collect(confirm_type $confirm_type = confirm_type::UNDEFINED)

No description

from  base
void
acp_page(mixed $id, mixed $module)

Display acp page

from  base
bool
is_available()

Check if the plugin is available

bool
has_config()

Check if the plugin has a configuration

string
get_name()

Get the name of the plugin, should be language variable

void
set_name(string $name)

Set the service name of the plugin

string
get_demo_template()

Get template filename for demo

string
get_template()

Get template filename for captcha

Details

at line 37
__construct(config $config, driver_interface $db, language $language, request_interface $request, template $template, user $user, string $phpbb_root_path, string $phpEx)

Constructor for incomplete captcha

Parameters

config $config
driver_interface $db
language $language
request_interface $request
template $template
user $user
string $phpbb_root_path
string $phpEx

at line 77
void init(confirm_type $type)

Display the captcha for the specified type

Parameters

confirm_type $type

Type of captcha, should be one of the CONFIRMATION_* constants

Return Value

void

at line 107
bool validate()

Validate the captcha with the given request data

Return Value

bool

True if request data was valid captcha reply, false if not

in base at line 113
void reset()

Reset captcha state, e.g. after checking if it's valid

Return Value

void

at line 131
int get_attempt_count()

Get attempt count for this captcha and user

Return Value

int

Number of attempts

in base at line 134
protected bool load_confirm_data()

Look up attempts from confirm table

Return Value

bool

in base at line 161
protected void generate_confirm_data()

Generate confirm data for tracking attempts

Return Value

void

in base at line 181
protected void increment_attempts()

Increment number of attempts for confirm ID and session

Return Value

void

in base at line 195
array get_hidden_fields()

Get hidden form fields for this captcha plugin

Return Value

array

Hidden form fields

at line 123
bool is_solved()

Return whether captcha was solved

Return Value

bool

True if captcha was solved, false if not

at line 115
string get_error()

Get error string from captcha

Return Value

string

Error string, empty string if there is no error

in base at line 222
void garbage_collect(confirm_type $confirm_type = confirm_type::UNDEFINED)

No description

Parameters

confirm_type $confirm_type

Confirm type to garbage collect, defaults to all (0)

Return Value

void

in base at line 253
void acp_page(mixed $id, mixed $module)

Display acp page

Parameters

mixed $id

ACP module id

mixed $module

ACP module name

Return Value

void

at line 46
bool is_available()

Check if the plugin is available

Return Value

bool

True if the plugin is available, false if not

at line 54
bool has_config()

Check if the plugin has a configuration

Return Value

bool

True if the plugin has a configuration, false if not

at line 62
string get_name()

Get the name of the plugin, should be language variable

Return Value

string

at line 70
void set_name(string $name)

Set the service name of the plugin

Parameters

string $name

Return Value

void

at line 84
string get_demo_template()

Get template filename for demo

Return Value

string

Demo template file name

at line 92
string get_template()

Get template filename for captcha

Return Value

string

Template file name