Subscription.inc.php

<?php
 
define('SUBSCRIPTION_STATUS_ACTIVE',         0x01);
define('SUBSCRIPTION_STATUS_NEEDS_INFORMATION',    0x02);
define('SUBSCRIPTION_STATUS_NEEDS_APPROVAL',       0x03);
define('SUBSCRIPTION_STATUS_AWAITING_MANUAL_PAYMENT',    0x04);
define('SUBSCRIPTION_STATUS_AWAITING_ONLINE_PAYMENT', 0x05);
define('SUBSCRIPTION_STATUS_OTHER',          0x10);
 
define('SUBSCRIPTION_DATE_START',   0x01);
define('SUBSCRIPTION_DATE_END',     0x02);
define('SUBSCRIPTION_DATE_BOTH', 0x03);
 
define('SUBSCRIPTION_YEAR_OFFSET_PAST',      '-10');
define('SUBSCRIPTION_YEAR_OFFSET_FUTURE', '+10');
 
 
class Subscription extends DataObject {
 
   //
   // Get/set methods
   //
 
   public function getJournalId() {
      return $this->getData('journalId');
   }
 
   public function setJournalId($journalId) {
      $this->setData('journalId', $journalId);
   }
 
   public function getUserId() {
      return $this->getData('userId');
   }
 
   public function setUserId($userId) {
      $this->setData('userId', $userId);
   }
 
   public function getUserFullName() {
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      return $userDao->getUserFullName($this->getData('userId'));
   }
 
   public function getUserEmail() {
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      return $userDao->getUserEmail($this->getData('userId'));
   }
 
   public function getTypeId() {
      return $this->getData('typeId');
   }
 
   public function setTypeId($typeId) {
      $this->setData('typeId', $typeId);
   }
 
   public function getSubscriptionTypeName() {
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
      return $subscriptionTypeDao->getSubscriptionTypeName($this->getData('typeId'));
   }
 
   public function getSubscriptionTypeSummaryString() {
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
      $subscriptionType = $subscriptionTypeDao->getById($this->getData('typeId'));
      return $subscriptionType->getSummaryString();
   }
 
   public function getSubscriptionTypeInstitutional() {
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
      return $subscriptionTypeDao->getSubscriptionTypeInstitutional($this->getData('typeId'));
   }
 
   public function isNonExpiring() {
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
      $subscriptionType = $subscriptionTypeDao->getById($this->getTypeId());
      return $subscriptionType->getNonExpiring();
   }
 
   public function getDateStart() {
      return $this->getData('dateStart');
   }
 
   public function setDateStart($dateStart) {
      $this->setData('dateStart', $dateStart);
   }
 
   public function getDateEnd() {
      return $this->getData('dateEnd');
   }
 
   public function setDateEnd($dateEnd) {
      $this->setData('dateEnd', $dateEnd);
   }
 
   public function getStatus() {
      return $this->getData('status');
   }
 
   public function setStatus($status) {
      $this->setData('status', $status);
   }
 
   public function getStatusString() {
      switch ($this->getData('status')) {
         case SUBSCRIPTION_STATUS_ACTIVE:
            return __('subscriptions.status.active');
         case SUBSCRIPTION_STATUS_NEEDS_INFORMATION:
            return __('subscriptions.status.needsInformation');
         case SUBSCRIPTION_STATUS_NEEDS_APPROVAL:
            return __('subscriptions.status.needsApproval');
         case SUBSCRIPTION_STATUS_AWAITING_MANUAL_PAYMENT:
            return __('subscriptions.status.awaitingManualPayment');
         case SUBSCRIPTION_STATUS_AWAITING_ONLINE_PAYMENT:
            return __('subscriptions.status.awaitingOnlinePayment');
         case SUBSCRIPTION_STATUS_OTHER:
            return __('subscriptions.status.other');
         default:
            return __('subscriptions.status');
      }
   }
 
   public function getMembership() {
      return $this->getData('membership');
   }
 
   public function setMembership($membership) {
      $this->setData('membership', $membership);
   }
 
   public function getReferenceNumber() {
      return $this->getData('referenceNumber');
   }
 
   public function setReferenceNumber($referenceNumber) {
      $this->setData('referenceNumber', $referenceNumber);
   }
 
   public function getNotes() {
      return $this->getData('notes');
   }
 
   public function setNotes($notes) {
      $this->setData('notes', $notes);
   }
 
   public function isExpired() {
      if (strtotime($this->getData('dateEnd')) < time()) {
         return true;
      } else {
         return false;
      }
   }
}