diff options
Diffstat (limited to 'phpBB/phpbb/notification/method/method_interface.php')
-rw-r--r-- | phpBB/phpbb/notification/method/method_interface.php | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/phpBB/phpbb/notification/method/method_interface.php b/phpBB/phpbb/notification/method/method_interface.php new file mode 100644 index 0000000000..76b0de179c --- /dev/null +++ b/phpBB/phpbb/notification/method/method_interface.php @@ -0,0 +1,45 @@ +<?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\notification\method; + +/** +* Base notifications method interface +*/ +interface method_interface +{ + /** + * Get notification method name + * + * @return string + */ + public function get_type(); + + /** + * Is this method available for the user? + * This is checked on the notifications options + */ + public function is_available(); + + /** + * Add a notification to the queue + * + * @param \phpbb\notification\type\type_interface $notification + */ + public function add_to_queue(\phpbb\notification\type\type_interface $notification); + + /** + * Parse the queue and notify the users + */ + public function notify(); +} |