git.stricted.de - GitHub/WoltLab/WCF.git/blob

   1 <?php
   2 namespace wcf\system\user\notification\event;
   3 use wcf\data\user\notification\type;
   4
   5 /**
   6  * This interface should be implemented by every event which is fired by the notification system.
   7  *
   8  * @author      Marcel Werk, Oliver Kliebisch
   9  * @copyright   2001-2011 WoltLab GmbH, Oliver Kliebisch
  10  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  11  * @package     com.woltlab.wcf.notification
  12  * @subpackage  system.user.notification.event
  13  * @category    Community Framework
  14  */
  15 interface UserNotificationEvent {
  16         /**
  17          * Returns the message for this notification event.
  18          *
  19          * @param       wcf\data\user\notification\type\UserNotificationType    $notificationType
  20          * @return      string
  21          */
  22         public function getMessage(UserNotificationType $notificationType);
  23
  24         /**
  25          * Returns the short output for this notification event.
  26          *
  27          * @return      string
  28          */
  29         public function getShortOutput();
  30
  31         /**
  32          * Returns the medium output for this notification event.
  33          *
  34          * @return      string
  35          */
  36         public function getMediumOutput();
  37
  38         /**
  39          * Returns the full output for this notification event.
  40          *
  41          * @return      string
  42          */
  43         public function getOutput();
  44
  45         /**
  46          * Returns the human-readable title of this event.
  47          *
  48          * @return      string
  49          */
  50         public function getTitle();
  51
  52         /**
  53          * Returns the human-readable description of this event.
  54          *
  55          * @return      string
  56          */
  57         public function getDescription();
  58
  59         /**
  60          * Returns true if this event supports the given notification type.
  61          *
  62          * @param       wcf\data\user\notification\type\UserNotificationType    $notificationType
  63          * @return      boolean
  64          */
  65         public function supportsNotificationType(UserNotificationType $notificationType);
  66 }