4be21ae434079c49e6014c16445337e7aa5b2c50
[GitHub/WoltLab/WCF.git] /
1 <?php
2 namespace wcf\system\user\notification\object\type;
3 use wcf\data\comment\Comment;
4
5 /**
6 * Default interface for comment user notification object types with notifications
7 * being sent to multiple recipients.
8 *
9 * This interface can also be implemented by user notification object types for
10 * comment responses. In this case, there is no distinction between commentResponse
11 * and commentResponseOwner event and only a commentResponse event is fired.
12 *
13 * Since version 3.2 it is possible to send an `commentResponseOwner` notification
14 * even if you implement this interface. Simple add the interface
15 * `IMultiRecipientCommentResponseOwnerUserNotificationObjectType`, too.
16 *
17 * @author Matthias Schmidt
18 * @copyright 2001-2018 WoltLab GmbH
19 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
20 * @package WoltLabSuite\Core\System\User\Notification\Object\Type
21 * @since 3.0
22 */
23 interface IMultiRecipientCommentUserNotificationObjectType {
24 /**
25 * Returns the user ids of the notification recipients. If an empty array
26 * is returned, no notifications should be sent.
27 *
28 * @param Comment $comment
29 * @return integer[]
30 */
31 public function getRecipientIDs(Comment $comment);
32 }