Skip to content

Commit

Permalink
Use payment create API for backend record payment forms
Browse files Browse the repository at this point in the history
  • Loading branch information
Jitendra Purohit committed Jan 9, 2019
1 parent 44e2ee4 commit 2678bd4
Show file tree
Hide file tree
Showing 5 changed files with 171 additions and 84 deletions.
41 changes: 35 additions & 6 deletions CRM/Contribute/BAO/Contribution.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4493,11 +4493,10 @@ public static function isSingleLineItem($id) {
* @throws \CRM_Core_Exception
*/
public static function addPayment($params) {
$paymentType = CRM_Utils_Array::value('payment_type', $params, 'owed');
$contribution = civicrm_api3('Contribution', 'getsingle', ['id' => $params['contribution_id']]);
$contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($contribution['contribution_status_id'], 'name');
if ($contributionStatus != 'Partially paid'
&& !($contributionStatus == 'Pending' && $contribution['is_pay_later'] == TRUE)
) {
if ($paymentType == 'owed' && $contributionStatus != 'Partially paid' && $contributionStatus != 'Pending') {
throw new API_Exception('Please select a contribution which has a partial or pending payment');
}
else {
Expand All @@ -4524,7 +4523,8 @@ public static function addPayment($params) {
}
}
if (!$fullyPaidPayLater) {
$trxn = CRM_Core_BAO_FinancialTrxn::getPartialPaymentTrxn($contribution, $params);
unset($params['id']);
$trxn = CRM_Contribute_BAO_Contribution::recordAdditionalPayment($params['contribution_id'], $params, $paymentType, CRM_Utils_Array::value('participant_id', $params));
if (CRM_Utils_Array::value('line_item', $params) && !empty($trxn)) {
foreach ($params['line_item'] as $values) {
foreach ($values as $id => $amount) {
Expand Down Expand Up @@ -4555,12 +4555,41 @@ public static function addPayment($params) {
}
}
elseif (!empty($trxn)) {
CRM_Contribute_BAO_Contribution::assignProportionalLineItems($params, $trxn->id, $contribution['total_amount']);
$defaults = [];
$fetchParams = ['id' => $params['contribution_id']];
$contributionDAO = CRM_Contribute_BAO_Contribution::retrieve($fetchParams, $defaults, $fetchParams);
CRM_Contribute_BAO_Contribution::addPayments(array($contributionDAO), $contribution['contribution_status_id']);
}
}
}
return $trxn;

if (!empty($params['is_email_receipt'])) {
$componentId = $params['contribution_id'];
$componentDetails = self::getComponentDetails($params['contribution_id']);
$entityType = 'contribution';
if (array_key_exists('participant', $componentDetails)) {
$entityType = 'participant';
$componentId = $componentDetails['participant'];
}
$paymentDetails = CRM_Contribute_BAO_Contribution::getPaymentInfo($componentId, $componentDetails['component'], FALSE, TRUE);
list($contributorDisplayName, $contributorEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($componentDetails['contact_id']);
$templateVars = [
'id' => $componentId,
'component' => $componentDetails['component'],
'amtTotal' => $paymentDetails['total'],
'paymentType' => $paymentType,
'amtPaid' => $paymentDetails['paid'],
'contributorDisplayName' => $contributorDisplayName,
'contactId' => $componentDetails['contact_id'],
'contributorEmail' => $contributorEmail,
];
if (!empty($params['payment_processor_id'])) {
$templateVars['mode'] = 'live';
}
CRM_Contribute_Form_AdditionalPayment::emailReceipt($templateVars, $params);
}

return $trxn;
}

/**
Expand Down
139 changes: 64 additions & 75 deletions CRM/Contribute/Form/AdditionalPayment.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,11 @@ public function preProcess() {
$this->_amtTotal = $paymentDetails['total'];

if (!empty($paymentInfo['refund_due'])) {
$paymentAmt = $this->_refund = $paymentInfo['refund_due'];
$this->paymentAmount = $this->_refund = $paymentInfo['refund_due'];
$this->_paymentType = 'refund';
}
elseif (!empty($paymentInfo['amount_owed'])) {
$paymentAmt = $this->_owed = $paymentInfo['amount_owed'];
$this->paymentAmount = $this->_owed = $paymentInfo['amount_owed'];
$this->_paymentType = 'owed';
}
else {
Expand All @@ -130,7 +130,7 @@ public function preProcess() {
$this->assign('contributionMode', $this->_mode);
$this->assign('contactId', $this->_contactID);
$this->assign('paymentType', $this->_paymentType);
$this->assign('paymentAmt', abs($paymentAmt));
$this->assign('paymentAmt', abs($this->paymentAmount));

$this->setPageTitle($this->_refund ? ts('Refund') : ts('Payment'));
}
Expand Down Expand Up @@ -336,38 +336,20 @@ public function submit($submittedValues) {
if ($this->_component == 'event') {
$participantId = $this->_id;
}
$contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution',
'contribution_status_id',
array('labelColumn' => 'name')
);
$contributionStatusID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_contributionId, 'contribution_status_id');
if ($contributionStatuses[$contributionStatusID] == 'Pending') {
civicrm_api3('Contribution', 'create',
array(
'id' => $this->_contributionId,
'contribution_status_id' => array_search('Partially paid', $contributionStatuses),
'is_pay_later' => 0,
)
);
}

if ($this->_mode) {
// process credit card
$this->assign('contributeMode', 'direct');
$this->processCreditCard();
}

$defaults = array();
$contribution = civicrm_api3('Contribution', 'getsingle', array(
'return' => array("contribution_status_id"),
'id' => $this->_contributionId,
));
$contributionStatusId = CRM_Utils_Array::value('contribution_status_id', $contribution);
$result = CRM_Contribute_BAO_Contribution::recordAdditionalPayment($this->_contributionId, $this->_params, $this->_paymentType, $participantId);
// Fetch the contribution & do proportional line item assignment
$params = array('id' => $this->_contributionId);
$contribution = CRM_Contribute_BAO_Contribution::retrieve($params, $defaults, $params);
CRM_Contribute_BAO_Contribution::addPayments(array($contribution), $contributionStatusId);
$payment = civicrm_api3('Payment', 'create', array_merge([
'contribution_id' => $this->_contributionId,
'total_amount' => $this->_params['total_amount'],
'payment_type' => $this->_paymentType,
'participant_id' => $participantId,
'mode' => $this->_mode,
], $this->_params));
if ($this->_contributionId && CRM_Core_Permission::access('CiviMember')) {
$membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', array('contribution_id' => $this->_contributionId));
if ($membershipPaymentCount) {
Expand All @@ -382,16 +364,8 @@ public function submit($submittedValues) {
}

$statusMsg = ts('The payment record has been processed.');
// send email
if (!empty($result) && !empty($this->_params['is_email_receipt'])) {
$this->_params['contact_id'] = $this->_contactId;
$this->_params['contribution_id'] = $this->_contributionId;
// to get 'from email id' for send receipt
$this->fromEmailId = $this->_params['from_email_address'];
$sendReceipt = $this->emailReceipt($this->_params);
if ($sendReceipt) {
$statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
}
if (empty($payment['is_error']) && !empty($this->_params['is_email_receipt'])) {
$statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
}

CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success');
Expand All @@ -402,7 +376,6 @@ public function processCreditCard() {
$session = CRM_Core_Session::singleton();

$now = date('YmdHis');
$fields = array();

// we need to retrieve email address
if ($this->_context == 'standalone' && !empty($this->_params['is_email_receipt'])) {
Expand Down Expand Up @@ -506,78 +479,92 @@ public function processCreditCard() {
*
* @return bool
*/
public function emailReceipt(&$params) {
public static function emailReceipt($values, $params) {
// email receipt sending
// send message template
if ($this->_component == 'event') {
$template = CRM_Core_Smarty::singleton();
$fromEmails = CRM_Core_BAO_Email::getFromEmail();

if (!empty($values['component']) && $values['component'] == 'event') {
// fetch event information from participant ID using API
$eventId = civicrm_api3('Participant', 'getvalue', array(
'return' => "event_id",
'id' => $this->_id,
'id' => $values['id'],
));
$event = civicrm_api3('Event', 'getsingle', array('id' => $eventId));
$fromEmails = CRM_Event_BAO_Event::getFromEmailIds($eventId);

$this->assign('event', $event);
$this->assign('isShowLocation', $event['is_show_location']);
$template->assign('event', $event);
$template->assign('isShowLocation', $event['is_show_location']);
if (CRM_Utils_Array::value('is_show_location', $event) == 1) {
$locationParams = array(
'entity_id' => $eventId,
'entity_table' => 'civicrm_event',
);
$location = CRM_Core_BAO_Location::getValues($locationParams, TRUE);
$this->assign('location', $location);
$template->assign('location', $location);
}
// assign payment info here
$paymentConfig['confirm_email_text'] = CRM_Utils_Array::value('confirm_email_text', $event);
$template->assign('paymentConfig', $paymentConfig);
}

// assign payment info here
$paymentConfig['confirm_email_text'] = CRM_Utils_Array::value('confirm_email_text', $params);
$this->assign('paymentConfig', $paymentConfig);

$this->assign('totalAmount', $this->_amtTotal);

$isRefund = ($this->_paymentType == 'refund') ? TRUE : FALSE;
$this->assign('isRefund', $isRefund);
$template->assign('component', CRM_Utils_Array::value('component', $values));
$template->assign('totalAmount', CRM_Utils_Array::value('amtTotal', $values));
$isRefund = ($values['paymentType'] == 'refund') ? TRUE : FALSE;
$template->assign('isRefund', $isRefund);
if ($isRefund) {
$this->assign('totalPaid', $this->_amtPaid);
$this->assign('refundAmount', $params['total_amount']);
$template->assign('totalPaid', CRM_Utils_Array::value('amtPaid', $values));
$template->assign('refundAmount', $params['total_amount']);
}
else {
$balance = $this->_amtTotal - ($this->_amtPaid + $params['total_amount']);
$balance = CRM_Contribute_BAO_Contribution::getContributionBalance($params['contribution_id']);
$paymentsComplete = ($balance == 0) ? 1 : 0;
$this->assign('amountOwed', $balance);
$this->assign('paymentAmount', $params['total_amount']);
$this->assign('paymentsComplete', $paymentsComplete);
$template->assign('amountOwed', $balance);
$template->assign('paymentAmount', $params['total_amount']);
$template->assign('paymentsComplete', $paymentsComplete);
}
$this->assign('contactDisplayName', $this->_contributorDisplayName);
$template->assign('contactDisplayName', CRM_Utils_Array::value('contributorDisplayName', $values));

// assign trxn details
$this->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $params));
$this->assign('receive_date', CRM_Utils_Array::value('trxn_date', $params));
$this->assign('paidBy', CRM_Core_PseudoConstant::getLabel(
'CRM_Contribute_BAO_Contribution',
'payment_instrument_id',
$params['payment_instrument_id']
));
$this->assign('checkNumber', CRM_Utils_Array::value('check_number', $params));

$template->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $params));
$template->assign('receive_date', CRM_Utils_Array::value('trxn_date', $params));
if (!empty($params['payment_instrument_id'])) {
$template->assign('paidBy', CRM_Core_PseudoConstant::getLabel(
'CRM_Contribute_BAO_Contribution',
'payment_instrument_id',
$params['payment_instrument_id']
));
}
$template->assign('checkNumber', CRM_Utils_Array::value('check_number', $params));
if (!empty($params['mode'])) {
$template->assign('contributeMode', 'direct');
$template->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
$params,
CRM_Core_BAO_LocationType::getBilling()
));
}
$sendTemplateParams = array(
'groupName' => 'msg_tpl_workflow_contribution',
'valueName' => 'payment_or_refund_notification',
'contactId' => $this->_contactId,
'contactId' => CRM_Utils_Array::value('contactId', $values),
'PDFFilename' => ts('notification') . '.pdf',
);

$doNotEmail = NULL;
if (!empty($values['contactId'])) {
$doNotEmail = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $values['contactId'], 'do_not_email');
}
// try to send emails only if email id is present
// and the do-not-email option is not checked for that contact
if ($this->_contributorEmail && !$this->_toDoNotEmail) {
if (array_key_exists($params['from_email_address'], $this->_fromEmails['from_email_id'])) {
if (!empty($values['contributorEmail']) && empty($doNotEmail)) {
list($userName, $receiptFrom) = CRM_Core_BAO_Domain::getDefaultReceiptFrom();
if (!empty($params['from_email_address']) && array_key_exists($params['from_email_address'], $fromEmails)) {
$receiptFrom = $params['from_email_address'];
}

$sendTemplateParams['from'] = $receiptFrom;
$sendTemplateParams['toName'] = $this->_contributorDisplayName;
$sendTemplateParams['toEmail'] = $this->_contributorEmail;
$sendTemplateParams['toName'] = CRM_Utils_Array::value('contributorDisplayName', $values);
$sendTemplateParams['toEmail'] = $values['contributorEmail'];
}
list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
return $mailSent;
Expand Down Expand Up @@ -612,10 +599,12 @@ public function testSubmit($params, $creditCardMode = NULL, $entityType = 'contr
if (!empty($paymentInfo['refund_due'])) {
$this->_refund = $paymentInfo['refund_due'];
$this->_paymentType = 'refund';
$this->paymentAmount = $paymentInfo['refund_due'];
}
elseif (!empty($paymentInfo['amount_owed'])) {
$this->_owed = $paymentInfo['amount_owed'];
$this->_paymentType = 'owed';
$this->paymentAmount = $paymentInfo['amount_owed'];
}
}

Expand Down
10 changes: 10 additions & 0 deletions api/v3/Payment.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,16 @@ function _civicrm_api3_payment_create_spec(&$params) {
'type' => CRM_Utils_Type::T_INT,
'api.aliases' => array('payment_id'),
),
'payment_type' => array(
'title' => 'Payment Type',
'type' => CRM_Utils_Type::T_STRING,
'description' => ts("Type of payment - 'owed' or 'refund'."),
),
'is_email_receipt' => array(
'title' => 'Send Email Receipt',
'type' => CRM_Utils_Type::T_BOOLEAN,
'description' => ts('If true, receipt is automatically emailed to contact after payment.'),
),
);
}

Expand Down
32 changes: 29 additions & 3 deletions tests/phpunit/CRM/Event/BAO/AdditionalPaymentTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ public function tearDown() {
'civicrm_financial_trxn',
'civicrm_price_set',
'civicrm_entity_financial_trxn',
'civicrm_price_field_value',
'civicrm_price_field',
),
TRUE
);
Expand Down Expand Up @@ -223,6 +225,7 @@ public function testAddPartialPayment() {
* Test owed/refund info is listed on view payments.
*/
public function testTransactionInfo() {
$mut = new CiviMailUtils($this, TRUE);
$feeAmt = 100;
$amtPaid = 80;
$result = $this->addParticipantWithPayment($feeAmt, $amtPaid);
Expand All @@ -233,16 +236,27 @@ public function testTransactionInfo() {
$submittedValues = array(
'total_amount' => 20,
'payment_instrument_id' => 3,
'payment_type' => 'owed',
'participant_id' => $participant['id'],
'contribution_id' => $contributionID,
'is_email_receipt' => TRUE,
);
CRM_Contribute_BAO_Contribution::recordAdditionalPayment($contributionID, $submittedValues, 'owed', $participant['id']);

$this->callAPISuccess('payment', 'create', $submittedValues);
$priceField = $this->callAPISuccess('PriceField', 'get', [
'sequential' => 1,
'price_set_id' => $priceSetId,
'html_type' => 'Text'
]);

//Change selection to a lower amount.
$params['price_2'] = 50;
$params["price_{$priceField['id']}"] = 50;
CRM_Price_BAO_LineItem::changeFeeSelections($params, $participant['id'], 'participant', $contributionID, $feeBlock, $lineItem, $feeAmt);

//Record a refund of the remaining amount.
$submittedValues['total_amount'] = 50;
CRM_Contribute_BAO_Contribution::recordAdditionalPayment($contributionID, $submittedValues, 'refund', $participant['id']);
$submittedValues['payment_type'] = 'refund';
$this->callAPISuccess('payment', 'create', $submittedValues);
$paymentInfo = CRM_Contribute_BAO_Contribution::getPaymentInfo($participant['id'], 'event', TRUE);
$transaction = $paymentInfo['transaction'];

Expand All @@ -256,6 +270,18 @@ public function testTransactionInfo() {

$this->assertEquals($transaction[2]['total_amount'], -50.00);
$this->assertEquals($transaction[2]['status'], 'Refunded');

//Test email receipt for refund payment.
$mut->assertSubjects(array('Payment Receipt - Annual CiviCRM meet', 'Refund Notification - Annual CiviCRM meet'));
$mut->checkMailLog(array(
'Dear Mr. Anthony Anderson II',
'A refund has been issued based on changes in your registration selections',
'Total Fees: $ 50.00',
'You Paid: $ 50.00',
'Refund Amount: $ 50.00',
'Event Information and Location',
));
$mut->stop();
}

}
Loading

0 comments on commit 2678bd4

Please sign in to comment.