CRM/Core/Payment/Form.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 class CRM_Core_Payment_Form {
  36
  37   /**
  38    * Add payment fields are depending on payment type
  39    *
  40    * @param int $type eg CRM_Core_Payment::PAYMENT_TYPE_DIRECT_DEBIT
  41    * @param CRM_Core_Form $form
  42    */
  43   static public function setPaymentFieldsByType($type, &$form) {
  44     if ($type & CRM_Core_Payment::PAYMENT_TYPE_DIRECT_DEBIT) {
  45       CRM_Core_Payment_Form::setDirectDebitFields($form);
  46     }
  47     else {
  48       CRM_Core_Payment_Form::setCreditCardFields($form);
  49     }
  50   }
  51
  52   /**
  53    * create all common fields needed for a credit card or direct debit transaction
  54    *
  55    * @param $form
  56    *
  57    * @return void
  58    * @access protected
  59    */
  60   static protected function _setPaymentFields(&$form) {
  61     $bltID = $form->_bltID;
  62
  63     $form->_paymentFields['billing_first_name'] = array(
  64       'htmlType' => 'text',
  65       'name' => 'billing_first_name',
  66       'title' => ts('Billing First Name'),
  67       'cc_field' => TRUE,
  68       'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
  69       'is_required' => TRUE,
  70     );
  71
  72     $form->_paymentFields['billing_middle_name'] = array(
  73       'htmlType' => 'text',
  74       'name' => 'billing_middle_name',
  75       'title' => ts('Billing Middle Name'),
  76       'cc_field' => TRUE,
  77       'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
  78       'is_required' => FALSE,
  79     );
  80
  81     $form->_paymentFields['billing_last_name'] = array(
  82       'htmlType' => 'text',
  83       'name' => 'billing_last_name',
  84       'title' => ts('Billing Last Name'),
  85       'cc_field' => TRUE,
  86       'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
  87       'is_required' => TRUE,
  88     );
  89
  90     $form->_paymentFields["billing_street_address-{$bltID}"] = array(
  91       'htmlType' => 'text',
  92       'name' => "billing_street_address-{$bltID}",
  93       'title' => ts('Street Address'),
  94       'cc_field' => TRUE,
  95       'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
  96       'is_required' => TRUE,
  97     );
  98
  99     $form->_paymentFields["billing_city-{$bltID}"] = array(
 100       'htmlType' => 'text',
 101       'name' => "billing_city-{$bltID}",
 102       'title' => ts('City'),
 103       'cc_field' => TRUE,
 104       'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
 105       'is_required' => TRUE,
 106     );
 107
 108     $form->_paymentFields["billing_state_province_id-{$bltID}"] = array(
 109       'htmlType' => 'chainSelect',
 110       'title' => ts('State/Province'),
 111       'name' => "billing_state_province_id-{$bltID}",
 112       'cc_field' => TRUE,
 113       'is_required' => TRUE,
 114     );
 115
 116     $form->_paymentFields["billing_postal_code-{$bltID}"] = array(
 117       'htmlType' => 'text',
 118       'name' => "billing_postal_code-{$bltID}",
 119       'title' => ts('Postal Code'),
 120       'cc_field' => TRUE,
 121       'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
 122       'is_required' => TRUE,
 123     );
 124
 125     $form->_paymentFields["billing_country_id-{$bltID}"] = array(
 126       'htmlType' => 'select',
 127       'name' => "billing_country_id-{$bltID}",
 128       'title' => ts('Country'),
 129       'cc_field' => TRUE,
 130       'attributes' => array(
 131         '' => ts('- select -')) +
 132       CRM_Core_PseudoConstant::country(),
 133       'is_required' => TRUE,
 134     );
 135   }
 136
 137   /**
 138    * create all fields needed for a credit card transaction
 139    *
 140    * @param CRM_Core_Form $form
 141    *
 142    * @return void
 143    * @access public
 144    */
 145   static function setCreditCardFields(&$form) {
 146     CRM_Core_Payment_Form::_setPaymentFields($form);
 147
 148     $form->_paymentFields['credit_card_number'] = array(
 149       'htmlType' => 'text',
 150       'name' => 'credit_card_number',
 151       'title' => ts('Card Number'),
 152       'cc_field' => TRUE,
 153       'attributes' => array('size' => 20, 'maxlength' => 20, 'autocomplete' => 'off'),
 154       'is_required' => TRUE,
 155     );
 156
 157     $form->_paymentFields['cvv2'] = array(
 158       'htmlType' => 'text',
 159       'name' => 'cvv2',
 160       'title' => ts('Security Code'),
 161       'cc_field' => TRUE,
 162       'attributes' => array('size' => 5, 'maxlength' => 10, 'autocomplete' => 'off'),
 163       'is_required' => CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME,
 164         'cvv_backoffice_required',
 165         NULL
 166         ,1
 167       ),
 168     );
 169
 170     $form->_paymentFields['credit_card_exp_date'] = array(
 171       'htmlType' => 'date',
 172       'name' => 'credit_card_exp_date',
 173       'title' => ts('Expiration Date'),
 174       'cc_field' => TRUE,
 175       'attributes' => CRM_Core_SelectValues::date('creditCard'),
 176       'is_required' => TRUE,
 177     );
 178
 179     $creditCardType = array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::creditCard();
 180     $form->_paymentFields['credit_card_type'] = array(
 181       'htmlType' => 'select',
 182       'name' => 'credit_card_type',
 183       'title' => ts('Card Type'),
 184       'cc_field' => TRUE,
 185       'attributes' => $creditCardType,
 186       'is_required' => FALSE,
 187     );
 188   }
 189
 190   /**
 191    * @param CRM_Core_Form $form
 192    */
 193   static function addCommonFields(&$form, $useRequired) {
 194     foreach ($form->_paymentFields as $name => $field) {
 195       if (!empty($field['cc_field'])) {
 196         if ($field['htmlType'] == 'chainSelect') {
 197           $form->addChainSelect($field['name'], array('required' => $useRequired && $field['is_required']));
 198         }
 199         else {
 200           $form->add($field['htmlType'],
 201             $field['name'],
 202             $field['title'],
 203             $field['attributes'],
 204             $useRequired ? $field['is_required'] : FALSE
 205           );
 206         }
 207       }
 208     }
 209   }
 210
 211   /**
 212    * create all fields needed for direct debit transaction
 213    *
 214    * @param $form
 215    *
 216    * @return void
 217    * @access public
 218    */
 219   static function setDirectDebitFields(&$form) {
 220     CRM_Core_Payment_Form::_setPaymentFields($form);
 221
 222     $form->_paymentFields['account_holder'] = array(
 223       'htmlType' => 'text',
 224       'name' => 'account_holder',
 225       'title' => ts('Account Holder'),
 226       'cc_field' => TRUE,
 227       'attributes' => array('size' => 20, 'maxlength' => 34, 'autocomplete' => 'on'),
 228       'is_required' => TRUE,
 229     );
 230
 231     //e.g. IBAN can have maxlength of 34 digits
 232     $form->_paymentFields['bank_account_number'] = array(
 233       'htmlType' => 'text',
 234       'name' => 'bank_account_number',
 235       'title' => ts('Bank Account Number'),
 236       'cc_field' => TRUE,
 237       'attributes' => array('size' => 20, 'maxlength' => 34, 'autocomplete' => 'off'),
 238       'is_required' => TRUE,
 239     );
 240
 241     //e.g. SWIFT-BIC can have maxlength of 11 digits
 242     $form->_paymentFields['bank_identification_number'] = array(
 243       'htmlType' => 'text',
 244       'name' => 'bank_identification_number',
 245       'title' => ts('Bank Identification Number'),
 246       'cc_field' => TRUE,
 247       'attributes' => array('size' => 20, 'maxlength' => 11, 'autocomplete' => 'off'),
 248       'is_required' => TRUE,
 249     );
 250
 251     $form->_paymentFields['bank_name'] = array(
 252       'htmlType' => 'text',
 253       'name' => 'bank_name',
 254       'title' => ts('Bank Name'),
 255       'cc_field' => TRUE,
 256       'attributes' => array('size' => 20, 'maxlength' => 64, 'autocomplete' => 'off'),
 257       'is_required' => TRUE,
 258     );
 259   }
 260
 261   /**
 262    * Function to add all the credit card fields
 263    *
 264    * @param $form
 265    * @param bool $useRequired
 266    *
 267    * @return void
 268    * @access public
 269    */
 270   static function buildCreditCard(&$form, $useRequired = FALSE) {
 271     if ($form->_paymentProcessor['billing_mode'] & CRM_Core_Payment::BILLING_MODE_FORM) {
 272       self::setCreditCardFields($form);
 273       self::addCommonFields($form, $useRequired);
 274
 275       $form->addRule('cvv2',
 276         ts('Please enter a valid value for your card security code. This is usually the last 3-4 digits on the card\'s signature panel.'),
 277         'integer'
 278       );
 279
 280       $form->addRule('credit_card_exp_date',
 281         ts('Card expiration date cannot be a past date.'),
 282         'currentDate', TRUE
 283       );
 284
 285     }
 286
 287     if ($form->_paymentProcessor['billing_mode'] & CRM_Core_Payment::BILLING_MODE_BUTTON) {
 288       $form->_expressButtonName = $form->getButtonName('upload', 'express');
 289       $form->assign('expressButtonName', $form->_expressButtonName);
 290       $form->add('image',
 291         $form->_expressButtonName,
 292         $form->_paymentProcessor['url_button'],
 293         array('class' => 'crm-form-submit')
 294       );
 295     }
 296   }
 297
 298   /**
 299    * The credit card pseudo constant results only the CC label, not the key ID
 300    * So we normalize the name to use it as a CSS class.
 301    */
 302   static function getCreditCardCSSNames() {
 303     $creditCardTypes = array();
 304     foreach (CRM_Contribute_PseudoConstant::creditCard() as $key => $name) {
 305       // Replace anything not css-friendly by an underscore
 306       // Non-latin names will not like this, but so many things are wrong with
 307       // the credit-card type configurations already.
 308       $key = str_replace(' ', '', $key);
 309       $key = preg_replace('/[^a-zA-Z0-9]/', '_', $key);
 310       $key = strtolower($key);
 311       $creditCardTypes[$key] = $name;
 312     }
 313     return $creditCardTypes;
 314   }
 315
 316   /**
 317    * Function to add all the direct debit fields
 318    *
 319    * @param $form
 320    * @param bool $useRequired
 321    * @return void
 322    * @access public
 323    */
 324   static function buildDirectDebit(&$form, $useRequired = FALSE) {
 325     if ($form->_paymentProcessor['billing_mode'] & CRM_Core_Payment::BILLING_MODE_FORM) {
 326       self::setDirectDebitFields($form);
 327       self::addCommonFields($form, $useRequired);
 328
 329       $form->addRule('bank_identification_number',
 330         ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
 331         'nopunctuation'
 332       );
 333
 334       $form->addRule('bank_account_number',
 335         ts('Please enter a valid Bank Account Number (value must not contain punctuation characters).'),
 336         'nopunctuation'
 337       );
 338     }
 339
 340     if ($form->_paymentProcessor['billing_mode'] & CRM_Core_Payment::BILLING_MODE_BUTTON) {
 341       $form->_expressButtonName = $form->getButtonName($form->buttonType(), 'express');
 342       $form->add('image',
 343         $form->_expressButtonName,
 344         $form->_paymentProcessor['url_button'],
 345         array('class' => 'crm-form-submit')
 346       );
 347     }
 348   }
 349
 350   /**
 351    * Make sure that credit card number and cvv are valid
 352    * Called within the scope of a QF formRule function
 353    */
 354   static function validateCreditCard($values, &$errors) {
 355     if (!empty($values['credit_card_type'])) {
 356       if (!empty($values['credit_card_number']) &&
 357         !CRM_Utils_Rule::creditCardNumber($values['credit_card_number'], $values['credit_card_type'])
 358       ) {
 359         $errors['credit_card_number'] = ts('Please enter a valid Card Number');
 360       }
 361       if (!empty($values['cvv2']) &&
 362         !CRM_Utils_Rule::cvv($values['cvv2'], $values['credit_card_type'])
 363       ) {
 364         $errors['cvv2'] = ts('Please enter a valid Card Verification Number');
 365       }
 366     }
 367     elseif (!empty($values['credit_card_number'])) {
 368       $errors['credit_card_number'] = ts('Please enter a valid Card Number');
 369     }
 370   }
 371
 372   /**
 373    * function to map address fields
 374    *
 375    * @param $id
 376    * @param $src
 377    * @param $dst
 378    * @param bool $reverse
 379    *
 380    * @return void
 381    * @static
 382    */
 383   static function mapParams($id, &$src, &$dst, $reverse = FALSE) {
 384     static $map = NULL;
 385     if (!$map) {
 386       $map = array(
 387         'first_name' => 'billing_first_name',
 388         'middle_name' => 'billing_middle_name',
 389         'last_name' => 'billing_last_name',
 390         'email' => "email-$id",
 391         'street_address' => "billing_street_address-$id",
 392         'supplemental_address_1' => "billing_supplemental_address_1-$id",
 393         'city' => "billing_city-$id",
 394         'state_province' => "billing_state_province-$id",
 395         'postal_code' => "billing_postal_code-$id",
 396         'country' => "billing_country-$id",
 397       );
 398     }
 399
 400     foreach ($map as $n => $v) {
 401       if (!$reverse) {
 402         if (isset($src[$n])) {
 403           $dst[$v] = $src[$n];
 404         }
 405       }
 406       else {
 407         if (isset($src[$v])) {
 408           $dst[$n] = $src[$v];
 409         }
 410       }
 411     }
 412   }
 413
 414   /**
 415    * function to get the credit card expiration month
 416    * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
 417    * See CRM-9017
 418    *
 419    * @param $src
 420    *
 421    * @return int
 422    * @static
 423    */
 424   static function getCreditCardExpirationMonth($src) {
 425     if ($month = CRM_Utils_Array::value('M', $src['credit_card_exp_date'])) {
 426       return $month;
 427     }
 428
 429     return CRM_Utils_Array::value('m', $src['credit_card_exp_date']);
 430   }
 431
 432   /**
 433    * function to get the credit card expiration year
 434    * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
 435    * This function exists only to make it consistant with getCreditCardExpirationMonth
 436    *
 437    * @param $src
 438    *
 439    * @return int
 440    * @static
 441    */
 442   static function getCreditCardExpirationYear($src) {
 443     return CRM_Utils_Array::value('Y', $src['credit_card_exp_date']);
 444   }
 445
 446 }
 447