SubscriptionType.inc.php

<?php
 
define('SUBSCRIPTION_TYPE_FORMAT_ONLINE',    0x01); 
define('SUBSCRIPTION_TYPE_FORMAT_PRINT',     0x10);
define('SUBSCRIPTION_TYPE_FORMAT_PRINT_ONLINE', 0x11);
 
 
class SubscriptionType extends DataObject {
   //
   // Get/set methods
   //
 
   function getJournalId() {
      return $this->getData('journalId');
   }
 
   function setJournalId($journalId) {
      return $this->setData('journalId', $journalId);
   }
 
   function getLocalizedName() {
      return $this->getLocalizedData('name');
   }
 
   function getName($locale) {
      return $this->getData('name', $locale);
   }
 
   function setName($name, $locale) {
      return $this->setData('name', $name, $locale);
   }
 
   function getLocalizedDescription() {
      return $this->getLocalizedData('description');
   }
 
   function getDescription($locale) {
      return $this->getData('description', $locale);
   }
 
   function setDescription($description, $locale) {
      return $this->setData('description', $description, $locale);
   }
 
   function getCost() {
      return $this->getData('cost');
   }
 
   function setCost($cost) {
      return $this->setData('cost', $cost);
   }
 
   function getCurrencyCodeAlpha() {
      return $this->getData('currencyCodeAlpha');
   }
 
   function setCurrencyCodeAlpha($currencyCodeAlpha) {
      return $this->setData('currencyCodeAlpha', $currencyCodeAlpha);
   }
 
   public function getCurrencyString() {
      $isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
      $currency = $isoCodes->getCurrencies()->getByLetterCode($this->getData('currencyCodeAlpha'));
      return $currency?$currency->getLocalName():'subscriptionTypes.currency';
   }
 
   function getCurrencyStringShort() {
      $isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
      $currency = $isoCodes->getCurrencies()->getByLetterCode($this->getData('currencyCodeAlpha'));
      return $currency?$currency->getLetterCode():'subscriptionTypes.currency';
   }
 
   function getNonExpiring() {
      return $this->getDuration()==null;
   }
 
   function getDuration() {
      return $this->getData('duration');
   }
 
   function setDuration($duration) {
      return $this->setData('duration', $duration);
   }
 
   function getDurationYearsMonths($locale = null) {
      if (!$this->getDuration()) {
         return __('subscriptionTypes.nonExpiring', null, $locale);
      }
 
      $years = (int)floor($this->getDuration()/12);
      $months = (int)fmod($this->getDuration(), 12);
      $yearsMonths = '';
 
      if ($years == 1) {
         $yearsMonths = '1 ' . __('subscriptionTypes.year', null, $locale);
      } elseif ($years > 1) {
         $yearsMonths = $years . ' ' . __('subscriptionTypes.years', null, $locale);
      }
 
      if ($months == 1) {
         $yearsMonths .= $yearsMonths == ''  ? '1 ' : ' 1 ';
         $yearsMonths .= __('subscriptionTypes.month', null, $locale);
      } elseif ($months > 1){
         $yearsMonths .= $yearsMonths == ''  ? $months . ' ' : ' ' . $months . ' ';
         $yearsMonths .= __('subscriptionTypes.months', null, $locale);
      }
 
      return $yearsMonths;
   }
 
   function getFormat() {
      return $this->getData('format');
   }
 
   function setFormat($format) {
      return $this->setData('format', $format);
   }
 
   function getFormatString() {
      switch ($this->getData('format')) {
         case SUBSCRIPTION_TYPE_FORMAT_ONLINE:
            return 'subscriptionTypes.format.online';
         case SUBSCRIPTION_TYPE_FORMAT_PRINT:
            return 'subscriptionTypes.format.print';
         case SUBSCRIPTION_TYPE_FORMAT_PRINT_ONLINE:
            return 'subscriptionTypes.format.printOnline';
         default:
            return 'subscriptionTypes.format';
      }
   }
 
   function getInstitutional() {
      return $this->getData('institutional');
   }
 
   function setInstitutional($institutional) {
      return $this->setData('institutional', $institutional);
   }
 
   function getMembership() {
      return $this->getData('membership');
   }
 
   function setMembership($membership) {
      return $this->setData('membership', $membership);
   }
 
   function getDisablePublicDisplay() {
      return $this->getData('disable_public_display');
   }
 
   function setDisablePublicDisplay($disablePublicDisplay) {
      return $this->setData('disable_public_display', $disablePublicDisplay);
   }
 
   function getSequence() {
      return $this->getData('sequence');
   }
 
   function setSequence($sequence) {
      return $this->setData('sequence', $sequence);
   }
 
   function getSummaryString() {
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
      return $this->getLocalizedName() . ' - ' . $this->getDurationYearsMonths() . ' - ' . sprintf('%.2f', $this->getCost()) . ' ' . $this->getCurrencyStringShort();
   }
}