phpBB/phpbb/report/report_handler_interface.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

<?php
/**
 *
 * This file is part of the phpBB Forum Software package.
 *
 * @copyright (c) phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 * For full copyright and license information, please see
 * the docs/CREDITS.txt file.
 *
 */

namespace phpbb\report;

interface report_handler_interface
{
	/**
	 * Reports a message
	 *
	 * @param int		$id
	 * @param int		$reason_id
	 * @param string	$report_text
	 * @param int		$user_notify
	 * @return null
	 * @throws \phpbb\report\exception\empty_report_exception		when the given report is empty
	 * @throws \phpbb\report\exception\already_reported_exception	when the entity is already reported
	 * @throws \phpbb\report\exception\entity_not_found_exception	when the entity does not exist or the user does not have viewing permissions for it
	 * @throws \phpbb\report\exception\invalid_report_exception		when the entity cannot be reported for some other reason
	 */
	public function add_report($id, $reason_id, $report_text, $user_notify);

	/**
	 * Checks if the message is reportable
	 *
	 * @param int	$id
	 * @return null
	 * @throws \phpbb\report\exception\already_reported_exception	when the entity is already reported
	 * @throws \phpbb\report\exception\entity_not_found_exception	when the entity does not exist or the user does not have viewing permissions for it
	 * @throws \phpbb\report\exception\invalid_report_exception		when the entity cannot be reported for some other reason
	 */
	public function validate_report_request($id);
}