[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\notification\method;
  15  
  16  /**
  17  * Base notifications method interface
  18  */
  19  interface method_interface
  20  {
  21      /**
  22      * Get notification method name
  23      *
  24      * @return string
  25      */
  26  	public function get_type();
  27  
  28      /**
  29      * Is this method available for the user?
  30      * This is checked on the notifications options
  31      */
  32  	public function is_available();
  33  
  34      /**
  35      * Add a notification to the queue
  36      *
  37      * @param \phpbb\notification\type\type_interface $notification
  38      */
  39  	public function add_to_queue(\phpbb\notification\type\type_interface $notification);
  40  
  41      /**
  42      * Parse the queue and notify the users
  43      */
  44  	public function notify();
  45  }