classes/article/log/ArticleEmailLogEntry.inc.php

<?php

// $Id: ArticleEmailLogEntry.inc.php,v 1.23 2008/07/01 01:16:09 asmecher Exp $


// Email associative types. All types must be defined here
define('ARTICLE_EMAIL_TYPE_DEFAULT',      0);
define('ARTICLE_EMAIL_TYPE_AUTHOR',       0x01);
define('ARTICLE_EMAIL_TYPE_EDITOR',       0x02);
define('ARTICLE_EMAIL_TYPE_REVIEW',       0x03);
define('ARTICLE_EMAIL_TYPE_COPYEDIT',     0x04);
define('ARTICLE_EMAIL_TYPE_LAYOUT',       0x05);
define('ARTICLE_EMAIL_TYPE_PROOFREAD',       0x06);

// General events             0x10000000

// Author events           0x20000000

// Editor events           0x30000000
define('ARTICLE_EMAIL_EDITOR_NOTIFY_AUTHOR',       0x30000001);
define('ARTICLE_EMAIL_EDITOR_ASSIGN',     0x30000002);
define('ARTICLE_EMAIL_EDITOR_NOTIFY_AUTHOR_UNSUITABLE',  0x30000003);

// Reviewer events            0x40000000
define('ARTICLE_EMAIL_REVIEW_NOTIFY_REVIEWER',     0x40000001);
define('ARTICLE_EMAIL_REVIEW_THANK_REVIEWER',      0x40000002);
define('ARTICLE_EMAIL_REVIEW_CANCEL',     0x40000003);
define('ARTICLE_EMAIL_REVIEW_REMIND',     0x40000004);
define('ARTICLE_EMAIL_REVIEW_CONFIRM',    0x40000005);
define('ARTICLE_EMAIL_REVIEW_DECLINE',    0x40000006);
define('ARTICLE_EMAIL_REVIEW_COMPLETE',      0x40000007);
define('ARTICLE_EMAIL_REVIEW_CONFIRM_ACK',   0x40000008);

// Copyeditor events          0x50000000
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_COPYEDITOR',       0x50000001);
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_AUTHOR',        0x50000002);
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_FINAL',         0x50000003);
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_COMPLETE',      0x50000004);
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_AUTHOR_COMPLETE', 0x50000005);
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_FINAL_COMPLETE',   0x50000006);
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_ACKNOWLEDGE',   0x50000007);
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_AUTHOR_ACKNOWLEDGE',  0x50000008);
define('ARTICLE_EMAIL_COPYEDIT_NOTIFY_FINAL_ACKNOWLEDGE',   0x50000009);

// Proofreader events         0x60000000
define('ARTICLE_EMAIL_PROOFREAD_NOTIFY_AUTHOR',             0x60000001);
define('ARTICLE_EMAIL_PROOFREAD_NOTIFY_AUTHOR_COMPLETE',       0x60000002);
define('ARTICLE_EMAIL_PROOFREAD_THANK_AUTHOR',              0x60000003);
define('ARTICLE_EMAIL_PROOFREAD_NOTIFY_PROOFREADER',        0x60000004);
define('ARTICLE_EMAIL_PROOFREAD_NOTIFY_PROOFREADER_COMPLETE',  0x60000005);
define('ARTICLE_EMAIL_PROOFREAD_THANK_PROOFREADER',            0x60000006);
define('ARTICLE_EMAIL_PROOFREAD_NOTIFY_LAYOUTEDITOR',       0x60000007);
define('ARTICLE_EMAIL_PROOFREAD_NOTIFY_LAYOUTEDITOR_COMPLETE',    0x60000008);
define('ARTICLE_EMAIL_PROOFREAD_THANK_LAYOUTEDITOR',        0x60000009);

// Layout events           0x70000000
define('ARTICLE_EMAIL_LAYOUT_NOTIFY_EDITOR',       0x70000001);
define('ARTICLE_EMAIL_LAYOUT_THANK_EDITOR',     0x70000002);
define('ARTICLE_EMAIL_LAYOUT_NOTIFY_COMPLETE',     0x70000003);

class ArticleEmailLogEntry extends DataObject {

   function ArticleEmailLogEntry() {
      parent::DataObject();
   }

   //
   // Get/set methods
   //

   function getLogId() {
      return $this->getData('logId');
   }

   function setLogId($logId) {
      return $this->setData('logId', $logId);
   }

   function getArticleId() {
      return $this->getData('articleId');
   }

   function setArticleId($articleId) {
      return $this->setData('articleId', $articleId);
   }

   function getSenderId() {
      return $this->getData('senderId');
   }

   function setSenderId($senderId) {
      return $this->setData('senderId', $senderId);
   }

   function getDateSent() {
      return $this->getData('dateSent');
   }

   function setDateSent($dateSent) {
      return $this->setData('dateSent', $dateSent);
   }

   function getIPAddress() {
      return $this->getData('ipAddress');
   }

   function setIPAddress($ipAddress) {
      return $this->setData('ipAddress', $ipAddress);
   }

   function getEventType() {
      return $this->getData('eventType');
   }

   function setEventType($eventType) {
      return $this->setData('eventType', $eventType);
   }

   function getAssocType() {
      return $this->getData('assocType');
   }

   function setAssocType($assocType) {
      return $this->setData('assocType', $assocType);
   }

   function getAssocId() {
      return $this->getData('assocId');
   }

   function setAssocId($assocId) {
      return $this->setData('assocId', $assocId);
   }

   function getSenderFullName() {
      $senderFullName =& $this->getData('senderFullName');

      if(!isset($senderFullName)) {
         $userDao = &DAORegistry::getDAO('UserDAO');
         $senderFullName = $userDao->getUserFullName($this->getSenderId(), true);
      }

      return $senderFullName ? $senderFullName : '';
   }

   function getSenderEmail() {
      $senderEmail =& $this->getData('senderEmail');

      if(!isset($senderEmail)) {
         $userDao = &DAORegistry::getDAO('UserDAO');
         $senderEmail = $userDao->getUserEmail($this->getSenderId(), true);
      }

      return $senderEmail ? $senderEmail : '';
   }

   function getAssocTypeString() {
      switch ($this->getData('assocType')) {
         case ARTICLE_LOG_TYPE_AUTHOR:
            return 'AUT';
         case ARTICLE_LOG_TYPE_EDITOR:
            return 'EDR';
         case ARTICLE_LOG_TYPE_REVIEW:
            return 'REV';
         case ARTICLE_LOG_TYPE_COPYEDIT:
            return 'CPY';
         case ARTICLE_LOG_TYPE_LAYOUT:
            return 'LYT';
         case ARTICLE_LOG_TYPE_PROOFREAD:
            return 'PRF';
         default:
            return 'ART';
      }
   }

   function getAssocTypeLongString() {
      switch ($this->getData('assocType')) {
         case ARTICLE_LOG_TYPE_AUTHOR:
            return 'submission.logType.author';
         case ARTICLE_LOG_TYPE_EDITOR:
            return 'submission.logType.editor';
         case ARTICLE_LOG_TYPE_REVIEW:
            return 'submission.logType.review';
         case ARTICLE_LOG_TYPE_COPYEDIT:
            return 'submission.logType.copyedit';
         case ARTICLE_LOG_TYPE_LAYOUT:
            return 'submission.logType.layout';
         case ARTICLE_LOG_TYPE_PROOFREAD:
            return 'submission.logType.proofread';
         default:
            return 'submission.logType.article';
      }
   }


   //
   // Email data
   //

   function getFrom() {
      return $this->getData('from');
   }

   function setFrom($from) {
      return $this->setData('from', $from);
   }

   function getRecipients() {
      return $this->getData('recipients');
   }

   function setRecipients($recipients) {
      return $this->setData('recipients', $recipients);
   }

   function getCcs() {
      return $this->getData('ccs');
   }

   function setCcs($ccs) {
      return $this->setData('ccs', $ccs);
   }

   function getBccs() {
      return $this->getData('bccs');
   }

   function setBccs($bccs) {
      return $this->setData('bccs', $bccs);
   }

   function getSubject() {
      return $this->getData('subject');
   }

   function setSubject($subject) {
      return $this->setData('subject', $subject);
   }

   function getBody() {
      return $this->getData('body');
   }

   function setBody($body) {
      return $this->setData('body', $body);
   }

}

?>

---