SubscriptionDAO.inc.php

<?php
 
import('classes.subscription.Subscription');
import('classes.subscription.SubscriptionType');
 
define('SUBSCRIPTION_USER',         0x01);
define('SUBSCRIPTION_MEMBERSHIP',      0x02);
define('SUBSCRIPTION_REFERENCE_NUMBER',      0x03);
define('SUBSCRIPTION_NOTES',        0x04);
 
abstract class SubscriptionDAO extends DAO {
 
   abstract function getById($subscriptionId);
 
   function getSubscriptionJournalId($subscriptionId) {
      $result = $this->retrieve(
         'SELECT journal_id FROM subscriptions WHERE subscription_id = ?', (int) $subscriptionId
      );
 
      $returner = isset($result->fields[0]) ? $result->fields[0] : false;
 
      $result->Close();
      return $returner;
   }
 
   static function getStatusOptions() {
      return array(
         SUBSCRIPTION_STATUS_ACTIVE => 'subscriptions.status.active',
         SUBSCRIPTION_STATUS_NEEDS_INFORMATION => 'subscriptions.status.needsInformation',
         SUBSCRIPTION_STATUS_NEEDS_APPROVAL => 'subscriptions.status.needsApproval',
         SUBSCRIPTION_STATUS_AWAITING_MANUAL_PAYMENT => 'subscriptions.status.awaitingManualPayment',
         SUBSCRIPTION_STATUS_AWAITING_ONLINE_PAYMENT => 'subscriptions.status.awaitingOnlinePayment',
         SUBSCRIPTION_STATUS_OTHER => 'subscriptions.status.other'
      );
   }
 
   abstract function getStatusCount($status);
 
   abstract function subscriptionExists($subscriptionId);
 
   abstract function subscriptionExistsByUser($subscriptionId, $userId);
 
   abstract function subscriptionExistsByUserForJournal($userId, $journalId);
 
   abstract function insertObject($subscription);
 
   function getInsertId() {
      return $this->_getInsertId('subscriptions', 'subscription_id');
   }
 
   abstract function updateObject($subscription);
 
   abstract function deleteById($subscriptionId, $journalId);
 
   abstract function deleteByJournalId($journalId);
 
   abstract function deleteByUserId($userId);
 
   abstract function deleteByTypeId($subscriptionTypeId);
 
   abstract function getAll($rangeInfo = null);
 
   abstract function getByJournalId($journalId, $status = null, $searchField = null, $searchMatch = null, $search = null, $dateField = null, $dateFrom = null, $dateTo = null, $rangeInfo = null);
 
   abstract function getByDateEnd($dateEnd, $journalId, $rangeInfo = null);
 
   abstract function renewSubscription($subscription);
 
   protected function _generateSearchSQL($status = null, $searchField = null, $searchMatch = null, $search = null, $dateField = null, $dateFrom = null, $dateTo = null, &$params) {
      $searchSql = '';
 
      if (!empty($search)) switch ($searchField) {
         case IDENTITY_SETTING_GIVENNAME:
            if ($searchMatch === 'is') {
               $searchSql = ' AND LOWER(COALESCE(ugl.setting_value,ugpl.setting_value)) = LOWER(?)';
            } elseif ($searchMatch === 'contains') {
               $searchSql = ' AND LOWER(COALESCE(ugl.setting_value,ugpl.setting_value)) LIKE LOWER(?)';
               $search = '%' . $search . '%';
            } else { // $searchMatch === 'startsWith'
               $searchSql = ' AND LOWER(COALESCE(ugl,ugpl)) LIKE LOWER(?)';
               $search = $search . '%';
            }
            $params[] = $search;
            break;
         case IDENTITY_SETTING_FAMILYNAME:
            if ($searchMatch === 'is') {
               $searchSql = ' AND LOWER(COALESCE(ufl.setting_value,ufpl.setting_value)) = LOWER(?)';
            } elseif ($searchMatch === 'contains') {
               $searchSql = ' AND LOWER(COALESCE(ufl.setting_value,ufpl.setting_value)) LIKE LOWER(?)';
               $search = '%' . $search . '%';
            } else { // $searchMatch === 'startsWith'
               $searchSql = ' AND LOWER(COALESCE(ufl.setting_value,ufpl.setting_value)) LIKE LOWER(?)';
               $search = $search . '%';
            }
            $params[] = $search;
            break;
         case USER_FIELD_USERNAME:
            if ($searchMatch === 'is') {
               $searchSql = ' AND LOWER(u.username) = LOWER(?)';
            } elseif ($searchMatch === 'contains') {
               $searchSql = ' AND LOWER(u.username) LIKE LOWER(?)';
               $search = '%' . $search . '%';
            } else { // $searchMatch === 'startsWith'
               $searchSql = ' AND LOWER(u.username) LIKE LOWER(?)';
               $search = $search . '%';
            }
            $params[] = $search;
            break;
         case USER_FIELD_EMAIL:
            if ($searchMatch === 'is') {
               $searchSql = ' AND LOWER(u.email) = LOWER(?)';
            } elseif ($searchMatch === 'contains') {
               $searchSql = ' AND LOWER(u.email) LIKE LOWER(?)';
               $search = '%' . $search . '%';
            } else { // $searchMatch === 'startsWith'
               $searchSql = ' AND LOWER(u.email) LIKE LOWER(?)';
               $search = $search . '%';
            }
            $params[] = $search;
            break;
         case SUBSCRIPTION_MEMBERSHIP:
            if ($searchMatch === 'is') {
               $searchSql = ' AND LOWER(s.membership) = LOWER(?)';
            } elseif ($searchMatch === 'contains') {
               $searchSql = ' AND LOWER(s.membership) LIKE LOWER(?)';
               $search = '%' . $search . '%';
            } else { // $searchMatch === 'startsWith'
               $searchSql = ' AND LOWER(s.membership) LIKE LOWER(?)';
               $search = $search . '%';
            }
            $params[] = $search;
            break;
         case SUBSCRIPTION_REFERENCE_NUMBER:
            if ($searchMatch === 'is') {
               $searchSql = ' AND LOWER(s.reference_number) = LOWER(?)';
            } elseif ($searchMatch === 'contains') {
               $searchSql = ' AND LOWER(s.reference_number) LIKE LOWER(?)';
               $search = '%' . $search . '%';
            } else { // $searchMatch === 'startsWith'
               $searchSql = ' AND LOWER(s.reference_number) LIKE LOWER(?)';
               $search = $search . '%';
            }
            $params[] = $search;
            break;
         case SUBSCRIPTION_NOTES:
            if ($searchMatch === 'is') {
               $searchSql = ' AND LOWER(s.notes) = LOWER(?)';
            } elseif ($searchMatch === 'contains') {
               $searchSql = ' AND LOWER(s.notes) LIKE LOWER(?)';
               $search = '%' . $search . '%';
            } else { // $searchMatch === 'startsWith'
               $searchSql = ' AND LOWER(s.notes) LIKE LOWER(?)';
               $search = $search . '%';
            }
            $params[] = $search;
            break;
      }
 
      if (!empty($dateFrom) || !empty($dateTo)) switch($dateField) {
         case SUBSCRIPTION_DATE_START:
            if (!empty($dateFrom)) {
               $searchSql .= ' AND s.date_start >= ' . $this->datetimeToDB($dateFrom);
            }
            if (!empty($dateTo)) {
               $searchSql .= ' AND s.date_start <= ' . $this->datetimeToDB($dateTo);
            }
            break;
         case SUBSCRIPTION_DATE_END:
            if (!empty($dateFrom)) {
               $searchSql .= ' AND s.date_end >= ' . $this->datetimeToDB($dateFrom);
            }
            if (!empty($dateTo)) {
               $searchSql .= ' AND s.date_end <= ' . $this->datetimeToDB($dateTo);
            }
            break;
      }
 
      if (!empty($status)) {
         $searchSql .= ' AND s.status = ' . (int) $status;
      }
 
      return $searchSql;
   }
 
   abstract function newDataObject();
 
   function _fromRow($row) {
      $subscription = $this->newDataObject();
      $subscription->setId($row['subscription_id']);
      $subscription->setJournalId($row['journal_id']);
      $subscription->setUserId($row['user_id']);
      $subscription->setTypeId($row['type_id']);
      $subscription->setDateStart($this->dateFromDB($row['date_start']));
      $subscription->setDateEnd($this->dateFromDB($row['date_end']));
      $subscription->setStatus($row['status']);
      $subscription->setMembership($row['membership']);
      $subscription->setReferenceNumber($row['reference_number']);
      $subscription->setNotes($row['notes']);
 
      HookRegistry::call('SubscriptionDAO::_fromRow', array(&$subscription, &$row));
 
      return $subscription;
   }
 
   function _insertObject($subscription) {
      $dateStart = $subscription->getDateStart();
      $dateEnd = $subscription->getDateEnd();
      $this->update(
         sprintf('INSERT INTO subscriptions
            (journal_id, user_id, type_id, date_start, date_end, status, membership, reference_number, notes)
            VALUES
            (?, ?, ?, %s, %s, ?, ?, ?, ?)',
            $dateStart!==null?$this->dateToDB($dateStart):'null',
            $dateEnd!==null?$this->datetimeToDB($dateEnd):'null'
         ), array(
            (int) $subscription->getJournalId(),
            (int) $subscription->getUserId(),
            (int) $subscription->getTypeId(),
            (int) $subscription->getStatus(),
            $subscription->getMembership(),
            $subscription->getReferenceNumber(),
            $subscription->getNotes()
         )
      );
 
      $subscriptionId = $this->getInsertId();
      $subscription->setId($subscriptionId);
 
      return $subscriptionId;
   }
 
   function _updateObject($subscription) {
      $dateStart = $subscription->getDateStart();
      $dateEnd = $subscription->getDateEnd();
      $this->update(
         sprintf('UPDATE subscriptions
            SET
               journal_id = ?,
               user_id = ?,
               type_id = ?,
               date_start = %s,
               date_end = %s,
               status = ?,
               membership = ?,
               reference_number = ?,
               notes = ?
            WHERE subscription_id = ?',
            $dateStart!==null?$this->dateToDB($dateStart):'null',
            $dateEnd!==null?$this->datetimeToDB($dateEnd):'null'
         ), array(
            (int) $subscription->getJournalId(),
            (int) $subscription->getUserId(),
            (int) $subscription->getTypeId(),
            (int) $subscription->getStatus(),
            $subscription->getMembership(),
            $subscription->getReferenceNumber(),
            $subscription->getNotes(),
            (int) $subscription->getId()
         )
      );
   }
 
   function _renewSubscription($subscription) {
      if ($subscription->isNonExpiring()) return;
 
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
      $subscriptionType = $subscriptionTypeDao->getById($subscription->getTypeId());
 
      $duration = $subscriptionType->getDuration();
      $dateEnd = strtotime($subscription->getDateEnd());
 
      // if the subscription is expired, extend it to today + duration of subscription
      $time = time();
      if ($dateEnd < $time ) $dateEnd = $time;
 
      $subscription->setDateEnd(mktime(23, 59, 59, date("m", $dateEnd)+$duration, date("d", $dateEnd), date("Y", $dateEnd)));
      $this->updateObject($subscription);
   }
}