class report

Properties

protected config $config
protected user $user
protected template $template
protected helper $helper
protected request_interface $request
protected factory $captcha_factory
protected string $phpbb_root_path
protected string $php_ext
protected handler_factory $report_factory
protected report_handler_interface $report_handler
protected report_reason_list_provider $report_reason_provider

Methods

__construct(config $config, user $user, template $template, helper $helper, request_interface $request, factory $captcha_factory, handler_factory $report_factory, report_reason_list_provider $ui_provider, $phpbb_root_path, $php_ext)

No description

Response
handle(int $id, string $mode)

Controller for /path_to_entities/{id}/report routes

void
assign_template_data(string $mode, int $id, int $reason_id, string $report_text, mixed $user_notify, array $error = array(), string $s_hidden_fields = '', mixed $captcha = false)

Assigns template variables

array
check_captcha(plugin_interface $captcha)

Check CAPTCHA

Details

at line 77
__construct(config $config, user $user, template $template, helper $helper, request_interface $request, factory $captcha_factory, handler_factory $report_factory, report_reason_list_provider $ui_provider, $phpbb_root_path, $php_ext)

No description

Parameters

config $config
user $user
template $template
helper $helper
request_interface $request
factory $captcha_factory
handler_factory $report_factory
report_reason_list_provider $ui_provider
$phpbb_root_path
$php_ext

at line 103
Response handle(int $id, string $mode)

Controller for /path_to_entities/{id}/report routes

Because of how phpBB organizes routes $mode must be set in the route config.

Parameters

int $id

ID of the entity to report

string $mode

Return Value

Response

a Symfony response object

Exceptions

http_exception

at line 265
protected void assign_template_data(string $mode, int $id, int $reason_id, string $report_text, mixed $user_notify, array $error = array(), string $s_hidden_fields = '', mixed $captcha = false)

Assigns template variables

Parameters

string $mode
int $id
int $reason_id
string $report_text
mixed $user_notify
array $error
string $s_hidden_fields
mixed $captcha

Return Value

void

at line 306
protected array check_captcha(plugin_interface $captcha)

Check CAPTCHA

Parameters

plugin_interface $captcha

A phpBB CAPTCHA object

Return Value

array

template variables which ensures that CAPTCHA's work correctly