3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
33 class CRM_Financial_Form_Payment
extends CRM_Core_Form
{
38 protected $_paymentProcessorID;
41 public $_values = array();
46 public $_paymentProcessor;
51 public $isBackOffice = FALSE;
56 public $_formName = '';
59 * Set variables up before form is built.
61 public function preProcess() {
64 $this->_formName
= CRM_Utils_Request
::retrieve('formName', 'String', $this);
66 $this->_values
['custom_pre_id'] = CRM_Utils_Request
::retrieve('pre_profile_id', 'Integer', $this);
68 $this->_paymentProcessorID
= CRM_Utils_Request
::retrieve('processor_id', 'Integer', CRM_Core_DAO
::$_nullObject,
70 $this->currency
= CRM_Utils_Request
::retrieve('currency', 'String', CRM_Core_DAO
::$_nullObject,
73 $this->paymentInstrumentID
= CRM_Utils_Request
::retrieve('payment_instrument_id', 'Integer');
74 $this->isBackOffice
= CRM_Utils_Request
::retrieve('is_back_office', 'Integer');
76 $this->assignBillingType();
78 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($this->_paymentProcessorID
);
80 CRM_Core_Payment_ProcessorForm
::preProcess($this);
82 self
::addCreditCardJs($this->_paymentProcessorID
);
84 $this->assign('paymentProcessorID', $this->_paymentProcessorID
);
85 $this->assign('currency', $this->currency
);
87 $this->assign('suppressForm', TRUE);
88 $this->controller
->_generateQFKey
= FALSE;
94 * @param array $submittedValues
95 * Required for consistency with other form methods.
99 public function getCurrency($submittedValues = array()) {
100 return $this->currency
;
106 public function buildQuickForm() {
107 CRM_Core_Payment_ProcessorForm
::buildQuickForm($this);
111 * Set default values for the form.
113 public function setDefaultValues() {
114 $contactID = $this->getContactID();
115 CRM_Core_Payment_Form
::setDefaultValues($this, $contactID);
116 return $this->_defaults
;
120 * Add JS to show icons for the accepted credit cards.
122 * @param int $paymentProcessorID
123 * @param string $region
125 public static function addCreditCardJs($paymentProcessorID = NULL, $region = 'billing-block') {
126 $creditCards = CRM_Financial_BAO_PaymentProcessor
::getCreditCards($paymentProcessorID);
127 if (empty($creditCards)) {
128 $creditCards = CRM_Contribute_PseudoConstant
::creditCard();
130 $creditCardTypes = [];
131 foreach ($creditCards as $name => $label) {
132 $creditCardTypes[$name] = [
135 'css_key' => self
::getCssLabelFriendlyName($name),
136 'pattern' => self
::getCardPattern($name),
140 CRM_Core_Resources
::singleton()
141 // CRM-20516: add BillingBlock script on billing-block region
142 // to support this feature in payment form snippet too.
143 ->addScriptFile('civicrm', 'templates/CRM/Core/BillingBlock.js', 10, $region, FALSE)
144 // workaround for CRM-13634
145 // ->addSetting(array('config' => array('creditCardTypes' => $creditCardTypes)));
146 ->addScript('CRM.config.creditCardTypes = ' . json_encode($creditCardTypes) . ';', '-9999', $region);
150 * Get css friendly labels for credit cards.
152 * We add the icons based on these css names which are lower cased
153 * and only AlphaNumeric (+ _).
159 protected static function getCssLabelFriendlyName($key) {
160 $key = str_replace(' ', '', $key);
161 $key = preg_replace('/[^a-zA-Z0-9]/', '_', $key);
162 $key = strtolower($key);
168 * Get the pattern that can be used to determine the card type.
170 * We do a strotolower comparison as we don't know what case people might have if they
171 * are using a non-std one like dinersclub.
175 * Based on http://davidwalsh.name/validate-credit-cards
176 * See also https://en.wikipedia.org/wiki/Credit_card_numbers
180 protected static function getCardPattern($key) {
182 'mastercard' => '(5[1-5][0-9]{2}|2[3-6][0-9]{2}|22[3-9][0-9]|222[1-9]|27[0-1][0-9]|2720)[0-9]{12}',
183 'visa' => '4(?:[0-9]{12}|[0-9]{15})',
184 'amex' => '3[47][0-9]{13}',
185 'dinersclub' => '3(?:0[0-5][0-9]{11}|[68][0-9]{12})',
186 'carteblanche' => '3(?:0[0-5][0-9]{11}|[68][0-9]{12})',
187 'discover' => '6011[0-9]{12}',
188 'jcb' => '(?:3[0-9]{15}|(2131|1800)[0-9]{11})',
189 'unionpay' => '62(?:[0-9]{14}|[0-9]{17})',
191 return isset($cardMappings[strtolower($key)]) ?
$cardMappings[strtolower($key)] : '';