[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   *
   4   * This file is part of the phpBB Forum Software package.
   5   *
   6   * @copyright (c) phpBB Limited <https://www.phpbb.com>
   7   * @license GNU General Public License, version 2 (GPL-2.0)
   8   *
   9   * For full copyright and license information, please see
  10   * the docs/CREDITS.txt file.
  11   *
  12   */
  13  
  14  namespace phpbb\report;
  15  
  16  interface report_handler_interface
  17  {
  18      /**
  19       * Reports a message
  20       *
  21       * @param int        $id
  22       * @param int        $reason_id
  23       * @param string    $report_text
  24       * @param int        $user_notify
  25       * @return null
  26       * @throws \phpbb\report\exception\empty_report_exception        when the given report is empty
  27       * @throws \phpbb\report\exception\already_reported_exception    when the entity is already reported
  28       * @throws \phpbb\report\exception\entity_not_found_exception    when the entity does not exist or the user does not have viewing permissions for it
  29       * @throws \phpbb\report\exception\invalid_report_exception        when the entity cannot be reported for some other reason
  30       */
  31  	public function add_report($id, $reason_id, $report_text, $user_notify);
  32  
  33      /**
  34       * Checks if the message is reportable
  35       *
  36       * @param int    $id
  37       * @return null
  38       * @throws \phpbb\report\exception\already_reported_exception    when the entity is already reported
  39       * @throws \phpbb\report\exception\entity_not_found_exception    when the entity does not exist or the user does not have viewing permissions for it
  40       * @throws \phpbb\report\exception\invalid_report_exception        when the entity cannot be reported for some other reason
  41       */
  42  	public function validate_report_request($id);
  43  }