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 21, 2019
1 parent d0fe005 commit e66d7d3
Show file tree
Hide file tree
Showing 5 changed files with 227 additions and 123 deletions.
134 changes: 14 additions & 120 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,15 +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;

$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 @@ -401,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 @@ -498,88 +472,6 @@ public function processCreditCard() {
}
}

/**
* Function to send email receipt.
*
* @param array $params
*
* @return bool
*/
public function emailReceipt(&$params) {
$templateEngine = CRM_Core_Smarty::singleton();
// email receipt sending
list($contributorDisplayName, $contributorEmail, $doNotMail) = CRM_Contact_BAO_Contact::getContactDetails($params['contact_id']);
if (!$contributorEmail || $doNotMail) {
return FALSE;
}
$templateEngine->assign('contactDisplayName', $contributorDisplayName);
// send message template
if ($this->_component == 'event') {

// fetch event information from participant ID using API
$eventId = civicrm_api3('Participant', 'getvalue', array(
'return' => "event_id",
'id' => $this->_id,
));
$event = civicrm_api3('Event', 'getsingle', array('id' => $eventId));

$templateEngine->assign('event', $event);
$templateEngine->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);
$templateEngine->assign('location', $location);
}
}

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

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

$isRefund = ($this->_paymentType == 'refund') ? TRUE : FALSE;
$templateEngine->assign('isRefund', $isRefund);
if ($isRefund) {
$templateEngine->assign('totalPaid', $this->_amtPaid);
$templateEngine->assign('refundAmount', $params['total_amount']);
}
else {
$balance = $this->_amtTotal - ($this->_amtPaid + $params['total_amount']);
$paymentsComplete = ($balance == 0) ? 1 : 0;
$templateEngine->assign('amountOwed', $balance);
$templateEngine->assign('paymentAmount', $params['total_amount']);
$templateEngine->assign('paymentsComplete', $paymentsComplete);
}

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

$sendTemplateParams = array(
'groupName' => 'msg_tpl_workflow_contribution',
'valueName' => 'payment_or_refund_notification',
'contactId' => $params['contact_id'],
'PDFFilename' => ts('notification') . '.pdf',
);

$sendTemplateParams['from'] = $params['from_email_address'];
$sendTemplateParams['toName'] = $contributorDisplayName;
$sendTemplateParams['toEmail'] = $contributorEmail;

list($mailSent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
return $mailSent;
}

/**
* Wrapper for unit testing the post process submit function.
*
Expand Down Expand Up @@ -609,10 +501,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
141 changes: 141 additions & 0 deletions CRM/Financial/BAO/Payment.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,145 @@ public static function create($params) {
return $trxn;
}

/**
* Function to send email receipt.
*
* @param array $params
*
* @return bool
*/
public static function sendConfirmation($params) {
if (empty($params['is_email_receipt'])) {
return;
}
$templateVars = array();
self::assignVariablesToTemplate($templateVars, $params);
// send message template
$fromEmails = CRM_Core_BAO_Email::getFromEmail();
$sendTemplateParams = array(
'groupName' => 'msg_tpl_workflow_contribution',
'valueName' => 'payment_or_refund_notification',
'contactId' => CRM_Utils_Array::value('contactId', $templateVars),
'PDFFilename' => ts('notification') . '.pdf',
);
$doNotEmail = NULL;
if (!empty($templateVars['contactId'])) {
$doNotEmail = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $templateVars['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 (!empty($templateVars['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'] = CRM_Utils_Array::value('contributorDisplayName', $templateVars);
$sendTemplateParams['toEmail'] = $templateVars['contributorEmail'];
}
list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
return $mailSent;
}

/**
* Assign template variables.
*
* @param array $templateVars
* @param array $params
*
* @return array
*/
public static function assignVariablesToTemplate(&$templateVars, $params) {
$templateVars = self::getTemplateVars($params);
$template = CRM_Core_Smarty::singleton();
if (CRM_Utils_Array::value('component', $templateVars) == 'event') {
// fetch event information from participant ID using API
$eventId = civicrm_api3('Participant', 'getvalue', array(
'return' => "event_id",
'id' => $templateVars['id'],
));
$event = civicrm_api3('Event', 'getsingle', array('id' => $eventId));
$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);
$template->assign('location', $location);
}
// assign payment info here
$paymentConfig['confirm_email_text'] = CRM_Utils_Array::value('confirm_email_text', $event);
$template->assign('paymentConfig', $paymentConfig);
}
$template->assign('component', CRM_Utils_Array::value('component', $templateVars));
$template->assign('totalAmount', CRM_Utils_Array::value('amtTotal', $templateVars));
$isRefund = ($templateVars['paymentType'] == 'refund') ? TRUE : FALSE;
$template->assign('isRefund', $isRefund);
if ($isRefund) {
$template->assign('totalPaid', CRM_Utils_Array::value('amtPaid', $templateVars));
$template->assign('refundAmount', $params['total_amount']);
}
else {
$balance = CRM_Contribute_BAO_Contribution::getContributionBalance($params['contribution_id']);
$paymentsComplete = ($balance == 0) ? 1 : 0;
$template->assign('amountOwed', $balance);
$template->assign('paymentAmount', $params['total_amount']);
$template->assign('paymentsComplete', $paymentsComplete);
}
$template->assign('contactDisplayName', CRM_Utils_Array::value('contributorDisplayName', $templateVars));
// assign trxn details
$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()
));
}
}
/**
* Function to form template variables.
*
* @param array $params
*
* @return array
*/
public static function getTemplateVars($params) {
$componentId = $params['contribution_id'];
$componentDetails = CRM_Contribute_BAO_Contribution::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' => CRM_Utils_Array::value('payment_type', $params, 'owed'),
'amtPaid' => $paymentDetails['paid'],
'contributorDisplayName' => $contributorDisplayName,
'contactId' => $componentDetails['contact_id'],
'contributorEmail' => $contributorEmail,
];
if (!empty($params['payment_processor_id'])) {
$templateVars['mode'] = 'live';
}
return $templateVars;
}


}
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
Loading

0 comments on commit e66d7d3

Please sign in to comment.