aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/report/report_handler_interface.php
diff options
context:
space:
mode:
authorjaviexin <javiexin@gmail.com>2017-03-09 16:12:25 +0100
committerGitHub <noreply@github.com>2017-03-09 16:12:25 +0100
commitbd12504f6cf03b36821a5cea2bf77a419496dcdb (patch)
treed30cc3506e1bbdc284dc7cca910c5dac6b927ae0 /phpBB/phpbb/report/report_handler_interface.php
parent96a90d3f81c1fcce3834ee72b7d1b9f76aa9354c (diff)
parent3e9f12d12d7dbdd2cee39425e81b5fdf66fcfbc8 (diff)
downloadforums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.tar
forums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.tar.gz
forums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.tar.bz2
forums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.tar.xz
forums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.zip
Merge branch '3.2.x' into ticket/15068
Diffstat (limited to 'phpBB/phpbb/report/report_handler_interface.php')
-rw-r--r--phpBB/phpbb/report/report_handler_interface.php43
1 files changed, 43 insertions, 0 deletions
diff --git a/phpBB/phpbb/report/report_handler_interface.php b/phpBB/phpbb/report/report_handler_interface.php
new file mode 100644
index 0000000000..8dafc392d0
--- /dev/null
+++ b/phpBB/phpbb/report/report_handler_interface.php
@@ -0,0 +1,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);
+}