CRM/Contribute/Form/AdditionalPayment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This form records additional payments needed when event/contribution is partially paid.
  20  */
  21 class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_AbstractEditPayment {
  22   public $_contributeMode = 'direct';
  23
  24   /**
  25    * Id of the component entity
  26    * @var int
  27    */
  28   public $_id = NULL;
  29
  30   protected $entity = 'Contribution';
  31
  32   protected $_owed = NULL;
  33
  34   protected $_refund = NULL;
  35
  36   /**
  37    * @var int
  38    * @deprecated - use parent $this->contactID
  39    */
  40   protected $_contactId = NULL;
  41
  42   protected $_contributorDisplayName = NULL;
  43
  44   protected $_contributorEmail = NULL;
  45
  46   protected $_toDoNotEmail = NULL;
  47
  48   protected $_paymentType = NULL;
  49
  50   protected $_contributionId = NULL;
  51
  52   protected $fromEmailId = NULL;
  53
  54   protected $_view = NULL;
  55
  56   public $_action = NULL;
  57
  58   /**
  59    * Pre process form.
  60    *
  61    * @throws \CRM_Core_Exception
  62    */
  63   public function preProcess() {
  64
  65     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  66     parent::preProcess();
  67     $this->_contactId = $this->_contactID;
  68     $this->_component = CRM_Utils_Request::retrieve('component', 'String', $this, FALSE, 'contribution');
  69     $this->_view = CRM_Utils_Request::retrieve('view', 'String', $this, FALSE);
  70     $this->assign('component', $this->_component);
  71     $this->assign('id', $this->_id);
  72     $this->assign('suppressPaymentFormButtons', $this->isBeingCalledFromSelectorContext());
  73
  74     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
  75       $title = $this->assignPaymentInfoBlock();
  76       CRM_Utils_System::setTitle($title);
  77       return;
  78     }
  79     if ($this->_component == 'event') {
  80       $this->_contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id, 'contribution_id', 'participant_id');
  81     }
  82     else {
  83       $this->_contributionId = $this->_id;
  84     }
  85
  86     $paymentDetails = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_id, $this->_component, FALSE, TRUE);
  87     $paymentAmt = CRM_Contribute_BAO_Contribution::getContributionBalance($this->_contributionId);
  88
  89     $this->_amtPaid = $paymentDetails['paid'];
  90     $this->_amtTotal = $paymentDetails['total'];
  91
  92     if ($paymentAmt < 0) {
  93       $this->_refund = $paymentAmt;
  94       $this->_paymentType = 'refund';
  95     }
  96     elseif ($paymentAmt > 0) {
  97       $this->_owed = $paymentAmt;
  98       $this->_paymentType = 'owed';
  99     }
 100     else {
 101       throw new CRM_Core_Exception(ts('No payment information found for this record'));
 102     }
 103
 104     if (!empty($this->_mode) && $this->_paymentType == 'refund') {
 105       throw new CRM_Core_Exception(ts('Credit card payment is not for Refund payments use'));
 106     }
 107
 108     list($this->_contributorDisplayName, $this->_contributorEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 109
 110     $this->assign('contributionMode', $this->_mode);
 111     $this->assign('contactId', $this->_contactID);
 112     $this->assign('paymentType', $this->_paymentType);
 113     $this->assign('paymentAmt', abs($paymentAmt));
 114
 115     $this->setPageTitle($this->_refund ? ts('Refund') : ts('Payment'));
 116   }
 117
 118   /**
 119    * Is this function being called from a datatable selector.
 120    *
 121    * If so we don't want to show the buttons.
 122    *
 123    * @throws \CRM_Core_Exception
 124    */
 125   protected function isBeingCalledFromSelectorContext() {
 126     return CRM_Utils_Request::retrieve('selector', 'Positive');
 127   }
 128
 129   /**
 130    * This virtual function is used to set the default values of
 131    * various form elements
 132    *
 133    * access        public
 134    *
 135    * @return array
 136    *   reference to the array of default values
 137    */
 138
 139   /**
 140    * @return array
 141    */
 142   public function setDefaultValues() {
 143     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
 144       return NULL;
 145     }
 146     $defaults = [];
 147     if ($this->_mode) {
 148       CRM_Core_Payment_Form::setDefaultValues($this, $this->_contactId);
 149       $defaults = array_merge($defaults, $this->_defaults);
 150     }
 151
 152     if (empty($defaults['trxn_date'])) {
 153       $defaults['trxn_date'] = date('Y-m-d H:i:s');
 154     }
 155
 156     if ($this->_refund) {
 157       $defaults['total_amount'] = CRM_Utils_Money::format(abs($this->_refund), NULL, NULL, TRUE);
 158     }
 159     elseif ($this->_owed) {
 160       $defaults['total_amount'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($this->_owed);
 161     }
 162
 163     // Set $newCredit variable in template to control whether link to credit card mode is included
 164     $this->assign('newCredit', CRM_Core_Config::isEnabledBackOfficeCreditCardPayments());
 165     return $defaults;
 166   }
 167
 168   /**
 169    * Build the form object.
 170    */
 171   public function buildQuickForm() {
 172     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
 173       $this->addButtons([
 174         [
 175           'type' => 'cancel',
 176           'name' => ts('Done'),
 177           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 178           'isDefault' => TRUE,
 179         ],
 180       ]);
 181       return;
 182     }
 183
 184     CRM_Core_Payment_Form::buildPaymentForm($this, $this->_paymentProcessor, FALSE, TRUE, CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer'));
 185     $this->add('select', 'payment_processor_id', ts('Payment Processor'), $this->_processors, NULL);
 186
 187     $attributes = CRM_Core_DAO::getAttribute('CRM_Financial_DAO_FinancialTrxn');
 188
 189     $label = ($this->_refund) ? ts('Refund Amount') : ts('Payment Amount');
 190     $this->addMoney('total_amount',
 191       $label,
 192       TRUE,
 193       $attributes['total_amount'],
 194       TRUE, 'currency', NULL
 195     );
 196
 197     //add receipt for offline contribution
 198     $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
 199
 200     if ($this->_component === 'event') {
 201       $eventID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'event_id', 'id');
 202     }
 203
 204     $this->add('select', 'from_email_address', ts('Receipt From'), CRM_Financial_BAO_Payment::getValidFromEmailsForPayment($eventID ?? NULL));
 205
 206     $this->add('textarea', 'receipt_text', ts('Confirmation Message'));
 207
 208     $dateLabel = ($this->_refund) ? ts('Refund Date') : ts('Date Received');
 209     $this->addField('trxn_date', ['entity' => 'FinancialTrxn', 'label' => $dateLabel, 'context' => 'Contribution'], FALSE, FALSE);
 210
 211     if ($this->_contactId && $this->_id) {
 212       if ($this->_component == 'event') {
 213         $eventId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'event_id', 'id');
 214         $event = CRM_Event_BAO_Event::getEvents(0, $eventId);
 215         $this->assign('eventName', $event[$eventId]);
 216       }
 217     }
 218
 219     $this->assign('displayName', $this->_contributorDisplayName);
 220     $this->assign('component', $this->_component);
 221     $this->assign('email', $this->_contributorEmail);
 222
 223     $js = NULL;
 224     // render backoffice payment fields only on offline mode
 225     if (!$this->_mode) {
 226       $js = ['onclick' => 'return verify( );'];
 227
 228       $this->add('select', 'payment_instrument_id',
 229         ts('Payment Method'),
 230         ['' => ts('- select -')] + CRM_Contribute_PseudoConstant::paymentInstrument(),
 231         TRUE,
 232         ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
 233       );
 234
 235       $this->add('text', 'check_number', ts('Check Number'), $attributes['financial_trxn_check_number']);
 236       $this->add('text', 'trxn_id', ts('Transaction ID'), ['class' => 'twelve'] + $attributes['trxn_id']);
 237
 238       $this->add('text', 'fee_amount', ts('Fee Amount'),
 239         $attributes['fee_amount']
 240       );
 241       $this->addRule('fee_amount', ts('Please enter a valid monetary value for Fee Amount.'), 'money');
 242     }
 243
 244     $buttonName = $this->_refund ? ts('Record Refund') : ts('Record Payment');
 245     $this->addButtons([
 246       [
 247         'type' => 'upload',
 248         'name' => $buttonName,
 249         'js' => $js,
 250         'isDefault' => TRUE,
 251       ],
 252       [
 253         'type' => 'cancel',
 254         'name' => ts('Cancel'),
 255       ],
 256     ]);
 257     $mailingInfo = Civi::settings()->get('mailing_backend');
 258     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 259
 260     $this->addFormRule(['CRM_Contribute_Form_AdditionalPayment', 'formRule'], $this);
 261   }
 262
 263   /**
 264    * @param $fields
 265    * @param $files
 266    * @param $self
 267    *
 268    * @return array
 269    */
 270   public static function formRule($fields, $files, $self) {
 271     $errors = [];
 272     if ($self->_paymentType == 'owed' && (int) $fields['total_amount'] > (int) $self->_owed) {
 273       $errors['total_amount'] = ts('Payment amount cannot be greater than owed amount');
 274     }
 275     if ($self->_paymentType == 'refund' && $fields['total_amount'] != abs($self->_refund)) {
 276       $errors['total_amount'] = ts('Refund amount must equal refund due amount.');
 277     }
 278
 279     if ($self->_paymentProcessor['id'] === 0 && empty($fields['payment_instrument_id'])) {
 280       $errors['payment_instrument_id'] = ts('Payment method is a required field');
 281     }
 282
 283     return $errors;
 284   }
 285
 286   /**
 287    * Process the form submission.
 288    */
 289   public function postProcess() {
 290     $submittedValues = $this->controller->exportValues($this->_name);
 291     $this->submit($submittedValues);
 292     $childTab = 'contribute';
 293     if ($this->_component == 'event') {
 294       $childTab = 'participant';
 295     }
 296     $session = CRM_Core_Session::singleton();
 297     $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
 298       "reset=1&cid={$this->_contactId}&selectedChild={$childTab}"
 299     ));
 300   }
 301
 302   /**
 303    * Process Payments.
 304    *
 305    * @param array $submittedValues
 306    *
 307    * @throws \CiviCRM_API3_Exception
 308    */
 309   public function submit($submittedValues) {
 310     $this->_params = $submittedValues;
 311     $this->beginPostProcess();
 312     $this->_contributorContactID = $this->_contactID;
 313     $this->processBillingAddress();
 314     $participantId = NULL;
 315     if ($this->_component == 'event') {
 316       $participantId = $this->_id;
 317     }
 318
 319     if ($this->_mode) {
 320       // process credit card
 321       $this->assign('contributeMode', 'direct');
 322       $this->processCreditCard();
 323     }
 324
 325     // @todo we should clean $ on the form & pass in skipCleanMoney
 326     $trxnsData = $this->_params;
 327     if ($this->_paymentType == 'refund') {
 328       $trxnsData['total_amount'] = -$trxnsData['total_amount'];
 329     }
 330     $trxnsData['participant_id'] = $participantId;
 331     $trxnsData['contribution_id'] = $this->_contributionId;
 332     // From the
 333     $trxnsData['is_send_contribution_notification'] = FALSE;
 334     $paymentID = civicrm_api3('Payment', 'create', $trxnsData)['id'];
 335
 336     if ($this->_contributionId && CRM_Core_Permission::access('CiviMember')) {
 337       $membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', ['contribution_id' => $this->_contributionId]);
 338       if ($membershipPaymentCount) {
 339         $this->ajaxResponse['updateTabs']['#tab_member'] = CRM_Contact_BAO_Contact::getCountComponent('membership', $this->_contactID);
 340       }
 341     }
 342     if ($this->_contributionId && CRM_Core_Permission::access('CiviEvent')) {
 343       $participantPaymentCount = civicrm_api3('ParticipantPayment', 'getCount', ['contribution_id' => $this->_contributionId]);
 344       if ($participantPaymentCount) {
 345         $this->ajaxResponse['updateTabs']['#tab_participant'] = CRM_Contact_BAO_Contact::getCountComponent('participant', $this->_contactID);
 346       }
 347     }
 348
 349     $statusMsg = ts('The payment record has been processed.');
 350     // send email
 351     if (!empty($paymentID) && !empty($this->_params['is_email_receipt'])) {
 352       $sendResult = civicrm_api3('Payment', 'sendconfirmation', ['id' => $paymentID, 'from' => $submittedValues['from_email_address']])['values'][$paymentID];
 353       if ($sendResult['is_sent']) {
 354         $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
 355       }
 356     }
 357
 358     CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success');
 359   }
 360
 361   public function processCreditCard() {
 362     $config = CRM_Core_Config::singleton();
 363     $session = CRM_Core_Session::singleton();
 364
 365     $now = date('YmdHis');
 366     $fields = [];
 367
 368     // we need to retrieve email address
 369     if ($this->_context == 'standalone' && !empty($this->_params['is_email_receipt'])) {
 370       list($this->userDisplayName,
 371         $this->userEmail
 372         ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactId);
 373       $this->assign('displayName', $this->userDisplayName);
 374     }
 375
 376     $this->_params['amount'] = $this->_params['total_amount'];
 377     // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
 378     // function to get correct amount level consistently. Remove setting of the amount level in
 379     // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
 380     // to cover all variants.
 381     $this->_params['amount_level'] = 0;
 382     $this->_params['currencyID'] = CRM_Utils_Array::value('currency',
 383       $this->_params,
 384       $config->defaultCurrency
 385     );
 386
 387     if (empty($this->_params['invoice_id'])) {
 388       $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
 389     }
 390     else {
 391       $this->_params['invoiceID'] = $this->_params['invoice_id'];
 392     }
 393
 394     $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
 395       $this->_params,
 396       $this->_bltID
 397     ));
 398
 399     //Add common data to formatted params
 400     $params = $this->_params;
 401     CRM_Contribute_Form_AdditionalInfo::postProcessCommon($params, $this->_params, $this);
 402     // at this point we've created a contact and stored its address etc
 403     // all the payment processors expect the name and address to be in the
 404     // so we copy stuff over to first_name etc.
 405     $paymentParams = $this->_params;
 406     $paymentParams['contactID'] = $this->_contactId;
 407     CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
 408
 409     $paymentParams['contributionPageID'] = NULL;
 410     if (!empty($this->_params['is_email_receipt'])) {
 411       $paymentParams['email'] = $this->_contributorEmail;
 412       $paymentParams['is_email_receipt'] = TRUE;
 413     }
 414     else {
 415       $paymentParams['is_email_receipt'] = $this->_params['is_email_receipt'] = FALSE;
 416     }
 417
 418     $result = NULL;
 419
 420     if ($paymentParams['amount'] > 0.0) {
 421       try {
 422         // force a reget of the payment processor in case the form changed it, CRM-7179
 423         $payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
 424         $result = $payment->doPayment($paymentParams);
 425       }
 426       catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
 427         Civi::log()->error('Payment processor exception: ' . $e->getMessage());
 428         $urlParams = "action=add&cid={$this->_contactId}&id={$this->_contributionId}&component={$this->_component}&mode={$this->_mode}";
 429         CRM_Core_Error::statusBounce($e->getMessage(), CRM_Utils_System::url('civicrm/payment/add', $urlParams));
 430       }
 431     }
 432
 433     if (!empty($result)) {
 434       $this->_params = array_merge($this->_params, $result);
 435     }
 436
 437     $this->set('params', $this->_params);
 438
 439     // set source if not set
 440     if (empty($this->_params['source'])) {
 441       $userID = $session->get('userID');
 442       $userSortName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $userID,
 443         'sort_name'
 444       );
 445       $this->_params['source'] = ts('Submit Credit Card Payment by: %1', [1 => $userSortName]);
 446     }
 447   }
 448
 449   /**
 450    * Wrapper for unit testing the post process submit function.
 451    *
 452    * @param array $params
 453    * @param string|null $creditCardMode
 454    * @param string $entityType
 455    *
 456    * @throws \CiviCRM_API3_Exception
 457    */
 458   public function testSubmit($params, $creditCardMode = NULL, $entityType = 'contribute') {
 459     $this->_bltID = 5;
 460     // Required because processCreditCard calls set method on this.
 461     $_SERVER['REQUEST_METHOD'] = 'GET';
 462     $this->controller = new CRM_Core_Controller();
 463
 464     $this->assignPaymentRelatedVariables();
 465
 466     if (!empty($params['contribution_id'])) {
 467       $this->_contributionId = $params['contribution_id'];
 468
 469       $paymentDetails = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_contributionId, $entityType, FALSE, TRUE);
 470
 471       $paymentAmount = CRM_Contribute_BAO_Contribution::getContributionBalance($this->_contributionId);
 472       $this->_amtPaid = $paymentDetails['paid'];
 473       $this->_amtTotal = $paymentDetails['total'];
 474
 475       if ($paymentAmount < 0) {
 476         $this->_refund = $paymentAmount;
 477         $this->_paymentType = 'refund';
 478       }
 479       elseif ($paymentAmount > 0) {
 480         $this->_owed = $paymentAmount;
 481         $this->_paymentType = 'owed';
 482       }
 483     }
 484
 485     if (!empty($params['contact_id'])) {
 486       $this->_contactId = $params['contact_id'];
 487     }
 488
 489     if ($creditCardMode) {
 490       $this->_mode = $creditCardMode;
 491     }
 492
 493     $this->_fields = [];
 494     $this->set('cid', $this->_contactId);
 495     parent::preProcess();
 496     $this->submit($params);
 497   }
 498
 499 }