classes/payment/ojs/OJSCompletedPayment.inc.php

<?php

import('payment.Payment');

class OJSCompletedPayment extends Payment {
   var $journalId;
   
   var $paperId;

   var $type;
   
   var $timestamp;
   
   var $payMethod;
   
   function OJSCompletedPayment() {
   }

   function setCompletedPaymentId($queuedPaymentId) {
      parent::setPaymentId($queuedPaymentId);
   }
   
   function getCompletedPaymentId() {
      return parent::getPaymentId();
   }

   function getJournalId() {
      return $this->journalId;
   }
   
   function setJournalId($journalId) {
      $this->journalId = $journalId;
   }
   
   function setType($type) {
      $this->type = $type;
   }
   
   function getType() {
      return $this->type;
   }
   
   function getName() {
      $journalDAO =& DAORegistry::getDAO('JournalDAO');
      $journal =& $journalDAO->getJournal($this->getJournalId());
      
      switch ($this->type) {
         case PAYMENT_TYPE_SUBSCRIPTION:
            $subscriptionDAO =& DAORegistry::getDAO('SubscriptionDAO');
            $subscriptionTypeDAO =& DAORegistry::getDAO('SubscriptionTypeDAO');
            
            $subscription =& $subscriptionDAO->getSubscription($this->assocId);
            if ( !$subscription) return Locale::translate('payment.type.subscription');
            
            $subscriptionType =& $subscriptionTypeDAO->getSubscriptionType($subscription->getTypeId());

            return Locale::translate('payment.type.subscription') . '(' . $subscriptionType->getSubscriptionTypeName() . ')';
         case PAYMENT_TYPE_DONATION:
            if ( $journal->getLocalizedSetting('donationFeeName') != '') {
               return $journal->getLocalizedSetting('donationFeeName');
            } else {    
               return Locale::translate('payment.type.donation');
            }        
         case PAYMENT_TYPE_MEMBERSHIP: 
            if ( $journal->getLocalizedSetting('membershipFeeName') != '') {
               return $journal->getLocalizedSetting('membershipFeeName');
            } else {    
               return Locale::translate('payment.type.membership');
            }
         case PAYMENT_TYPE_PURCHASE_ARTICLE:
            if ( $journal->getLocalizedSetting('purchaseArticleFeeName') != '' ) {
               return $journal->getLocalizedSetting('purchaseArticleFeeName');
            } else {    
               return Locale::translate('payment.type.purchaseArticle');
            }
         case PAYMENT_TYPE_SUBMISSION:
            if ( $journal->getLocalizedSetting('submissionFeeName') != '' ) {
               return $journal->getLocalizedSetting('submissionFeeName');
            } else {    
               return Locale::translate('payment.type.submission');
            }
         case PAYMENT_TYPE_FASTTRACK:
            if ( $journal->getLocalizedSetting('fastTrackFeeName') != '' ) {
               return $journal->getLocalizedSetting('fastTrackFeeName');
            } else {    
               return Locale::translate('payment.type.fastTrack');
            }           
         case PAYMENT_TYPE_PUBLICATION:
            if ( $journal->getLocalizedSetting('publicationFeeName') != '' ) {
               return $journal->getLocalizedSetting('publicationFeeName');
            } else {    
               return Locale::translate('payment.type.publication');
            }
      }
   }     
   
   function getDescription() {
      $journalDAO =& DAORegistry::getDAO('JournalDAO');
      $journal =& $journalDAO->getJournal($this->getJournalId());
      
      switch ($this->type) {
         case PAYMENT_TYPE_SUBSCRIPTION:
            $subscriptionDAO =& DAORegistry::getDAO('SubscriptionDAO');
            $subscriptionTypeDAO =& DAORegistry::getDAO('SubscriptionTypeDAO');
            
            $subscription =& $subscriptionDAO->getSubscription($this->assocId);
            if ( !$subscription) return Locale::translate('payment.type.subscription');
            
            $subscriptionType =& $subscriptionTypeDAO->getSubscriptionType($subscription->getTypeId());
            return $subscriptionType->getSubscriptionTypeDescription();
         case PAYMENT_TYPE_DONATION:
            if ( $journal->getLocalizedSetting('donationFeeDescription') != '') {
               return $journal->getLocalizedSetting('donationFeeDescription');
            } else {    
               return Locale::translate('payment.type.donation');
            }                 
         case PAYMENT_TYPE_MEMBERSHIP: 
            if ( $journal->getLocalizedSetting('membershipFeeDescription') != '') {
               return $journal->getLocalizedSetting('membershipFeeDescription');
            } else {    
               return Locale::translate('payment.type.membership');
            }           
         case PAYMENT_TYPE_PURCHASE_ARTICLE:
            if ( $journal->getLocalizedSetting('purchaseArticleFeeDescription') != '') {
               return $journal->getLocalizedSetting('purchaseArticleFeeDescription');
            } else {    
               return Locale::translate('payment.type.purchaseArticle');
            }
         case PAYMENT_TYPE_SUBMISSION:
            if ( $journal->getLocalizedSetting('submissionFeeDescription') != '' ) {
               return $journal->getLocalizedSetting('submissionFeeDescription');
            } else {    
               return Locale::translate('payment.type.submission');
            }
         case PAYMENT_TYPE_FASTTRACK:
            if ( $journal->getLocalizedSetting('fastTrackFeeDescription') != '' ) {
               return $journal->getLocalizedSetting('fastTrackFeeDescription');
            } else {    
               return Locale::translate('payment.type.fastTrack');
            }                       
         case PAYMENT_TYPE_PUBLICATION:
            if ( $journal->getLocalizedSetting('publicationFeeDescription') != '' ) {
               return $journal->getLocalizedSetting('publicationFeeDescription');
            } else {    
               return Locale::translate('payment.type.publication');
            }
      }
   }
   
   function getTimestamp() {
      return $this->timestamp;
   }
   
   function setTimestamp($timestamp) {
      $this->timestamp = $timestamp;
   }
      

   function getPayMethodPluginName() {
      return $this->payMethod;
   }

   function setPayMethodPluginName($payMethod){
      $this->payMethod = $payMethod;
   }
   
   function isMembership() {
      return $this->type == PAYMENT_TYPE_MEMBERSHIP;
   }
   
   function isSubscription() {
      return $this->type == PAYMENT_TYPE_SUBSCRIPTION;
   }
    
    
   function getUsername() {
      $userId = $this->userId;
      if ( !$userId )
         return false;
      $userDAO = &DAORegistry::getDAO('UserDAO');
      $user =& $userDAO->getUser($userId);
      if ( !$user )
         return false;
      return $user->getUsername();
      
   }

   function getAssocDescription() {
      if ( !$this->assocId ) return false;
      switch ($this->type) {
         case PAYMENT_TYPE_SUBSCRIPTION:
            $subscriptionDAO =& DAORegistry::getDAO('SubscriptionDAO');
            $subscriptionTypeDAO =& DAORegistry::getDAO('SubscriptionTypeDAO');
            
            $subscription =& $subscriptionDAO->getSubscription($this->assocId);
            if ( !$subscription) return Locale::translate('manager.payment.notFound');
            
            $subscriptionType =& $subscriptionTypeDAO->getSubscriptionType($subscription->getTypeId());

            $membership = $subscription->getMembership();
            $typeName = $subscriptionType->getSubscriptionTypeName();
            if ( $membership )
               return $typeName . ' ('. $membership . ')';
            else
               return $typeName;
         case PAYMENT_TYPE_SUBMISSION:
         case PAYMENT_TYPE_FASTTRACK:           
         case PAYMENT_TYPE_PUBLICATION:
         case PAYMENT_TYPE_PURCHASE_ARTICLE:
            // all the article-related payments should output the article title
            $articleDAO = &DAORegistry::getDAO('ArticleDAO');
            $article =& $articleDAO->getArticle($this->assocId, $this->journalId);
            if ( !$article ) return Locale::translate('manager.payment.notFound');
            return $article->getArticleTitle();
         case PAYMENT_TYPE_MEMBERSHIP:
         case PAYMENT_TYPE_DONATION:
            return false;
      }
      
      return false;
   }
      
}

?>

---