ManualPaymentPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.PaymethodPlugin');
 
class ManualPaymentPlugin extends PaymethodPlugin {
 
   function getName() {
      return 'ManualPayment';
   }
 
   function getDisplayName() {
      return __('plugins.paymethod.manual.displayName');
   }
 
   function getDescription() {
      return __('plugins.paymethod.manual.description');
   }
 
   function register($category, $path, $mainContextId = null) {
      if (parent::register($category, $path, $mainContextId)) {
         $this->addLocaleData();
         \HookRegistry::register('Form::config::before', array($this, 'addSettings'));
         return true;
      }
      return false;
   }
 
   public function addSettings($hookName, $form) {
      if ($form->id !== FORM_PAYMENT_SETTINGS) {
         return;
      }
 
      $context = Application::get()->getRequest()->getContext();
      if (!$context) {
         return;
      }
 
      $form->addGroup([
            'id' => 'manualPayment',
            'label' => __('plugins.paymethod.manual.displayName'),
            'showWhen' => 'paymentsEnabled',
         ])
         ->addField(new \PKP\components\forms\FieldTextArea('manualInstructions', [
            'label' => __('plugins.paymethod.manual.settings'),
            'value' => $this->getSetting($context->getId(), 'manualInstructions'),
            'groupId' => 'manualPayment',
         ]));
 
      return;
   }
 
   public function saveSettings($params, $slimRequest, $request) {
      $allParams = $slimRequest->getParsedBody();
      $manualInstructions = isset($allParams['manualInstructions']) ? (string) $allParams['manualInstructions'] : '';
      $this->updateSetting($request->getContext()->getId(), 'manualInstructions', $manualInstructions);
      return [];
   }
 
   function isConfigured($context) {
      if (!$context) return false;
      if ($this->getSetting($context->getId(), 'manualInstructions') == '') return false;
      return true;
   }
 
   function getPaymentForm($context, $queuedPayment) {
      if (!$this->isConfigured($context)) return null;
 
      AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON);
 
      import('lib.pkp.classes.form.Form');
      $paymentForm = new Form($this->getTemplateResource('paymentForm.tpl'));
      $paymentManager = Application::getPaymentManager($context);
      $paymentForm->setData(array(
         'itemName' => $paymentManager->getPaymentName($queuedPayment),
         'itemAmount' => $queuedPayment->getAmount()>0?$queuedPayment->getAmount():null,
         'itemCurrencyCode' => $queuedPayment->getAmount()>0?$queuedPayment->getCurrencyCode():null,
         'manualInstructions' => $this->getSetting($context->getId(), 'manualInstructions'),
         'queuedPaymentId' => $queuedPayment->getId(),
      ));
      return $paymentForm;
   }
 
   function handle($args, $request) {
      $context = $request->getContext();
      $templateMgr = TemplateManager::getManager($request);
      $user = $request->getUser();
      $op = isset($args[0])?$args[0]:null;
      $queuedPaymentId = isset($args[1])?((int) $args[1]):0;
 
      $queuedPaymentDao = DAORegistry::getDAO('QueuedPaymentDAO'); /* @var $queuedPaymentDao QueuedPaymentDAO */
      $queuedPayment = $queuedPaymentDao->getById($queuedPaymentId);
      $paymentManager = Application::getPaymentManager($context);
      // if the queued payment doesn't exist, redirect away from payments
      if (!$queuedPayment) $request->redirect(null, 'index');
 
      switch ($op) {
         case 'notify':
            import('lib.pkp.classes.mail.MailTemplate');
            AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON);
            $contactName = $context->getData('contactName');
            $contactEmail = $context->getData('contactEmail');
            $mail = new MailTemplate('MANUAL_PAYMENT_NOTIFICATION');
            $mail->setReplyTo(null);
            $mail->addRecipient($contactEmail, $contactName);
            $mail->assignParams(array(
               'contextName' => $context->getLocalizedName(),
               'userFullName' => $user?$user->getFullName():('(' . __('common.none') . ')'),
               'userName' => $user?$user->getUsername():('(' . __('common.none') . ')'),
               'itemName' => $paymentManager->getPaymentName($queuedPayment),
               'itemCost' => $queuedPayment->getAmount(),
               'itemCurrencyCode' => $queuedPayment->getCurrencyCode()
            ));
            $mail->send();
 
            $templateMgr->assign(array(
               'currentUrl' => $request->url(null, null, 'payment', 'plugin', array('notify', $queuedPaymentId)),
               'pageTitle' => 'plugins.paymethod.manual.paymentNotification',
               'message' => 'plugins.paymethod.manual.notificationSent',
               'backLink' => $queuedPayment->getRequestUrl(),
               'backLinkLabel' => 'common.continue'
            ));
            $templateMgr->display('frontend/pages/message.tpl');
            exit();
      }
      parent::handle($args, $request); // Don't know what to do with it
   }
 
   function getInstallEmailTemplatesFile() {
      return ($this->getPluginPath() . DIRECTORY_SEPARATOR . 'emailTemplates.xml');
   }
}