3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Core_Payment_Form
{
38 * Add payment fields are depending on payment type
40 * @param int $type eg CRM_Core_Payment::PAYMENT_TYPE_DIRECT_DEBIT
41 * @param CRM_Core_Form $form
43 static public function setPaymentFieldsByType($type, &$form) {
44 if ($type & CRM_Core_Payment
::PAYMENT_TYPE_DIRECT_DEBIT
) {
45 CRM_Core_Payment_Form
::setDirectDebitFields($form);
48 CRM_Core_Payment_Form
::setCreditCardFields($form);
53 * create all common fields needed for a credit card or direct debit transaction
60 static protected function _setPaymentFields(&$form) {
61 $bltID = $form->_bltID
;
63 $form->_paymentFields
['billing_first_name'] = array(
65 'name' => 'billing_first_name',
66 'title' => ts('Billing First Name'),
68 'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
69 'is_required' => TRUE,
72 $form->_paymentFields
['billing_middle_name'] = array(
74 'name' => 'billing_middle_name',
75 'title' => ts('Billing Middle Name'),
77 'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
78 'is_required' => FALSE,
81 $form->_paymentFields
['billing_last_name'] = array(
83 'name' => 'billing_last_name',
84 'title' => ts('Billing Last Name'),
86 'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
87 'is_required' => TRUE,
90 $form->_paymentFields
["billing_street_address-{$bltID}"] = array(
92 'name' => "billing_street_address-{$bltID}",
93 'title' => ts('Street Address'),
95 'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
96 'is_required' => TRUE,
99 $form->_paymentFields
["billing_city-{$bltID}"] = array(
100 'htmlType' => 'text',
101 'name' => "billing_city-{$bltID}",
102 'title' => ts('City'),
104 'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
105 'is_required' => TRUE,
108 $form->_paymentFields
["billing_state_province_id-{$bltID}"] = array(
109 'htmlType' => 'select',
110 'name' => "billing_state_province_id-{$bltID}",
111 'title' => ts('State / Province'),
113 'attributes' => array(
114 '' => ts('- select -')) +
115 CRM_Core_PseudoConstant
::stateProvince(),
116 'is_required' => self
::checkRequiredStateProvince($form, "billing_country_id-{$bltID}"),
119 $form->_paymentFields
["billing_postal_code-{$bltID}"] = array(
120 'htmlType' => 'text',
121 'name' => "billing_postal_code-{$bltID}",
122 'title' => ts('Postal Code'),
124 'attributes' => array('size' => 30, 'maxlength' => 60, 'autocomplete' => 'off'),
125 'is_required' => TRUE,
128 $form->_paymentFields
["billing_country_id-{$bltID}"] = array(
129 'htmlType' => 'select',
130 'name' => "billing_country_id-{$bltID}",
131 'title' => ts('Country'),
133 'attributes' => array(
134 '' => ts('- select -')) +
135 CRM_Core_PseudoConstant
::country(),
136 'is_required' => TRUE,
141 * create all fields needed for a credit card transaction
148 static function setCreditCardFields(&$form) {
149 CRM_Core_Payment_Form
::_setPaymentFields($form);
151 $form->_paymentFields
['credit_card_number'] = array(
152 'htmlType' => 'text',
153 'name' => 'credit_card_number',
154 'title' => ts('Card Number'),
156 'attributes' => array('size' => 20, 'maxlength' => 20, 'autocomplete' => 'off'),
157 'is_required' => TRUE,
160 $form->_paymentFields
['cvv2'] = array(
161 'htmlType' => 'text',
163 'title' => ts('Security Code'),
165 'attributes' => array('size' => 5, 'maxlength' => 10, 'autocomplete' => 'off'),
166 'is_required' => CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
,
167 'cvv_backoffice_required',
173 $form->_paymentFields
['credit_card_exp_date'] = array(
174 'htmlType' => 'date',
175 'name' => 'credit_card_exp_date',
176 'title' => ts('Expiration Date'),
178 'attributes' => CRM_Core_SelectValues
::date('creditCard'),
179 'is_required' => TRUE,
182 $creditCardType = array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::creditCard();
183 $form->_paymentFields
['credit_card_type'] = array(
184 'htmlType' => 'select',
185 'name' => 'credit_card_type',
186 'title' => ts('Card Type'),
188 'attributes' => $creditCardType,
189 'is_required' => FALSE,
194 * create all fields needed for direct debit transaction
201 static function setDirectDebitFields(&$form) {
202 CRM_Core_Payment_Form
::_setPaymentFields($form);
204 $form->_paymentFields
['account_holder'] = array(
205 'htmlType' => 'text',
206 'name' => 'account_holder',
207 'title' => ts('Account Holder'),
209 'attributes' => array('size' => 20, 'maxlength' => 34, 'autocomplete' => 'on'),
210 'is_required' => TRUE,
213 //e.g. IBAN can have maxlength of 34 digits
214 $form->_paymentFields
['bank_account_number'] = array(
215 'htmlType' => 'text',
216 'name' => 'bank_account_number',
217 'title' => ts('Bank Account Number'),
219 'attributes' => array('size' => 20, 'maxlength' => 34, 'autocomplete' => 'off'),
220 'is_required' => TRUE,
223 //e.g. SWIFT-BIC can have maxlength of 11 digits
224 $form->_paymentFields
['bank_identification_number'] = array(
225 'htmlType' => 'text',
226 'name' => 'bank_identification_number',
227 'title' => ts('Bank Identification Number'),
229 'attributes' => array('size' => 20, 'maxlength' => 11, 'autocomplete' => 'off'),
230 'is_required' => TRUE,
233 $form->_paymentFields
['bank_name'] = array(
234 'htmlType' => 'text',
235 'name' => 'bank_name',
236 'title' => ts('Bank Name'),
238 'attributes' => array('size' => 20, 'maxlength' => 64, 'autocomplete' => 'off'),
239 'is_required' => TRUE,
244 * Function to add all the credit card fields
247 * @param bool $useRequired
252 static function buildCreditCard(&$form, $useRequired = FALSE) {
253 if ($form->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_FORM
) {
254 self
::setCreditCardFields($form);
255 foreach ($form->_paymentFields
as $name => $field) {
256 if (isset($field['cc_field']) &&
259 $form->add($field['htmlType'],
262 $field['attributes'],
263 $useRequired ?
$field['is_required'] : FALSE
268 $form->addRule('cvv2',
269 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.'),
273 $form->addRule('credit_card_exp_date',
274 ts('Card expiration date cannot be a past date.'),
278 // also take care of state country widget
279 $stateCountryMap = array(
280 1 => array('country' => "billing_country_id-{$form->_bltID}",
281 'state_province' => "billing_state_province_id-{$form->_bltID}",
283 CRM_Core_BAO_Address
::addStateCountryMap($stateCountryMap);
286 if ($form->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_BUTTON
) {
287 $form->_expressButtonName
= $form->getButtonName('upload', 'express');
288 $form->assign('expressButtonName', $form->_expressButtonName
);
290 $form->_expressButtonName
,
291 $form->_paymentProcessor
['url_button'],
292 array('class' => 'form-submit')
298 * The credit card pseudo constant results only the CC label, not the key ID
299 * So we normalize the name to use it as a CSS class.
301 static function getCreditCardCSSNames() {
302 $creditCardTypes = array();
303 foreach (CRM_Contribute_PseudoConstant
::creditCard() as $key => $name) {
304 // Replace anything not css-friendly by an underscore
305 // Non-latin names will not like this, but so many things are wrong with
306 // the credit-card type configurations already.
307 $key = str_replace(' ', '', $key);
308 $key = preg_replace('/[^a-zA-Z0-9]/', '_', $key);
309 $key = strtolower($key);
310 $creditCardTypes[$key] = $name;
312 return $creditCardTypes;
316 * Function to add all the direct debit fields
319 * @param bool $useRequired
323 static function buildDirectDebit(&$form, $useRequired = FALSE) {
324 if ($form->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_FORM
) {
325 self
::setDirectDebitFields($form);
326 foreach ($form->_paymentFields
as $name => $field) {
327 if (isset($field['cc_field']) &&
330 $form->add($field['htmlType'],
333 $field['attributes'],
334 $useRequired ?
$field['is_required'] : FALSE
339 $form->addRule('bank_identification_number',
340 ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
344 $form->addRule('bank_account_number',
345 ts('Please enter a valid Bank Account Number (value must not contain punctuation characters).'),
350 if ($form->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_BUTTON
) {
351 $form->_expressButtonName
= $form->getButtonName($form->buttonType(), 'express');
353 $form->_expressButtonName
,
354 $form->_paymentProcessor
['url_button'],
355 array('class' => 'form-submit')
361 * Make sure that credit card number and cvv are valid
362 * Called within the scope of a QF formRule function
364 static function validateCreditCard($values, &$errors) {
365 if (!empty($values['credit_card_type'])) {
366 if (!empty($values['credit_card_number']) &&
367 !CRM_Utils_Rule
::creditCardNumber($values['credit_card_number'], $values['credit_card_type'])
369 $errors['credit_card_number'] = ts('Please enter a valid Card Number');
371 if (!empty($values['cvv2']) &&
372 !CRM_Utils_Rule
::cvv($values['cvv2'], $values['credit_card_type'])
374 $errors['cvv2'] = ts('Please enter a valid Card Verification Number');
377 elseif (!empty($values['credit_card_number'])) {
378 $errors['credit_card_number'] = ts('Please enter a valid Card Number');
383 * function to map address fields
388 * @param bool $reverse
393 static function mapParams($id, &$src, &$dst, $reverse = FALSE) {
397 'first_name' => 'billing_first_name',
398 'middle_name' => 'billing_middle_name',
399 'last_name' => 'billing_last_name',
400 'email' => "email-$id",
401 'street_address' => "billing_street_address-$id",
402 'supplemental_address_1' => "billing_supplemental_address_1-$id",
403 'city' => "billing_city-$id",
404 'state_province' => "billing_state_province-$id",
405 'postal_code' => "billing_postal_code-$id",
406 'country' => "billing_country-$id",
410 foreach ($map as $n => $v) {
412 if (isset($src[$n])) {
417 if (isset($src[$v])) {
425 * function to get the credit card expiration month
426 * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
434 static function getCreditCardExpirationMonth($src) {
435 if ($month = CRM_Utils_Array
::value('M', $src['credit_card_exp_date'])) {
439 return CRM_Utils_Array
::value('m', $src['credit_card_exp_date']);
443 * function to get the credit card expiration year
444 * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
445 * This function exists only to make it consistant with getCreditCardExpirationMonth
452 static function getCreditCardExpirationYear($src) {
453 return CRM_Utils_Array
::value('Y', $src['credit_card_exp_date']);
457 * function to return state/province is_required = true/false
459 * @param obj $form: Form object
460 * @param string $name: Country index name on $_submitValues array
461 * @param bool $onBehalf: Is 'On Behalf Of' profile?
464 * TRUE/FALSE for is_required if country consist/not consist of state/province respectively
467 static function checkRequiredStateProvince($form, $name, $onBehalf = FALSE) {
468 // If selected country has possible values for state/province mark the
469 // state/province field as required.
470 $config = CRM_Core_Config
::singleton();
471 $stateProvince = new CRM_Core_DAO_StateProvince();
474 $stateProvince->country_id
= CRM_Utils_Array
::value($name, $form->_submitValues
['onbehalf']);
477 $stateProvince->country_id
= CRM_Utils_Array
::value($name, $form->_submitValues
);
480 $limitCountryId = $stateProvince->country_id
;
482 if ($stateProvince->count() > 0) {
483 // check that the state/province data is not excluded by a
484 // limitation in the localisation settings.
485 $countryIsoCodes = CRM_Core_PseudoConstant
::countryIsoCode();
486 $limitCodes = $config->provinceLimit();
488 foreach ($limitCodes as $code) {
489 $limitIds = array_merge($limitIds, array_keys($countryIsoCodes, $code));
492 if ($limitCountryId && in_array($limitCountryId, $limitIds)) {