diff options
| author | Nathan Guse <nathaniel.guse@gmail.com> | 2012-10-18 19:13:47 -0500 |
|---|---|---|
| committer | Nathan Guse <nathaniel.guse@gmail.com> | 2012-10-18 19:13:47 -0500 |
| commit | f96dac335287f2fd51ff6628facbc8b6af6a517f (patch) | |
| tree | 5b46c163e91fe09df0d61996ee8d93cd5bf274ea /phpBB/includes/notification/method/interface.php | |
| parent | eb07b3ad9cfb37fd2943088170e380bff2db94a3 (diff) | |
| download | forums-f96dac335287f2fd51ff6628facbc8b6af6a517f.tar forums-f96dac335287f2fd51ff6628facbc8b6af6a517f.tar.gz forums-f96dac335287f2fd51ff6628facbc8b6af6a517f.tar.bz2 forums-f96dac335287f2fd51ff6628facbc8b6af6a517f.tar.xz forums-f96dac335287f2fd51ff6628facbc8b6af6a517f.zip | |
[ticket/11103] Interface docblocks
PHPBB3-11103
Diffstat (limited to 'phpBB/includes/notification/method/interface.php')
| -rw-r--r-- | phpBB/includes/notification/method/interface.php | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/phpBB/includes/notification/method/interface.php b/phpBB/includes/notification/method/interface.php index 4b990ec9fa..f5c210a2fc 100644 --- a/phpBB/includes/notification/method/interface.php +++ b/phpBB/includes/notification/method/interface.php @@ -21,7 +21,26 @@ if (!defined('IN_PHPBB')) */ interface phpbb_notification_method_interface { + /** + * 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_interface $notification + */ + public function add_to_queue(phpbb_notification_type_interface $notification); + + /** + * Empty the queue + */ + protected function empty_queue(); + + /** + * Parse the queue and notify the users + */ public function notify(); } |