wcfsetup/install/files/lib/system/user/notification/event/TTestableUserNotificationEvent.class.php

   1 <?php
   2 namespace wcf\system\user\notification\event;
   3 use wcf\system\user\notification\object\IUserNotificationObject;
   4
   5 /**
   6  * Default implementation of some methods of the testable user notification event interface.
   7  *
   8  * @author      Matthias Schmidt
   9  * @copyright   2001-2017 WoltLab GmbH
  10  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  11  * @package     WoltLabSuite\Core\System\User\Notification\Event
  12  * @since       3.1
  13  */
  14 trait TTestableUserNotificationEvent {
  15         /**
  16          * description of the specfic test case
  17          * @var string
  18          */
  19         protected $testCaseDescription = '';
  20
  21         /**
  22          * @see ITestableUserNotificationEvent::canBeTriggeredByGuests()
  23          */
  24         public static function canBeTriggeredByGuests() {
  25                 return false;
  26         }
  27
  28         /**
  29          * @see ITestableUserNotificationEvent::getTestCaseDescription()
  30          */
  31         public function getTestCaseDescription() {
  32                 return $this->testCaseDescription;
  33         }
  34
  35         /**
  36          * @see ITestableUserNotificationEvent::setTestCaseDescription()
  37          */
  38         public function setTestCaseDescription($description) {
  39                 $this->testCaseDescription = $description;
  40         }
  41
  42         /**
  43          * @see ITestableUserNotificationEvent::getTestAdditionalData()
  44          */
  45         public static function getTestAdditionalData(IUserNotificationObject $object) {
  46                 return [];
  47         }
  48 }