CRM/Core/Payment/ProcessorForm.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 use Civi\Payment\System;
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2015
  33  */
  34
  35
  36 /**
  37  * Base class for building payment block for online contribution / event pages.
  38  */
  39 class CRM_Core_Payment_ProcessorForm {
  40
  41   /**
  42    * @param CRM_Contribute_Form_Contribution_Main|CRM_Event_Form_Registration_Register $form
  43    * @param null $type
  44    * @param null $mode
  45    *
  46    * @throws Exception
  47    */
  48   public static function preProcess(&$form, $type = NULL, $mode = NULL) {
  49     if ($type) {
  50       $form->_type = $type;
  51     }
  52     else {
  53       $form->_type = CRM_Utils_Request::retrieve('type', 'String', $form);
  54     }
  55
  56     if ($form->_type) {
  57       $form->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($form->_type, $form->_mode);
  58     }
  59
  60     $form->set('paymentProcessor', $form->_paymentProcessor);
  61     $form->_paymentObject = Civi\Payment\System::singleton()->getByProcessor($form->_paymentProcessor);
  62
  63     $form->assign('suppressSubmitButton', $form->_paymentObject->isSuppressSubmitButtons());
  64
  65     // also set cancel subscription url
  66     if (!empty($form->_paymentProcessor['is_recur']) && !empty($form->_values['is_recur'])) {
  67       $form->_values['cancelSubscriptionUrl'] = $form->_paymentObject->subscriptionURL();
  68     }
  69
  70     //checks after setting $form->_paymentProcessor
  71     // we do this outside of the above conditional to avoid
  72     // saving the country/state list in the session (which could be huge)
  73     CRM_Core_Payment_Form::setPaymentFieldsByProcessor($form, $form->_paymentProcessor);
  74
  75     $form->assign_by_ref('paymentProcessor', $form->_paymentProcessor);
  76
  77     // check if this is a paypal auto return and redirect accordingly
  78     //@todo - determine if this is legacy and remove
  79     if (CRM_Core_Payment::paypalRedirect($form->_paymentProcessor)) {
  80       $url = CRM_Utils_System::url('civicrm/contribute/transact',
  81         "_qf_ThankYou_display=1&qfKey={$form->controller->_key}"
  82       );
  83       CRM_Utils_System::redirect($url);
  84     }
  85
  86     // make sure we have a valid payment class, else abort
  87     if (!empty($form->_values['is_monetary']) &&
  88       !$form->_paymentProcessor['class_name'] && empty($form->_values['is_pay_later'])
  89     ) {
  90       CRM_Core_Error::fatal(ts('Payment processor is not set for this page'));
  91     }
  92
  93     if (!empty($form->_membershipBlock) && !empty($form->_membershipBlock['is_separate_payment']) &&
  94       (!empty($form->_paymentProcessor['class_name']) &&
  95         !$form->_paymentObject->supports('MultipleConcurrentPayments')
  96       )
  97     ) {
  98
  99       CRM_Core_Error::fatal(ts('This contribution page is configured to support separate contribution and membership payments. This %1 plugin does not currently support multiple simultaneous payments, or the option to "Execute real-time monetary transactions" is disabled. Please contact the site administrator and notify them of this error',
 100           array(1 => $form->_paymentProcessor['payment_processor_type'])
 101         )
 102       );
 103     }
 104   }
 105
 106   /**
 107    * @param $form
 108    */
 109   public static function buildQuickform(&$form) {
 110     //@todo document why this addHidden is here
 111     //CRM-15743 - we should not set/create hidden element for pay later
 112     // because payment processor is not selected
 113     if (!empty($form->_paymentProcessorID)) {
 114       $form->addElement('hidden', 'hidden_processor', 1);
 115     }
 116     CRM_Core_Payment_Form::buildPaymentForm($form, $form->_paymentProcessor, empty($form->_isBillingAddressRequiredForPayLater), FALSE);
 117   }
 118
 119 }