aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/report/report_handler_interface.php
diff options
context:
space:
mode:
authorMateBartus <mate.bartus@gmail.com>2015-02-25 21:13:20 +0100
committerMateBartus <mate.bartus@gmail.com>2015-04-16 11:29:11 +0200
commita089ff5eb0dcdab83c6c2e64cb0e7cb618aec41f (patch)
tree1891a57f125191ae30e8ffe94b1ecd0d97aabce9 /phpBB/phpbb/report/report_handler_interface.php
parent2c0b1252c8ee7f9c40f15587aa00aa2e70a7168f (diff)
downloadforums-a089ff5eb0dcdab83c6c2e64cb0e7cb618aec41f.tar
forums-a089ff5eb0dcdab83c6c2e64cb0e7cb618aec41f.tar.gz
forums-a089ff5eb0dcdab83c6c2e64cb0e7cb618aec41f.tar.bz2
forums-a089ff5eb0dcdab83c6c2e64cb0e7cb618aec41f.tar.xz
forums-a089ff5eb0dcdab83c6c2e64cb0e7cb618aec41f.zip
[ticket/13654] Moving reporting into controller
Moving report.php's content into different services and controllers to better comply with the MVC model. Also implementing: * Replacement for reasons_display() * Adding assign_meta_refresh_var() to \controller\helper * Adding separate routes for easy configuration * Updating unit tests to expect to correct results * Add BC tests PHPBB3-13654
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);
+}