| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 5 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 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 usefusul, 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-2019 |
| 32 | */ |
| 33 | |
| 34 | /** |
| 35 | * This class generates form components for processing a contribution |
| 36 | * CRM-16229 - During the event registration bulk action via search we |
| 37 | * need to inherit CRM_Contact_Form_Task so that we can inherit functions |
| 38 | * like getContactIds and make use of controller state. But this is not possible |
| 39 | * because CRM_Event_Form_Participant inherits this class. |
| 40 | * Ideal situation would be something like |
| 41 | * CRM_Event_Form_Participant extends CRM_Contact_Form_Task, |
| 42 | * CRM_Contribute_Form_AbstractEditPayment |
| 43 | * However this is not possible. Currently PHP does not support multiple |
| 44 | * inheritance. So work around solution is to extend this class with |
| 45 | * CRM_Contact_Form_Task which further extends CRM_Core_Form. |
| 46 | * |
| 47 | */ |
| 48 | class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task { |
| 49 | |
| 50 | use CRM_Financial_Form_SalesTaxTrait; |
| 51 | |
| 52 | public $_mode; |
| 53 | |
| 54 | public $_action; |
| 55 | |
| 56 | public $_bltID; |
| 57 | |
| 58 | public $_fields = []; |
| 59 | |
| 60 | /** |
| 61 | * Current payment processor including a copy of the object in 'object' key. |
| 62 | * |
| 63 | * @var array |
| 64 | */ |
| 65 | public $_paymentProcessor; |
| 66 | |
| 67 | /** |
| 68 | * Available recurring processors. |
| 69 | * |
| 70 | * @var array |
| 71 | */ |
| 72 | public $_recurPaymentProcessors = []; |
| 73 | |
| 74 | /** |
| 75 | * Array of processor options in the format id => array($id => $label) |
| 76 | * WARNING it appears that the format used to differ to this and there are places in the code that |
| 77 | * expect the old format. $this->_paymentProcessors provides the additional data which this |
| 78 | * array seems to have provided in the past |
| 79 | * @var array |
| 80 | */ |
| 81 | public $_processors; |
| 82 | |
| 83 | /** |
| 84 | * Available payment processors with full details including the key 'object' indexed by their id |
| 85 | * @var array |
| 86 | */ |
| 87 | protected $_paymentProcessors = []; |
| 88 | |
| 89 | /** |
| 90 | * Instance of the payment processor object. |
| 91 | * |
| 92 | * @var CRM_Core_Payment |
| 93 | */ |
| 94 | protected $_paymentObject; |
| 95 | |
| 96 | /** |
| 97 | * The id of the contribution that we are processing. |
| 98 | * |
| 99 | * @var int |
| 100 | */ |
| 101 | public $_id; |
| 102 | |
| 103 | /** |
| 104 | * Entity that $this->_id relates to. |
| 105 | * |
| 106 | * If set the contact id is not required in the url. |
| 107 | * |
| 108 | * @var string |
| 109 | */ |
| 110 | protected $entity; |
| 111 | |
| 112 | /** |
| 113 | * The id of the premium that we are proceessing. |
| 114 | * |
| 115 | * @var int |
| 116 | */ |
| 117 | public $_premiumID = NULL; |
| 118 | |
| 119 | /** |
| 120 | * @var CRM_Contribute_DAO_ContributionProduct |
| 121 | */ |
| 122 | public $_productDAO = NULL; |
| 123 | |
| 124 | /** |
| 125 | * The id of the note |
| 126 | * |
| 127 | * @var int |
| 128 | */ |
| 129 | public $_noteID; |
| 130 | |
| 131 | /** |
| 132 | * The id of the contact associated with this contribution |
| 133 | * |
| 134 | * @var int |
| 135 | */ |
| 136 | public $_contactID; |
| 137 | |
| 138 | /** |
| 139 | * The id of the pledge payment that we are processing |
| 140 | * |
| 141 | * @var int |
| 142 | */ |
| 143 | public $_ppID; |
| 144 | |
| 145 | /** |
| 146 | * The id of the pledge that we are processing |
| 147 | * |
| 148 | * @var int |
| 149 | */ |
| 150 | public $_pledgeID; |
| 151 | |
| 152 | /** |
| 153 | * Is this contribution associated with an online |
| 154 | * financial transaction |
| 155 | * |
| 156 | * @var bool |
| 157 | */ |
| 158 | public $_online = FALSE; |
| 159 | |
| 160 | /** |
| 161 | * Stores all product option |
| 162 | * |
| 163 | * @var array |
| 164 | */ |
| 165 | public $_options; |
| 166 | |
| 167 | /** |
| 168 | * Stores the honor id |
| 169 | * |
| 170 | * @var int |
| 171 | */ |
| 172 | public $_honorID = NULL; |
| 173 | |
| 174 | /** |
| 175 | * Store the financial Type ID |
| 176 | * |
| 177 | * @var array |
| 178 | */ |
| 179 | public $_contributionType; |
| 180 | |
| 181 | /** |
| 182 | * The contribution values if an existing contribution |
| 183 | * @var array |
| 184 | */ |
| 185 | public $_values; |
| 186 | |
| 187 | /** |
| 188 | * The pledge values if this contribution is associated with pledge |
| 189 | * @var array |
| 190 | */ |
| 191 | public $_pledgeValues; |
| 192 | |
| 193 | public $_contributeMode = 'direct'; |
| 194 | |
| 195 | public $_context; |
| 196 | |
| 197 | public $_compId; |
| 198 | |
| 199 | /** |
| 200 | * Store the line items if price set used. |
| 201 | * @var array |
| 202 | */ |
| 203 | public $_lineItems; |
| 204 | |
| 205 | /** |
| 206 | * Is this a backoffice form |
| 207 | * |
| 208 | * @var bool |
| 209 | */ |
| 210 | public $isBackOffice = TRUE; |
| 211 | |
| 212 | protected $_formType; |
| 213 | |
| 214 | /** |
| 215 | * Payment instrument id for the transaction. |
| 216 | * |
| 217 | * @var int |
| 218 | */ |
| 219 | public $paymentInstrumentID; |
| 220 | |
| 221 | /** |
| 222 | * Component - event, membership or contribution. |
| 223 | * |
| 224 | * @var string |
| 225 | */ |
| 226 | protected $_component; |
| 227 | |
| 228 | /** |
| 229 | * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should |
| 230 | * be all in this array in order like |
| 231 | * 'credit_card' => array('credit_card_number' ... |
| 232 | * 'billing_details' => array('first_name' ... |
| 233 | * |
| 234 | * such that both the fields and the order can be more easily altered by payment processors & other extensions |
| 235 | * @var array |
| 236 | */ |
| 237 | public $billingFieldSets = []; |
| 238 | |
| 239 | /** |
| 240 | * Monetary fields that may be submitted. |
| 241 | * |
| 242 | * These should get a standardised format in the beginPostProcess function. |
| 243 | * |
| 244 | * These fields are common to many forms. Some may override this. |
| 245 | * @var array |
| 246 | */ |
| 247 | protected $submittableMoneyFields = ['total_amount', 'net_amount', 'non_deductible_amount', 'fee_amount']; |
| 248 | |
| 249 | /** |
| 250 | * Pre process function with common actions. |
| 251 | */ |
| 252 | public function preProcess() { |
| 253 | $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this); |
| 254 | if (empty($this->_contactID) && !empty($this->_id) && $this->entity) { |
| 255 | $this->_contactID = civicrm_api3($this->entity, 'getvalue', ['id' => $this->_id, 'return' => 'contact_id']); |
| 256 | } |
| 257 | $this->assign('contactID', $this->_contactID); |
| 258 | CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $this->_contactID]); |
| 259 | $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add'); |
| 260 | $this->_mode = empty($this->_mode) ? CRM_Utils_Request::retrieve('mode', 'Alphanumeric', $this) : $this->_mode; |
| 261 | $this->assign('isBackOffice', $this->isBackOffice); |
| 262 | $this->assignContactEmailDetails(); |
| 263 | $this->assignPaymentRelatedVariables(); |
| 264 | } |
| 265 | |
| 266 | /** |
| 267 | * @param int $id |
| 268 | */ |
| 269 | public function showRecordLinkMesssage($id) { |
| 270 | $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id'); |
| 271 | if (CRM_Contribute_PseudoConstant::contributionStatus($statusId, 'name') == 'Partially paid') { |
| 272 | if ($pid = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'participant_id', 'contribution_id')) { |
| 273 | $recordPaymentLink = CRM_Utils_System::url('civicrm/payment', |
| 274 | "reset=1&id={$pid}&cid={$this->_contactID}&action=add&component=event" |
| 275 | ); |
| 276 | CRM_Core_Session::setStatus(ts('Please use the <a href="%1">Record Payment</a> form if you have received an additional payment for this Partially paid contribution record.', [1 => $recordPaymentLink]), ts('Notice'), 'alert'); |
| 277 | } |
| 278 | } |
| 279 | } |
| 280 | |
| 281 | /** |
| 282 | * @param int $id |
| 283 | * @param $values |
| 284 | */ |
| 285 | public function buildValuesAndAssignOnline_Note_Type($id, &$values) { |
| 286 | $ids = []; |
| 287 | $params = ['id' => $id]; |
| 288 | CRM_Contribute_BAO_Contribution::getValues($params, $values, $ids); |
| 289 | |
| 290 | //Check if this is an online transaction (financial_trxn.payment_processor_id NOT NULL) |
| 291 | $this->_online = FALSE; |
| 292 | $fids = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($id); |
| 293 | if (!empty($fids['financialTrxnId'])) { |
| 294 | $this->_online = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $fids['financialTrxnId'], 'payment_processor_id'); |
| 295 | } |
| 296 | |
| 297 | // Also don't allow user to update some fields for recurring contributions. |
| 298 | if (!$this->_online) { |
| 299 | $this->_online = CRM_Utils_Array::value('contribution_recur_id', $values); |
| 300 | } |
| 301 | |
| 302 | $this->assign('isOnline', $this->_online ? TRUE : FALSE); |
| 303 | |
| 304 | //to get note id |
| 305 | $daoNote = new CRM_Core_BAO_Note(); |
| 306 | $daoNote->entity_table = 'civicrm_contribution'; |
| 307 | $daoNote->entity_id = $id; |
| 308 | if ($daoNote->find(TRUE)) { |
| 309 | $this->_noteID = $daoNote->id; |
| 310 | $values['note'] = $daoNote->note; |
| 311 | } |
| 312 | $this->_contributionType = $values['financial_type_id']; |
| 313 | } |
| 314 | |
| 315 | /** |
| 316 | * @param string $type |
| 317 | * Eg 'Contribution'. |
| 318 | * @param string $subType |
| 319 | * @param int $entityId |
| 320 | */ |
| 321 | public function applyCustomData($type, $subType, $entityId) { |
| 322 | $this->set('type', $type); |
| 323 | $this->set('subType', $subType); |
| 324 | $this->set('entityId', $entityId); |
| 325 | |
| 326 | CRM_Custom_Form_CustomData::preProcess($this, NULL, $subType, 1, $type, $entityId); |
| 327 | CRM_Custom_Form_CustomData::buildQuickForm($this); |
| 328 | CRM_Custom_Form_CustomData::setDefaultValues($this); |
| 329 | } |
| 330 | |
| 331 | /** |
| 332 | * @param int $id |
| 333 | * @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find(); |
| 334 | */ |
| 335 | public function assignPremiumProduct($id) { |
| 336 | $sql = " |
| 337 | SELECT * |
| 338 | FROM civicrm_contribution_product |
| 339 | WHERE contribution_id = {$id} |
| 340 | "; |
| 341 | $dao = CRM_Core_DAO::executeQuery($sql); |
| 342 | if ($dao->fetch()) { |
| 343 | $this->_premiumID = $dao->id; |
| 344 | $this->_productDAO = $dao; |
| 345 | } |
| 346 | } |
| 347 | |
| 348 | /** |
| 349 | * @return array |
| 350 | * Array of valid processors. The array resembles the DB table but also has 'object' as a key |
| 351 | * @throws Exception |
| 352 | */ |
| 353 | public function getValidProcessors() { |
| 354 | $capabilities = ['BackOffice']; |
| 355 | if ($this->_mode) { |
| 356 | $capabilities[] = (ucfirst($this->_mode) . 'Mode'); |
| 357 | } |
| 358 | $processors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities); |
| 359 | return $processors; |
| 360 | |
| 361 | } |
| 362 | |
| 363 | /** |
| 364 | * Assign $this->processors, $this->recurPaymentProcessors, and related Smarty variables |
| 365 | */ |
| 366 | public function assignProcessors() { |
| 367 | //ensure that processor has a valid config |
| 368 | //only valid processors get display to user |
| 369 | $this->assign('processorSupportsFutureStartDate', CRM_Financial_BAO_PaymentProcessor::hasPaymentProcessorSupporting(['FutureRecurStartDate'])); |
| 370 | $this->_paymentProcessors = $this->getValidProcessors(); |
| 371 | if (!isset($this->_paymentProcessor['id'])) { |
| 372 | // if the payment processor isn't set yet (as indicated by the presence of an id,) we'll grab the first one which should be the default |
| 373 | $this->_paymentProcessor = reset($this->_paymentProcessors); |
| 374 | } |
| 375 | if (!$this->_mode) { |
| 376 | $this->_paymentProcessor = $this->_paymentProcessors[0]; |
| 377 | } |
| 378 | elseif (empty($this->_paymentProcessors) || array_keys($this->_paymentProcessors) === [0]) { |
| 379 | throw new CRM_Core_Exception(ts('You will need to configure the %1 settings for your Payment Processor before you can submit a credit card transactions.', [1 => $this->_mode])); |
| 380 | } |
| 381 | //Assign submitted processor value if it is different from the loaded one. |
| 382 | if (!empty($this->_submitValues['payment_processor_id']) |
| 383 | && $this->_paymentProcessor['id'] != $this->_submitValues['payment_processor_id']) { |
| 384 | $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($this->_submitValues['payment_processor_id']); |
| 385 | } |
| 386 | $this->_processors = []; |
| 387 | foreach ($this->_paymentProcessors as $id => $processor) { |
| 388 | // @todo review this. The inclusion of this IF was to address test processors being incorrectly loaded. |
| 389 | // However the function $this->getValidProcessors() is expected to only return the processors relevant |
| 390 | // to the mode (using the actual id - ie. the id of the test processor for the test processor). |
| 391 | // for some reason there was a need to filter here per commit history - but this indicates a problem |
| 392 | // somewhere else. |
| 393 | if ($processor['is_test'] == ($this->_mode == 'test')) { |
| 394 | $this->_processors[$id] = $processor['name']; |
| 395 | if (!empty($processor['description'])) { |
| 396 | $this->_processors[$id] .= ' : ' . $processor['description']; |
| 397 | } |
| 398 | if ($processor['is_recur']) { |
| 399 | $this->_recurPaymentProcessors[$id] = $this->_processors[$id]; |
| 400 | } |
| 401 | } |
| 402 | } |
| 403 | // CRM-21002: pass the default payment processor ID whose credit card type icons should be populated first |
| 404 | CRM_Financial_Form_Payment::addCreditCardJs($this->_paymentProcessor['id']); |
| 405 | |
| 406 | $this->assign('recurringPaymentProcessorIds', |
| 407 | empty($this->_recurPaymentProcessors) ? '' : implode(',', array_keys($this->_recurPaymentProcessors)) |
| 408 | ); |
| 409 | |
| 410 | // this required to show billing block |
| 411 | // @todo remove this assignment the billing block is now designed to be always included but will not show fieldsets unless those sets of fields are assigned |
| 412 | $this->assign_by_ref('paymentProcessor', $this->_paymentProcessor); |
| 413 | } |
| 414 | |
| 415 | /** |
| 416 | * Get current currency from DB or use default currency. |
| 417 | * |
| 418 | * @param array $submittedValues |
| 419 | * |
| 420 | * @return string |
| 421 | */ |
| 422 | public function getCurrency($submittedValues = []) { |
| 423 | $config = CRM_Core_Config::singleton(); |
| 424 | |
| 425 | $currentCurrency = CRM_Utils_Array::value('currency', |
| 426 | $this->_values, |
| 427 | $config->defaultCurrency |
| 428 | ); |
| 429 | |
| 430 | // use submitted currency if present else use current currency |
| 431 | $result = CRM_Utils_Array::value('currency', |
| 432 | $submittedValues, |
| 433 | $currentCurrency |
| 434 | ); |
| 435 | return $result; |
| 436 | } |
| 437 | |
| 438 | public function preProcessPledge() { |
| 439 | //get the payment values associated with given pledge payment id OR check for payments due. |
| 440 | $this->_pledgeValues = []; |
| 441 | if ($this->_ppID) { |
| 442 | $payParams = ['id' => $this->_ppID]; |
| 443 | |
| 444 | CRM_Pledge_BAO_PledgePayment::retrieve($payParams, $this->_pledgeValues['pledgePayment']); |
| 445 | $this->_pledgeID = CRM_Utils_Array::value('pledge_id', $this->_pledgeValues['pledgePayment']); |
| 446 | $paymentStatusID = CRM_Utils_Array::value('status_id', $this->_pledgeValues['pledgePayment']); |
| 447 | $this->_id = CRM_Utils_Array::value('contribution_id', $this->_pledgeValues['pledgePayment']); |
| 448 | |
| 449 | //get all status |
| 450 | $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); |
| 451 | if (!($paymentStatusID == array_search('Pending', $allStatus) || $paymentStatusID == array_search('Overdue', $allStatus))) { |
| 452 | CRM_Core_Error::fatal(ts("Pledge payment status should be 'Pending' or 'Overdue'.")); |
| 453 | } |
| 454 | |
| 455 | //get the pledge values associated with given pledge payment. |
| 456 | |
| 457 | $ids = []; |
| 458 | $pledgeParams = ['id' => $this->_pledgeID]; |
| 459 | CRM_Pledge_BAO_Pledge::getValues($pledgeParams, $this->_pledgeValues, $ids); |
| 460 | $this->assign('ppID', $this->_ppID); |
| 461 | } |
| 462 | else { |
| 463 | // Not making a pledge payment, so if adding a new contribution we should check if pledge payment(s) are due for this contact so we can alert the user. CRM-5206 |
| 464 | if (isset($this->_contactID)) { |
| 465 | $contactPledges = CRM_Pledge_BAO_Pledge::getContactPledges($this->_contactID); |
| 466 | |
| 467 | if (!empty($contactPledges)) { |
| 468 | $payments = $paymentsDue = NULL; |
| 469 | $multipleDue = FALSE; |
| 470 | foreach ($contactPledges as $key => $pledgeId) { |
| 471 | $payments = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId); |
| 472 | if ($payments) { |
| 473 | if ($paymentsDue) { |
| 474 | $multipleDue = TRUE; |
| 475 | break; |
| 476 | } |
| 477 | else { |
| 478 | $paymentsDue = $payments; |
| 479 | } |
| 480 | } |
| 481 | } |
| 482 | if ($multipleDue) { |
| 483 | // Show link to pledge tab since more than one pledge has a payment due |
| 484 | $pledgeTab = CRM_Utils_System::url('civicrm/contact/view', |
| 485 | "reset=1&force=1&cid={$this->_contactID}&selectedChild=pledge" |
| 486 | ); |
| 487 | CRM_Core_Session::setStatus(ts('This contact has pending or overdue pledge payments. <a href="%1">Click here to view their Pledges tab</a> and verify whether this contribution should be applied as a pledge payment.', [1 => $pledgeTab]), ts('Notice'), 'alert'); |
| 488 | } |
| 489 | elseif ($paymentsDue) { |
| 490 | // Show user link to oldest Pending or Overdue pledge payment |
| 491 | $ppAmountDue = CRM_Utils_Money::format($payments['amount'], $payments['currency']); |
| 492 | $ppSchedDate = CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment', $payments['id'], 'scheduled_date')); |
| 493 | if ($this->_mode) { |
| 494 | $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution', |
| 495 | "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge&mode=live" |
| 496 | ); |
| 497 | } |
| 498 | else { |
| 499 | $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution', |
| 500 | "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge" |
| 501 | ); |
| 502 | } |
| 503 | CRM_Core_Session::setStatus(ts('This contact has a pending or overdue pledge payment of %2 which is scheduled for %3. <a href="%1">Click here to enter a pledge payment</a>.', [ |
| 504 | 1 => $ppUrl, |
| 505 | 2 => $ppAmountDue, |
| 506 | 3 => $ppSchedDate, |
| 507 | ]), ts('Notice'), 'alert'); |
| 508 | } |
| 509 | } |
| 510 | } |
| 511 | } |
| 512 | } |
| 513 | |
| 514 | /** |
| 515 | * @param array $submittedValues |
| 516 | * |
| 517 | * @return mixed |
| 518 | */ |
| 519 | public function unsetCreditCardFields($submittedValues) { |
| 520 | //Offline Contribution. |
| 521 | $unsetParams = [ |
| 522 | 'payment_processor_id', |
| 523 | "email-{$this->_bltID}", |
| 524 | 'hidden_buildCreditCard', |
| 525 | 'hidden_buildDirectDebit', |
| 526 | 'billing_first_name', |
| 527 | 'billing_middle_name', |
| 528 | 'billing_last_name', |
| 529 | 'street_address-5', |
| 530 | "city-{$this->_bltID}", |
| 531 | "state_province_id-{$this->_bltID}", |
| 532 | "postal_code-{$this->_bltID}", |
| 533 | "country_id-{$this->_bltID}", |
| 534 | 'credit_card_number', |
| 535 | 'cvv2', |
| 536 | 'credit_card_exp_date', |
| 537 | 'credit_card_type', |
| 538 | ]; |
| 539 | foreach ($unsetParams as $key) { |
| 540 | if (isset($submittedValues[$key])) { |
| 541 | unset($submittedValues[$key]); |
| 542 | } |
| 543 | } |
| 544 | return $submittedValues; |
| 545 | } |
| 546 | |
| 547 | /** |
| 548 | * Common block for setting up the parts of a form that relate to credit / debit card |
| 549 | * @throws Exception |
| 550 | */ |
| 551 | protected function assignPaymentRelatedVariables() { |
| 552 | try { |
| 553 | $this->assignProcessors(); |
| 554 | $this->assignBillingType(); |
| 555 | CRM_Core_Payment_Form::setPaymentFieldsByProcessor($this, $this->_paymentProcessor, FALSE, TRUE, CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer', $this)); |
| 556 | } |
| 557 | catch (CRM_Core_Exception $e) { |
| 558 | CRM_Core_Error::statusBounce($e->getMessage()); |
| 559 | } |
| 560 | } |
| 561 | |
| 562 | /** |
| 563 | * Begin post processing. |
| 564 | * |
| 565 | * This function aims to start to bring together common postProcessing functions. |
| 566 | * |
| 567 | * Eventually these are also shared with the front end forms & may need to be moved to where they can also |
| 568 | * access this function. |
| 569 | */ |
| 570 | protected function beginPostProcess() { |
| 571 | if ($this->_mode) { |
| 572 | $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment( |
| 573 | $this->_params['payment_processor_id'], |
| 574 | ($this->_mode == 'test') |
| 575 | ); |
| 576 | if (in_array('credit_card_exp_date', array_keys($this->_params))) { |
| 577 | $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params); |
| 578 | $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params); |
| 579 | } |
| 580 | $this->assign('credit_card_exp_date', CRM_Utils_Date::mysqlToIso(CRM_Utils_Date::format($this->_params['credit_card_exp_date']))); |
| 581 | $this->assign('credit_card_number', CRM_Utils_System::mungeCreditCard($this->_params['credit_card_number'])); |
| 582 | $this->assign('credit_card_type', CRM_Utils_Array::value('credit_card_type', $this->_params)); |
| 583 | } |
| 584 | $this->_params['ip_address'] = CRM_Utils_System::ipAddress(); |
| 585 | |
| 586 | self::formatCreditCardDetails($this->_params); |
| 587 | foreach ($this->submittableMoneyFields as $moneyField) { |
| 588 | if (isset($this->_params[$moneyField])) { |
| 589 | $this->_params[$moneyField] = CRM_Utils_Rule::cleanMoney($this->_params[$moneyField]); |
| 590 | } |
| 591 | } |
| 592 | if (!empty($this->_params['contact_id']) && empty($this->_contactID)) { |
| 593 | // Contact ID has been set in the standalone form. |
| 594 | $this->_contactID = $this->_params['contact_id']; |
| 595 | $this->assignContactEmailDetails(); |
| 596 | } |
| 597 | } |
| 598 | |
| 599 | /** |
| 600 | * Format credit card details like: |
| 601 | * 1. Retrieve last 4 digit from credit card number as pan_truncation |
| 602 | * 2. Retrieve credit card type id from name |
| 603 | * |
| 604 | * @param array $params |
| 605 | * |
| 606 | * @return void |
| 607 | */ |
| 608 | public static function formatCreditCardDetails(&$params) { |
| 609 | if (!empty($params['credit_card_type'])) { |
| 610 | $params['card_type_id'] = CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $params['credit_card_type']); |
| 611 | } |
| 612 | if (!empty($params['credit_card_number']) && empty($params['pan_truncation'])) { |
| 613 | $params['pan_truncation'] = substr($params['credit_card_number'], -4); |
| 614 | } |
| 615 | } |
| 616 | |
| 617 | /** |
| 618 | * Add the billing address to the contact who paid. |
| 619 | * |
| 620 | * Note that this function works based on the presence or otherwise of billing fields & can be called regardless of |
| 621 | * whether they are 'expected' (due to assumptions about the payment processor type or the setting to collect billing |
| 622 | * for pay later. |
| 623 | */ |
| 624 | protected function processBillingAddress() { |
| 625 | $fields = []; |
| 626 | |
| 627 | $fields['email-Primary'] = 1; |
| 628 | $this->_params['email-5'] = $this->_params['email-Primary'] = $this->_contributorEmail; |
| 629 | // now set the values for the billing location. |
| 630 | foreach (array_keys($this->_fields) as $name) { |
| 631 | $fields[$name] = 1; |
| 632 | } |
| 633 | |
| 634 | $fields["address_name-{$this->_bltID}"] = 1; |
| 635 | |
| 636 | //ensure we don't over-write the payer's email with the member's email |
| 637 | if ($this->_contributorContactID == $this->_contactID) { |
| 638 | $fields["email-{$this->_bltID}"] = 1; |
| 639 | } |
| 640 | |
| 641 | list($hasBillingField, $addressParams) = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($this->_params, $this->_bltID); |
| 642 | $fields = $this->formatParamsForPaymentProcessor($fields); |
| 643 | |
| 644 | if ($hasBillingField) { |
| 645 | $addressParams = array_merge($this->_params, $addressParams); |
| 646 | // CRM-18277 don't let this get passed in because we don't want contribution source to override contact source. |
| 647 | // Ideally we wouldn't just randomly merge everything into addressParams but just pass in a relevant array. |
| 648 | // Note this source field is covered by a unit test. |
| 649 | if (isset($addressParams['source'])) { |
| 650 | unset($addressParams['source']); |
| 651 | } |
| 652 | //here we are setting up the billing contact - if different from the member they are already created |
| 653 | // but they will get billing details assigned |
| 654 | CRM_Contact_BAO_Contact::createProfileContact($addressParams, $fields, |
| 655 | $this->_contributorContactID, NULL, NULL, |
| 656 | CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID, 'contact_type') |
| 657 | ); |
| 658 | } |
| 659 | |
| 660 | $this->assignBillingName($this->_params); |
| 661 | } |
| 662 | |
| 663 | /** |
| 664 | * Get default values for billing fields. |
| 665 | * |
| 666 | * @todo this function still replicates code in several other places in the code. |
| 667 | * |
| 668 | * Also - the call to getProfileDefaults possibly covers the state_province & country already. |
| 669 | * |
| 670 | * @param $defaults |
| 671 | * |
| 672 | * @return array |
| 673 | */ |
| 674 | protected function getBillingDefaults($defaults) { |
| 675 | // set default country from config if no country set |
| 676 | $config = CRM_Core_Config::singleton(); |
| 677 | if (empty($defaults["billing_country_id-{$this->_bltID}"])) { |
| 678 | $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry; |
| 679 | } |
| 680 | |
| 681 | if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) { |
| 682 | $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince; |
| 683 | } |
| 684 | |
| 685 | $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID); |
| 686 | return array_merge($defaults, $billingDefaults); |
| 687 | } |
| 688 | |
| 689 | /** |
| 690 | * Get the default payment instrument id. |
| 691 | * |
| 692 | * @return int |
| 693 | */ |
| 694 | protected function getDefaultPaymentInstrumentId() { |
| 695 | $paymentInstrumentID = CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer'); |
| 696 | if ($paymentInstrumentID) { |
| 697 | return $paymentInstrumentID; |
| 698 | } |
| 699 | return key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1')); |
| 700 | } |
| 701 | |
| 702 | /** |
| 703 | * Add the payment processor select to the form. |
| 704 | * |
| 705 | * @param bool $isRequired |
| 706 | * Is it a mandatory field. |
| 707 | * @param bool $isBuildRecurBlock |
| 708 | * True if we want to build recur on change |
| 709 | * @param bool $isBuildAutoRenewBlock |
| 710 | * True if we want to build autorenew on change. |
| 711 | */ |
| 712 | protected function addPaymentProcessorSelect($isRequired, $isBuildRecurBlock = FALSE, $isBuildAutoRenewBlock = FALSE) { |
| 713 | if (!$this->_mode) { |
| 714 | return; |
| 715 | } |
| 716 | $js = ($isBuildRecurBlock ? ['onChange' => "buildRecurBlock( this.value ); return false;"] : NULL); |
| 717 | if ($isBuildAutoRenewBlock) { |
| 718 | $js = ['onChange' => "buildAutoRenew( null, this.value, '{$this->_mode}');"]; |
| 719 | } |
| 720 | $element = $this->add('select', |
| 721 | 'payment_processor_id', |
| 722 | ts('Payment Processor'), |
| 723 | array_diff_key($this->_processors, [0 => 1]), |
| 724 | $isRequired, |
| 725 | $js |
| 726 | ); |
| 727 | // The concept of _online is not really explained & the code is old |
| 728 | // @todo figure out & document. |
| 729 | if ($this->_online) { |
| 730 | $element->freeze(); |
| 731 | } |
| 732 | } |
| 733 | |
| 734 | /** |
| 735 | * Assign the values to build the payment info block. |
| 736 | * |
| 737 | * @return string |
| 738 | * Block title. |
| 739 | */ |
| 740 | protected function assignPaymentInfoBlock() { |
| 741 | $paymentInfo = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_id, $this->_component, TRUE); |
| 742 | $title = ts('View Payment'); |
| 743 | if (!empty($this->_component) && $this->_component == 'event') { |
| 744 | $info = CRM_Event_BAO_Participant::participantDetails($this->_id); |
| 745 | $title .= " - {$info['title']}"; |
| 746 | } |
| 747 | $this->assign('transaction', TRUE); |
| 748 | $this->assign('payments', $paymentInfo['transaction']); |
| 749 | $this->assign('paymentLinks', $paymentInfo['payment_links']); |
| 750 | return $title; |
| 751 | } |
| 752 | |
| 753 | protected function assignContactEmailDetails() { |
| 754 | if ($this->_contactID) { |
| 755 | list($this->userDisplayName, $this->userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID); |
| 756 | if (empty($this->userDisplayName)) { |
| 757 | $this->userDisplayName = civicrm_api3('contact', 'getvalue', ['id' => $this->_contactID, 'return' => 'display_name']); |
| 758 | } |
| 759 | $this->assign('displayName', $this->userDisplayName); |
| 760 | } |
| 761 | } |
| 762 | |
| 763 | } |