3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * Class for constructing the payment processor block.
16 * @copyright CiviCRM LLC https://civicrm.org/licensing
18 class CRM_Core_Payment_Form
{
21 * Add payment fields depending on payment processor.
23 * The payment processor can implement the following functions to override the built in fields.
25 * - getPaymentFormFields()
26 * - getPaymentFormFieldsMetadata()
27 * (planned - getBillingDetailsFormFields(), getBillingDetailsFormFieldsMetadata()
29 * Note that this code is written to accommodate the possibility CiviCRM will switch to implementing pay later as a manual processor in future
31 * @param CRM_Contribute_Form_AbstractEditPayment|CRM_Contribute_Form_Contribution_Main $form
32 * @param array $processor
33 * Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors.
34 * @param int $billing_profile_id
35 * Display billing fields even for pay later.
36 * @param bool $isBackOffice
37 * Is this a back office function? If so the option to suppress the cvn needs to be evaluated.
38 * @param int $paymentInstrumentID
39 * ID of the payment processor.
41 public static function setPaymentFieldsByProcessor(&$form, $processor, $billing_profile_id = NULL, $isBackOffice = FALSE, $paymentInstrumentID = NULL) {
42 $form->billingFieldSets
= [];
43 // Load the pay-later processor
44 // @todo load this right up where the other processors are loaded initially.
45 if (empty($processor)) {
46 $processor = CRM_Financial_BAO_PaymentProcessor
::getPayment(0);
49 $processor['object']->setBillingProfile($billing_profile_id);
50 $processor['object']->setBackOffice($isBackOffice);
51 if (isset($paymentInstrumentID)) {
52 $processor['object']->setPaymentInstrumentID($paymentInstrumentID);
54 $paymentTypeName = self
::getPaymentTypeName($processor);
55 $form->assign('paymentTypeName', $paymentTypeName);
56 $form->assign('paymentTypeLabel', self
::getPaymentLabel($processor['object']));
57 $form->assign('isBackOffice', $isBackOffice);
58 $form->_paymentFields
= $form->billingFieldSets
[$paymentTypeName]['fields'] = self
::getPaymentFieldMetadata($processor);
59 $form->_paymentFields
= array_merge($form->_paymentFields
, self
::getBillingAddressMetadata($processor, $form->_bltID
));
60 $form->assign('paymentFields', self
::getPaymentFields($processor));
61 self
::setBillingAddressFields($form, $processor);
62 // @todo - this may be obsolete - although potentially it could be used to re-order things in the form.
63 $form->billingFieldSets
['billing_name_address-group']['fields'] = [];
67 * Add general billing fields.
69 * @param CRM_Core_Form $form
70 * @param CRM_Core_Payment $processor
72 protected static function setBillingAddressFields(&$form, $processor) {
73 $billingID = $form->_bltID
;
74 $smarty = CRM_Core_Smarty
::singleton();
75 $smarty->assign('billingDetailsFields', self
::getBillingAddressFields($processor, $billingID));
79 * Add the payment fields to the template.
81 * Generally this is the payment processor fields & the billing fields required
82 * for the payment processor. However, this has been complicated by adding
83 * pay later billing fields into this mix
85 * We now have the situation where the required fields cannot be set as required
86 * on the form level if they are required for the payment processor, as another
87 * processor might be selected and the validation will then be incorrect.
89 * However, if they are required for pay later we DO set them on the form level,
90 * presumably assuming they will be required whatever happens.
92 * As a side-note this seems to re-enforce the argument for making pay later
93 * operate as a payment processor rather than as a 'special thing on its own'.
95 * @param CRM_Core_Form $form
96 * Form that the payment fields are to be added to.
97 * @param array $paymentFields
98 * Fields that are to be shown on the payment form.
100 protected static function addCommonFields(&$form, $paymentFields) {
101 $requiredPaymentFields = $paymentFieldsMetadata = [];
102 foreach ($paymentFields as $name => $field) {
103 $field['extra'] = $field['extra'] ??
NULL;
104 if ($field['htmlType'] == 'chainSelect') {
105 $form->addChainSelect($field['name'], ['required' => FALSE]);
108 $form->add($field['htmlType'],
111 $field['attributes'],
116 // This will cause the fields to be marked as required - but it is up to the payment processor to
118 $requiredPaymentFields[$field['name']] = $field['is_required'];
119 $paymentFieldsMetadata[$field['name']] = $field;
122 $form->assign('paymentFieldsMetadata', $paymentFieldsMetadata);
123 $form->assign('requiredPaymentFields', $requiredPaymentFields);
127 * Get the payment fields that apply to this processor.
129 * @param array $paymentProcessor
131 * @todo sometimes things like the country alter the required fields (e.g direct debit fields). We should possibly
132 * set these before calling getPaymentFormFields (as we identify them).
136 public static function getPaymentFields($paymentProcessor) {
137 return $paymentProcessor['object']->getPaymentFormFields();
141 * @param array $paymentProcessor
145 public static function getPaymentFieldMetadata($paymentProcessor) {
146 return array_intersect_key($paymentProcessor['object']->getPaymentFormFieldsMetadata(), array_flip(self
::getPaymentFields($paymentProcessor)));
150 * Get the billing fields that apply to this processor.
152 * @param array $paymentProcessor
153 * @param int $billingLocationID
154 * ID of billing location type.
156 * @todo sometimes things like the country alter the required fields (e.g postal code). We should possibly
157 * set these before calling getPaymentFormFields (as we identify them).
161 public static function getBillingAddressFields($paymentProcessor, $billingLocationID) {
162 return $paymentProcessor['object']->getBillingAddressFields($billingLocationID);
166 * @param array $paymentProcessor
168 * @param int $billingLocationID
171 * @throws \CRM_Core_Exception
173 public static function getBillingAddressMetadata($paymentProcessor, $billingLocationID) {
174 $paymentProcessorObject = Civi\Payment\System
::singleton()->getByProcessor($paymentProcessor);
175 return array_intersect_key(
176 $paymentProcessorObject->getBillingAddressFieldsMetadata($billingLocationID),
177 array_flip(self
::getBillingAddressFields($paymentProcessor, $billingLocationID))
182 * @param array $paymentProcessor
186 public static function getPaymentTypeName($paymentProcessor) {
187 return $paymentProcessor['object']->getPaymentTypeName();
191 * @param CRM_Core_Payment $paymentProcessor
195 public static function getPaymentTypeLabel($paymentProcessor) {
196 return $paymentProcessor->getPaymentTypeLabel();
200 * @param CRM_Contribute_Form_AbstractEditPayment|CRM_Contribute_Form_Contribution_Main|CRM_Core_Payment_ProcessorForm|CRM_Contribute_Form_UpdateBilling $form
201 * @param array $processor
202 * Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors.
203 * @param int|string $billing_profile_id
204 * Id of a profile to be passed to the processor for the processor to merge with it's required fields.
205 * (currently only implemented by manual/ pay-later processor)
207 * @param bool $isBackOffice
208 * Is this a backoffice form. This could affect the display of the cvn or whether some processors show,
209 * although the distinction is losing it's meaning as front end forms are used for back office and a permission
210 * for the 'enter without cvn' is probably more appropriate. Paypal std does not support another user
211 * entering details but once again the issue is not back office but 'another user'.
212 * @param int $paymentInstrumentID
213 * Payment instrument ID.
215 public static function buildPaymentForm(&$form, $processor, $billing_profile_id, $isBackOffice, $paymentInstrumentID = NULL) {
216 //if the form has address fields assign to the template so the js can decide what billing fields to show
217 $profileAddressFields = $form->get('profileAddressFields');
218 if (!empty($profileAddressFields)) {
219 $form->assign('profileAddressFields', $profileAddressFields);
222 if (!empty($processor['object']) && $processor['object']->buildForm($form)) {
226 self
::setPaymentFieldsByProcessor($form, $processor, $billing_profile_id, $isBackOffice, $paymentInstrumentID);
227 self
::addCommonFields($form, $form->_paymentFields
);
228 self
::addRules($form, $form->_paymentFields
);
232 * @param CRM_Core_Form $form
233 * @param array $paymentFields
234 * Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors.
235 * @param $paymentFields
237 protected static function addRules(&$form, $paymentFields) {
238 foreach ($paymentFields as $paymentField => $fieldSpecs) {
239 if (!empty($fieldSpecs['rules'])) {
240 foreach ($fieldSpecs['rules'] as $rule) {
241 $form->addRule($paymentField,
242 $rule['rule_message'],
244 $rule['rule_parameters']
252 * Validate the payment instrument values before passing it to the payment processor.
254 * We want this to be able to be overridden by the payment processor, and default to using
255 * this object's validCreditCard for credit cards (implemented as the default in the Payment class).
257 * @param int $payment_processor_id
258 * @param array $values
259 * @param array $errors
260 * @param int $billing_profile_id
262 public static function validatePaymentInstrument($payment_processor_id, $values, &$errors, $billing_profile_id) {
263 $payment = Civi\Payment\System
::singleton()->getById($payment_processor_id);
264 $payment->setBillingProfile($billing_profile_id);
265 $payment->validatePaymentInstrument($values, $errors);
269 * Set default values for the form.
271 * @param CRM_Core_Form $form
272 * @param int $contactID
274 public static function setDefaultValues(&$form, $contactID) {
275 $billingDefaults = $form->getProfileDefaults('Billing', $contactID);
276 $form->_defaults
= array_merge($form->_defaults
, $billingDefaults);
278 // set default country & state from config if no country set
279 // note the effect of this is to set the billing country to default to the site default
280 // country if the person has an address but no country (for anonymous country is set above)
281 // this could have implications if the billing profile is filled but hidden.
282 // this behaviour has been in place for a while but the use of js to hide things has increased
283 if (empty($form->_defaults
["billing_country_id-{$form->_bltID}"])) {
284 $form->_defaults
["billing_country_id-{$form->_bltID}"] = CRM_Core_Config
::singleton()->defaultContactCountry
;
286 if (empty($form->_defaults
["billing_state_province_id-{$form->_bltID}"])) {
287 $form->_defaults
["billing_state_province_id-{$form->_bltID}"] = CRM_Core_Config
::singleton()
288 ->defaultContactStateProvince
;
293 * Make sure that credit card number and cvv are valid.
294 * Called within the scope of a QF formRule function
296 * @param array $values
297 * @param array $errors
298 * @param int $processorID
300 public static function validateCreditCard($values, &$errors, $processorID = NULL) {
301 if (!empty($values['credit_card_type']) ||
!empty($values['credit_card_number'])) {
302 if (!empty($values['credit_card_type'])) {
303 $processorCards = CRM_Financial_BAO_PaymentProcessor
::getCreditCards($processorID);
304 if (!empty($processorCards) && !in_array($values['credit_card_type'], $processorCards)) {
305 $errors['credit_card_type'] = ts('This processor does not support credit card type %1', [1 => $values['credit_card_type']]);
308 if (!empty($values['credit_card_number']) &&
309 !CRM_Utils_Rule
::creditCardNumber($values['credit_card_number'], $values['credit_card_type'])
311 $errors['credit_card_number'] = ts('Please enter a valid Card Number');
313 if (!empty($values['cvv2']) &&
314 !CRM_Utils_Rule
::cvv($values['cvv2'], $values['credit_card_type'])
316 $errors['cvv2'] = ts('Please enter a valid Card Verification Number');
322 * Map address fields.
327 * @param bool $reverse
329 public static function mapParams($id, $src, &$dst, $reverse = FALSE) {
331 'first_name' => 'billing_first_name',
332 'middle_name' => 'billing_middle_name',
333 'last_name' => 'billing_last_name',
334 'email' => "email-$id",
335 'street_address' => "billing_street_address-$id",
336 'supplemental_address_1' => "billing_supplemental_address_1-$id",
337 'city' => "billing_city-$id",
338 'state_province' => "billing_state_province-$id",
339 'postal_code' => "billing_postal_code-$id",
340 'country' => "billing_country-$id",
341 'contactID' => 'contact_id',
344 foreach ($map as $n => $v) {
346 if (isset($src[$n])) {
351 if (isset($src[$v])) {
357 //CRM-19469 provide option for returning modified params
362 * Get the credit card expiration month.
363 * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
370 public static function getCreditCardExpirationMonth($src) {
371 if ($month = CRM_Utils_Array
::value('M', $src['credit_card_exp_date'])) {
375 return $src['credit_card_exp_date']['m'] ??
NULL;
379 * Get the credit card expiration year.
380 * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
381 * This function exists only to make it consistent with getCreditCardExpirationMonth
387 public static function getCreditCardExpirationYear($src) {
388 return $src['credit_card_exp_date']['Y'] ??
NULL;
392 * Get the label for the processor.
394 * We do not use a label if there are no enterable fields.
396 * @param \CRM_Core_Payment $processor
400 public static function getPaymentLabel($processor) {
402 $paymentTypeLabel = self
::getPaymentTypeLabel($processor);
403 foreach (self
::getPaymentFieldMetadata(['object' => $processor]) as $paymentField) {
404 if ($paymentField['htmlType'] !== 'hidden') {
408 return $isVisible ?
$paymentTypeLabel : '';