SubscriptionForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class SubscriptionForm extends Form {
 
   var $subscription;
 
   var $userId;
 
   var $subscriptionTypes;
 
   var $validStatus;
 
   var $validCountries;
 
   public function __construct($template, $subscriptionId = null) {
      parent::__construct($template);
 
      $subscriptionId = isset($subscriptionId) ? (int) $subscriptionId : null;
 
      $this->subscription = null;
      $this->subscriptionTypes = null;
 
      import('classes.subscription.SubscriptionDAO');
      $this->validStatus = SubscriptionDAO::getStatusOptions();
 
      $isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
      $this->validCountries = array();
      foreach ($isoCodes->getCountries() as $country) {
         $this->validCountries[$country->getAlpha2()] = $country->getLocalName();
      }
      asort($this->validCountries);
 
      // User is provided and valid
      $this->addCheck(new FormValidator($this, 'userId', 'required', 'manager.subscriptions.form.userIdRequired'));
      $this->addCheck(new FormValidatorCustom($this, 'userId', 'required', 'manager.subscriptions.form.userIdValid', function($userId) {
         $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
         return $userDao->userExistsById($userId);
      }));
 
      // Subscription status is provided and valid
      $this->addCheck(new FormValidator($this, 'status', 'required', 'manager.subscriptions.form.statusRequired'));
      $this->addCheck(new FormValidatorInSet($this, 'status', 'required', 'manager.subscriptions.form.statusValid', array_keys($this->validStatus)));
      // Subscription type is provided
      $this->addCheck(new FormValidator($this, 'typeId', 'required', 'manager.subscriptions.form.typeIdRequired'));
      // Notify email flag is valid value
      $this->addCheck(new FormValidatorInSet($this, 'notifyEmail', 'optional', 'manager.subscriptions.form.notifyEmailValid', array('1')));
 
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
   public function fetch($request, $template = null, $display = false) {
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign(array(
         'subscriptionId' => $this->subscription?$this->subscription->getId():null,
         'yearOffsetPast' => SUBSCRIPTION_YEAR_OFFSET_PAST,
         'yearOffsetFuture' => SUBSCRIPTION_YEAR_OFFSET_FUTURE,
         'validStatus' => $this->validStatus,
         'subscriptionTypes' => $this->subscriptionTypes,
      ));
      return parent::fetch($request, $template, $display);
   }
 
   public function initData() {
      if (isset($this->subscription)) {
         $subscription = $this->subscription;
         $this->_data = array(
            'status' => $subscription->getStatus(),
            'userId' => $subscription->getUserId(),
            'typeId' => $subscription->getTypeId(),
            'dateStart' => $subscription->getDateStart(),
            'dateEnd' => $subscription->getDateEnd(),
            'membership' => $subscription->getMembership(),
            'referenceNumber' => $subscription->getReferenceNumber(),
            'notes' => $subscription->getNotes()
         );
      }
   }
 
   public function readInputData() {
      $this->readUserVars(array('status', 'userId', 'typeId', 'membership', 'referenceNumber', 'notes', 'notifyEmail', 'dateStart', 'dateEnd'));
 
      // If subscription type requires it, membership is provided
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
      $needMembership = $subscriptionTypeDao->getSubscriptionTypeMembership($this->getData('typeId'));
 
      if ($needMembership) {
         $this->addCheck(new FormValidator($this, 'membership', 'required', 'manager.subscriptions.form.membershipRequired'));
      }
 
      // If subscription type requires it, start and end dates are provided
      $subscriptionType = $subscriptionTypeDao->getById($this->getData('typeId'));
      $nonExpiring = $subscriptionType->getNonExpiring();
 
      if (!$nonExpiring) {
         // Start date is provided and is valid
         $this->addCheck(new FormValidator($this, 'dateStart', 'required', 'manager.subscriptions.form.dateStartRequired'));
         $this->addCheck(new FormValidatorCustom($this, 'dateStart', 'required', 'manager.subscriptions.form.dateStartValid', function($dateStart) {
            $dateStartYear = strftime('%Y', strtotime($dateStart));
            $minYear = date('Y') + SUBSCRIPTION_YEAR_OFFSET_PAST;
            $maxYear = date('Y') + SUBSCRIPTION_YEAR_OFFSET_FUTURE;
            return ($dateStartYear >= $minYear && $dateStartYear <= $maxYear);
         }));
         $this->addCheck(new FormValidatorCustom($this, 'dateStart', 'required', 'manager.subscriptions.form.dateStartValid', function($dateStart) {
            $dateStartMonth = strftime('%m', strtotime($dateStart));
            return ($dateStartMonth >= 1 && $dateStartMonth <= 12);
         }));
         $this->addCheck(new FormValidatorCustom($this, 'dateStart', 'required', 'manager.subscriptions.form.dateStartValid', function($dateStart) {
            $dateStartDay = strftime('%d', strtotime($dateStart));
            return ($dateStartDay >= 1 && $dateStartDay <= 31);
         }));
 
         // End date is provided and is valid
         $this->addCheck(new FormValidator($this, 'dateEnd', 'required', 'manager.subscriptions.form.dateEndRequired'));
         $this->addCheck(new FormValidatorCustom($this, 'dateEnd', 'required', 'manager.subscriptions.form.dateEndValid', function($dateEnd) {
            $dateEndYear = strftime('%Y', strtotime($dateEnd)); $minYear = date('Y') + SUBSCRIPTION_YEAR_OFFSET_PAST;
            $maxYear = date('Y') + SUBSCRIPTION_YEAR_OFFSET_FUTURE;
            return ($dateEndYear >= $minYear && $dateEndYear <= $maxYear);
         }));
         $this->addCheck(new FormValidatorCustom($this, 'dateEnd', 'required', 'manager.subscriptions.form.dateEndValid', function($dateEnd) {
            $dateEndMonth = strftime('%m', strtotime($dateEnd));
            return ($dateEndMonth >= 1 && $dateEndMonth <= 12);
         }));
         $this->addCheck(new FormValidatorCustom($this, 'dateEnd', 'required', 'manager.subscriptions.form.dateEndValid', function($dateEnd) {
            $dateEndDay = strftime('%d', strtotime($dateEnd));
            return ($dateEndDay >= 1 && $dateEndDay <= 31);
         }));
      } else {
         // Is non-expiring; ensure that start/end dates weren't entered.
         $this->addCheck(new FormValidatorCustom($this, 'dateStart', 'optional', 'manager.subscriptions.form.dateStartEmpty', function($dateStart) {
            return empty($dateStart);
         }));
         $this->addCheck(new FormValidatorCustom($this, 'dateEnd', 'optional', 'manager.subscriptions.form.dateEndEmpty', function($dateEnd) {
            return empty($dateEnd);
         }));
      }
 
      // If notify email is requested, ensure subscription contact name and email exist.
      if ($this->_data['notifyEmail'] == 1) {
         $this->addCheck(new FormValidatorCustom($this, 'notifyEmail', 'required', 'manager.subscriptions.form.subscriptionContactRequired', function() {
            $request = Application::get()->getRequest();
            $journal = $request->getJournal();
            $subscriptionName = $journal->getData('subscriptionName');
            $subscriptionEmail = $journal->getData('subscriptionEmail');
            return $subscriptionName != '' && $subscriptionEmail != '';
         }));
      }
   }
 
   public function execute(...$functionArgs) {
      $request = Application::get()->getRequest();
      $journal = $request->getJournal();
      $subscription =& $this->subscription;
 
      parent::execute(...$functionArgs);
 
      $subscription->setJournalId($journal->getId());
      $subscription->setStatus($this->getData('status'));
      $subscription->setUserId($this->getData('userId'));
      $subscription->setTypeId($this->getData('typeId'));
      $subscription->setMembership($this->getData('membership') ? $this->getData('membership') : null);
      $subscription->setReferenceNumber($this->getData('referenceNumber') ? $this->getData('referenceNumber') : null);
      $subscription->setNotes($this->getData('notes') ? $this->getData('notes') : null);
 
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
      $subscriptionType = $subscriptionTypeDao->getById($subscription->getTypeId());
      if (!$subscriptionType->getNonExpiring()) {
         $subscription->setDateStart($this->getData('dateStart'));
         $subscription->setDateEnd($this->getData('dateEnd'));
      }
   }
 
   protected function _prepareNotificationEmail($mailTemplateKey) {
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      $subscriptionTypeDao = DAORegistry::getDAO('SubscriptionTypeDAO'); /* @var $subscriptionTypeDao SubscriptionTypeDAO */
 
      $request = Application::get()->getRequest();
      $journal = $request->getJournal();
      $journalName = $journal->getLocalizedTitle();
      $user = $userDao->getById($this->subscription->getUserId());
      $subscriptionType = $subscriptionTypeDao->getById($this->subscription->getTypeId());
 
      $subscriptionName = $journal->getData('subscriptionName');
      $subscriptionEmail = $journal->getData('subscriptionEmail');
      $subscriptionPhone = $journal->getData('subscriptionPhone');
      $subscriptionMailingAddress = $journal->getData('subscriptionMailingAddress');
      $subscriptionContactSignature = $subscriptionName;
 
      if ($subscriptionMailingAddress != '') {
         $subscriptionContactSignature .= "\n" . $subscriptionMailingAddress;
      }
      if ($subscriptionPhone != '') {
         $subscriptionContactSignature .= "\n" . __('user.phone') . ': ' . $subscriptionPhone;
      }
 
      $subscriptionContactSignature .= "\n" . __('user.email') . ': ' . $subscriptionEmail;
 
      $paramArray = array(
         'subscriberName' => $user->getFullName(),
         'journalName' => $journalName,
         'subscriptionType' => $subscriptionType->getSummaryString(),
         'username' => $user->getUsername(),
         'subscriptionContactSignature' => $subscriptionContactSignature
      );
 
      import('lib.pkp.classes.mail.MailTemplate');
      $mail = new MailTemplate($mailTemplateKey);
      $mail->setReplyTo($subscriptionEmail, $subscriptionName);
      $mail->addRecipient($user->getEmail(), $user->getFullName());
      $mail->setSubject($mail->getSubject($journal->getPrimaryLocale()));
      $mail->setBody($mail->getBody($journal->getPrimaryLocale()));
      $mail->assignParams($paramArray);
 
      return $mail;
   }
}