Commit | Line | Data |
---|---|---|
aaff4c69 EM |
1 | <?php |
2 | /* | |
4f6cdd27 | 3 | +--------------------------------------------------------------------+ |
fee14197 | 4 | | CiviCRM version 5 | |
4f6cdd27 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
4f6cdd27 EM |
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 | +--------------------------------------------------------------------+ | |
aaff4c69 EM |
26 | */ |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
aaff4c69 EM |
32 | */ |
33 | class CRM_Financial_Form_Payment extends CRM_Core_Form { | |
1d1fee72 | 34 | |
35 | /** | |
36 | * @var int | |
37 | */ | |
38 | protected $_paymentProcessorID; | |
f61437d3 | 39 | protected $currency; |
a55e39e9 | 40 | |
be2fb01f | 41 | public $_values = []; |
1d1fee72 | 42 | |
43 | /** | |
44 | * @var array | |
45 | */ | |
46 | public $_paymentProcessor; | |
18135422 | 47 | |
48 | /** | |
49 | * @var bool | |
50 | */ | |
51 | public $isBackOffice = FALSE; | |
52 | ||
fb5e89bc SP |
53 | /** |
54 | * @var String | |
55 | */ | |
56 | public $_formName = ''; | |
57 | ||
aaff4c69 EM |
58 | /** |
59 | * Set variables up before form is built. | |
aaff4c69 EM |
60 | */ |
61 | public function preProcess() { | |
62 | parent::preProcess(); | |
423b9af4 | 63 | |
fb5e89bc SP |
64 | $this->_formName = CRM_Utils_Request::retrieve('formName', 'String', $this); |
65 | ||
d38c288e | 66 | $this->_values['custom_pre_id'] = CRM_Utils_Request::retrieve('pre_profile_id', 'Integer', $this); |
423b9af4 | 67 | |
aaff4c69 EM |
68 | $this->_paymentProcessorID = CRM_Utils_Request::retrieve('processor_id', 'Integer', CRM_Core_DAO::$_nullObject, |
69 | TRUE); | |
f61437d3 K |
70 | $this->currency = CRM_Utils_Request::retrieve('currency', 'String', CRM_Core_DAO::$_nullObject, |
71 | TRUE); | |
aaff4c69 | 72 | |
18135422 | 73 | $this->paymentInstrumentID = CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer'); |
74 | $this->isBackOffice = CRM_Utils_Request::retrieve('is_back_office', 'Integer'); | |
75 | ||
aaff4c69 EM |
76 | $this->assignBillingType(); |
77 | ||
a9768188 | 78 | $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($this->_paymentProcessorID); |
1d1fee72 | 79 | |
aaff4c69 EM |
80 | CRM_Core_Payment_ProcessorForm::preProcess($this); |
81 | ||
d87cd28c | 82 | $this->assign('suppressForm', TRUE); |
a38068fe | 83 | $this->controller->_generateQFKey = FALSE; |
bc44463a CW |
84 | } |
85 | ||
f61437d3 | 86 | /** |
fdcab137 | 87 | * Get currency |
88 | * | |
89 | * @param array $submittedValues | |
90 | * Required for consistency with other form methods. | |
91 | * | |
f61437d3 K |
92 | * @return string |
93 | */ | |
be2fb01f | 94 | public function getCurrency($submittedValues = []) { |
f61437d3 K |
95 | return $this->currency; |
96 | } | |
97 | ||
1d1fee72 | 98 | /** |
99 | * Build quickForm. | |
100 | */ | |
bc44463a CW |
101 | public function buildQuickForm() { |
102 | CRM_Core_Payment_ProcessorForm::buildQuickForm($this); | |
103 | } | |
104 | ||
70d1766d | 105 | /** |
106 | * Set default values for the form. | |
107 | */ | |
108 | public function setDefaultValues() { | |
109 | $contactID = $this->getContactID(); | |
110 | CRM_Core_Payment_Form::setDefaultValues($this, $contactID); | |
111 | return $this->_defaults; | |
112 | } | |
113 | ||
bc44463a | 114 | /** |
1d1fee72 | 115 | * Add JS to show icons for the accepted credit cards. |
bf48aa29 | 116 | * |
117 | * @param int $paymentProcessorID | |
9b2e3ee6 | 118 | * @param string $region |
bc44463a | 119 | */ |
9b2e3ee6 | 120 | public static function addCreditCardJs($paymentProcessorID = NULL, $region = 'billing-block') { |
cb5962bd | 121 | $creditCards = CRM_Financial_BAO_PaymentProcessor::getCreditCards($paymentProcessorID); |
ce895597 | 122 | if (empty($creditCards)) { |
123 | $creditCards = CRM_Contribute_PseudoConstant::creditCard(); | |
124 | } | |
125 | $creditCardTypes = []; | |
126 | foreach ($creditCards as $name => $label) { | |
127 | $creditCardTypes[$name] = [ | |
128 | 'label' => $label, | |
129 | 'name' => $name, | |
130 | 'css_key' => self::getCssLabelFriendlyName($name), | |
131 | 'pattern' => self::getCardPattern($name), | |
132 | ]; | |
133 | } | |
134 | ||
aaff4c69 | 135 | CRM_Core_Resources::singleton() |
7b9cb12a | 136 | // CRM-20516: add BillingBlock script on billing-block region |
137 | // to support this feature in payment form snippet too. | |
9b2e3ee6 | 138 | ->addScriptFile('civicrm', 'templates/CRM/Core/BillingBlock.js', 10, $region, FALSE) |
aaff4c69 EM |
139 | // workaround for CRM-13634 |
140 | // ->addSetting(array('config' => array('creditCardTypes' => $creditCardTypes))); | |
9b2e3ee6 | 141 | ->addScript('CRM.config.creditCardTypes = ' . json_encode($creditCardTypes) . ';', '-9999', $region); |
aaff4c69 EM |
142 | } |
143 | ||
ce895597 | 144 | /** |
145 | * Get css friendly labels for credit cards. | |
146 | * | |
147 | * We add the icons based on these css names which are lower cased | |
148 | * and only AlphaNumeric (+ _). | |
149 | * | |
150 | * @param $key | |
151 | * | |
152 | * @return string | |
153 | */ | |
154 | protected static function getCssLabelFriendlyName($key) { | |
155 | $key = str_replace(' ', '', $key); | |
156 | $key = preg_replace('/[^a-zA-Z0-9]/', '_', $key); | |
157 | $key = strtolower($key); | |
158 | ||
159 | return $key; | |
160 | } | |
161 | ||
162 | /** | |
163 | * Get the pattern that can be used to determine the card type. | |
164 | * | |
165 | * We do a strotolower comparison as we don't know what case people might have if they | |
166 | * are using a non-std one like dinersclub. | |
167 | * | |
168 | * @param $key | |
169 | * | |
170 | * Based on http://davidwalsh.name/validate-credit-cards | |
171 | * See also https://en.wikipedia.org/wiki/Credit_card_numbers | |
172 | * | |
173 | * @return string | |
174 | */ | |
175 | protected static function getCardPattern($key) { | |
176 | $cardMappings = [ | |
177 | '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}', | |
178 | 'visa' => '4(?:[0-9]{12}|[0-9]{15})', | |
179 | 'amex' => '3[47][0-9]{13}', | |
180 | 'dinersclub' => '3(?:0[0-5][0-9]{11}|[68][0-9]{12})', | |
181 | 'carteblanche' => '3(?:0[0-5][0-9]{11}|[68][0-9]{12})', | |
182 | 'discover' => '6011[0-9]{12}', | |
183 | 'jcb' => '(?:3[0-9]{15}|(2131|1800)[0-9]{11})', | |
184 | 'unionpay' => '62(?:[0-9]{14}|[0-9]{17})', | |
185 | ]; | |
186 | return isset($cardMappings[strtolower($key)]) ? $cardMappings[strtolower($key)] : ''; | |
187 | } | |
188 | ||
aaff4c69 | 189 | } |