CRM/Core/Payment/ProcessorForm.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  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 $form
  43    * @param null $type
  44    * @param null $mode
  45    *
  46    * @throws Exception
  47    */
  48   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
  62     // also set cancel subscription url
  63     if (!empty($form->_paymentProcessor['is_recur']) && !empty($form->_values['is_recur'])) {
  64       $form->_paymentObject = &CRM_Core_Payment::singleton($mode, $form->_paymentProcessor, $form);
  65       $form->_values['cancelSubscriptionUrl'] = $form->_paymentObject->subscriptionURL();
  66     }
  67
  68     //checks after setting $form->_paymentProcessor
  69     // we do this outside of the above conditional to avoid
  70     // saving the country/state list in the session (which could be huge)
  71
  72     if (($form->_paymentProcessor['billing_mode'] & CRM_Core_Payment::BILLING_MODE_FORM) && !empty($form->_values['is_monetary'])) {
  73       CRM_Core_Payment_Form::setPaymentFieldsByType($form->_paymentProcessor['payment_type'], $form);
  74     }
  75
  76     $form->assign_by_ref('paymentProcessor', $form->_paymentProcessor);
  77
  78     // check if this is a paypal auto return and redirect accordingly
  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       CRM_Core_Error::fatal(ts('Payment processor is not set for this page'));
  90     }
  91
  92     if (!empty($form->_membershipBlock) && !empty($form->_membershipBlock['is_separate_payment']) &&
  93       (!empty($form->_paymentProcessor['class_name']) &&
  94         !(CRM_Utils_Array::value('billing_mode', $form->_paymentProcessor) & CRM_Core_Payment::BILLING_MODE_FORM)
  95       )
  96     ) {
  97
  98       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',
  99           array(1 => $form->_paymentProcessor['payment_processor_type'])
 100         )
 101       );
 102     }
 103   }
 104
 105   /**
 106    * @param $form
 107    */
 108   static function buildQuickform(&$form) {
 109     $form->addElement('hidden', 'hidden_processor', 1);
 110
 111     $profileAddressFields = $form->get('profileAddressFields');
 112     if (!empty($profileAddressFields)) {
 113       $form->assign('profileAddressFields', $profileAddressFields);
 114     }
 115
 116     // check if show billing setting is enabled
 117     if ($form->getVar( '_ppType' ) == 0 && $form->_isBillingAddressRequiredForPayLater) {
 118       CRM_Core_Payment_Form::buildAddressBlock($form);
 119       return;
 120     }
 121
 122     // before we do this lets see if the payment processor has implemented a buildForm method
 123     if (method_exists($form->_paymentProcessor['instance'], 'buildForm') &&
 124       is_callable(array($form->_paymentProcessor['instance'], 'buildForm'))) {
 125       // the payment processor implements the buildForm function, let the payment
 126       // processor do the work
 127       $form->_paymentProcessor['instance']->buildForm($form);
 128       return;
 129     }
 130
 131     if (($form->_paymentProcessor['payment_type'] & CRM_Core_Payment::PAYMENT_TYPE_DIRECT_DEBIT)) {
 132       CRM_Core_Payment_Form::buildDirectDebit($form, TRUE);
 133     }
 134     elseif (($form->_paymentProcessor['payment_type'] & CRM_Core_Payment::PAYMENT_TYPE_CREDIT_CARD)) {
 135       CRM_Core_Payment_Form::buildCreditCard($form, TRUE);
 136     }
 137   }
 138 }
 139