phpBB API Documentation
Interface

phpbb\report\report_handler_interface

interface report_handler_interface

Methods

null add_report(int $id, int $reason_id, string $report_text, int $user_notify)

Reports a message

null validate_report_request(int $id)

Checks if the message is reportable

Details

at line 31
public null add_report(int $id, int $reason_id, string $report_text, int $user_notify)

Reports a message

Parameters

int $id
int $reason_id
string $report_text
int $user_notify

Return Value

null

Exceptions

empty_report_exception when the given report is empty
already_reported_exception when the entity is already reported
entity_not_found_exception when the entity does not exist or the user does not have viewing permissions for it
invalid_report_exception when the entity cannot be reported for some other reason

at line 42
public null validate_report_request(int $id)

Checks if the message is reportable

Parameters

int $id

Return Value

null

Exceptions

already_reported_exception when the entity is already reported
entity_not_found_exception when the entity does not exist or the user does not have viewing permissions for it
invalid_report_exception when the entity cannot be reported for some other reason