3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
14 | CiviCRM is distributed in the hope that it will be useful, 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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2016
33 class CRM_Contribute_BAO_ContributionSoft
extends CRM_Contribute_DAO_ContributionSoft
{
38 public function __construct() {
39 parent
::__construct();
43 * Add contribution soft credit record.
45 * @param array $params
46 * (reference ) an assoc array of name/value pairs.
49 * soft contribution of object that is added
51 public static function add(&$params) {
52 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
53 $contributionSoft->copyValues($params);
55 // set currency for CRM-1496
56 if (!isset($contributionSoft->currency
)) {
57 $config = CRM_Core_Config
::singleton();
58 $contributionSoft->currency
= $config->defaultCurrency
;
60 return $contributionSoft->save();
64 * Process the soft contribution and/or link to personal campaign page.
66 * @param array $params
67 * @param object $contribution CRM_Contribute_DAO_Contribution
70 public static function processSoftContribution($params, $contribution) {
71 //retrieve existing soft-credit and pcp id(s) if any against $contribution
72 $softIDs = self
::getSoftCreditIds($contribution->id
);
73 $pcpId = self
::getSoftCreditIds($contribution->id
, TRUE);
75 if ($pcp = CRM_Utils_Array
::value('pcp', $params)) {
76 $softParams = array();
77 $softParams['id'] = $pcpId ?
$pcpId : NULL;
78 $softParams['contribution_id'] = $contribution->id
;
79 $softParams['pcp_id'] = $pcp['pcp_made_through_id'];
80 $softParams['contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_PCP_DAO_PCP',
81 $pcp['pcp_made_through_id'], 'contact_id'
83 $softParams['currency'] = $contribution->currency
;
84 $softParams['amount'] = $contribution->total_amount
;
85 $softParams['pcp_display_in_roll'] = CRM_Utils_Array
::value('pcp_display_in_roll', $pcp);
86 $softParams['pcp_roll_nickname'] = CRM_Utils_Array
::value('pcp_roll_nickname', $pcp);
87 $softParams['pcp_personal_note'] = CRM_Utils_Array
::value('pcp_personal_note', $pcp);
88 $softParams['soft_credit_type_id'] = CRM_Core_OptionGroup
::getValue('soft_credit_type', 'pcp', 'name');
89 $contributionSoft = self
::add($softParams);
90 //Send notification to owner for PCP
91 if ($contributionSoft->pcp_id
&& empty($pcpId)) {
92 CRM_Contribute_Form_Contribution_Confirm
::pcpNotifyOwner($contribution, $contributionSoft);
95 //Delete PCP against this contribution and create new on submitted PCP information
96 elseif (array_key_exists('pcp', $params) && $pcpId) {
97 $deleteParams = array('id' => $pcpId);
98 CRM_Contribute_BAO_ContributionSoft
::del($deleteParams);
100 if (isset($params['soft_credit'])) {
101 $softParams = $params['soft_credit'];
102 foreach ($softParams as $softParam) {
103 if (!empty($softIDs)) {
104 $key = key($softIDs);
105 $softParam['id'] = $softIDs[$key];
106 unset($softIDs[$key]);
108 $softParam['contribution_id'] = $contribution->id
;
109 $softParam['currency'] = $contribution->currency
;
110 //case during Contribution Import when we assign soft contribution amount as contribution's total_amount by default
111 if (empty($softParam['amount'])) {
112 $softParam['amount'] = $contribution->total_amount
;
114 CRM_Contribute_BAO_ContributionSoft
::add($softParam);
117 // delete any extra soft-credit while updating back-office contribution
118 foreach ((array) $softIDs as $softID) {
119 if (!in_array($softID, $params['soft_credit_ids'])) {
120 $deleteParams = array('id' => $softID);
121 CRM_Contribute_BAO_ContributionSoft
::del($deleteParams);
128 * Function used to save pcp / soft credit entry.
130 * This is used by contribution and also event pcps
132 * @param array $params
133 * @param object $form
136 public static function formatSoftCreditParams(&$params, &$form) {
137 $pcp = $softParams = $softIDs = array();
138 if (!empty($params['pcp_made_through_id'])) {
140 'pcp_made_through_id',
141 'pcp_display_in_roll',
145 foreach ($fields as $f) {
146 $pcp[$f] = CRM_Utils_Array
::value($f, $params);
150 if (!empty($form->_values
['honoree_profile_id']) && !empty($params['soft_credit_type_id'])) {
153 $contributionSoftParams['soft_credit_type_id'] = CRM_Core_OptionGroup
::getValue('soft_credit_type', 'pcp', 'name');
154 //check if there is any duplicate contact
155 $profileContactType = CRM_Core_BAO_UFGroup
::getContactType($form->_values
['honoree_profile_id']);
156 $dedupeParams = CRM_Dedupe_Finder
::formatParams($params['honor'], $profileContactType);
157 $dedupeParams['check_permission'] = FALSE;
158 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, $profileContactType);
160 $honorId = CRM_Utils_Array
::value(0, $ids);
163 $honorId = CRM_Contact_BAO_Contact
::createProfileContact(
164 $params['honor'], CRM_Core_DAO
::$_nullArray,
166 $form->_values
['honoree_profile_id']
168 $softParams[] = array(
169 'contact_id' => $honorId,
170 'soft_credit_type_id' => $params['soft_credit_type_id'],
173 if (CRM_Utils_Array
::value('is_email_receipt', $form->_values
)) {
174 $form->_values
['honor'] = array(
175 'soft_credit_type' => CRM_Utils_Array
::value(
176 $params['soft_credit_type_id'],
177 CRM_Core_OptionGroup
::values("soft_credit_type")
179 'honor_id' => $honorId,
180 'honor_profile_id' => $form->_values
['honoree_profile_id'],
181 'honor_profile_values' => $params['honor'],
185 elseif (!empty($params['soft_credit_contact_id'])) {
186 //build soft credit params
187 foreach ($params['soft_credit_contact_id'] as $key => $val) {
188 if ($val && $params['soft_credit_amount'][$key]) {
189 $softParams[$key]['contact_id'] = $val;
190 $softParams[$key]['amount'] = CRM_Utils_Rule
::cleanMoney($params['soft_credit_amount'][$key]);
191 $softParams[$key]['soft_credit_type_id'] = $params['soft_credit_type'][$key];
192 if (!empty($params['soft_credit_id'][$key])) {
193 $softIDs[] = $softParams[$key]['id'] = $params['soft_credit_id'][$key];
199 $params['pcp'] = !empty($pcp) ?
$pcp : NULL;
200 $params['soft_credit'] = $softParams;
201 $params['soft_credit_ids'] = $softIDs;
205 * Fetch object based on array of properties.
207 * @param array $params
208 * (reference ) an assoc array of name/value pairs.
209 * @param array $defaults
210 * (reference ) an assoc array to hold the flattened values.
212 * @return CRM_Contribute_BAO_ContributionSoft
214 public static function retrieve(&$params, &$defaults) {
215 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
216 $contributionSoft->copyValues($params);
217 if ($contributionSoft->find(TRUE)) {
218 CRM_Core_DAO
::storeValues($contributionSoft, $defaults);
219 return $contributionSoft;
225 * Delete soft credits.
227 * @param array $params
230 public static function del($params) {
231 //delete from contribution soft table
232 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
233 $contributionSoft->id
= $params['id'];
234 if (!$contributionSoft->find()) {
237 unset($params['id']);
238 foreach ($params as $column => $value) {
239 $contributionSoft->$column = $value;
241 $contributionSoft->delete();
246 * @param int $contact_id
251 public static function getSoftContributionTotals($contact_id, $isTest = 0) {
253 $whereClause = "AND cc.cancel_date IS NULL";
256 SELECT SUM(amount) as amount, AVG(total_amount) as average, cc.currency
257 FROM civicrm_contribution_soft ccs
258 LEFT JOIN civicrm_contribution cc ON ccs.contribution_id = cc.id
259 WHERE cc.is_test = %2 AND ccs.contact_id = %1 {$whereClause}
263 1 => array($contact_id, 'Integer'),
264 2 => array($isTest, 'Integer'),
267 $cs = CRM_Core_DAO
::executeQuery($query, $params);
270 $amount = $average = $cancelAmount = array();
272 while ($cs->fetch()) {
273 if ($cs->amount
> 0) {
275 $amount[] = $cs->amount
;
276 $average[] = $cs->average
;
277 $currency[] = $cs->currency
;
281 //to get cancel amount
282 $cancelAmountWhereClause = "AND cc.cancel_date IS NOT NULL";
283 $query = str_replace($whereClause, $cancelAmountWhereClause, $query);
284 $cancelAmountSQL = CRM_Core_DAO
::executeQuery($query, $params);
285 while ($cancelAmountSQL->fetch()) {
286 if ($cancelAmountSQL->amount
> 0) {
288 $cancelAmount[] = $cancelAmountSQL->amount
;
294 implode(', ', $amount),
295 implode(', ', $average),
296 implode(', ', $currency),
297 implode(', ', $cancelAmount),
304 * Retrieve soft contributions for contribution record.
306 * @param int $contributionID
311 * Array of soft contribution ids, amounts, and associated contact ids
313 public static function getSoftContribution($contributionID, $all = FALSE) {
317 'pcp_display_in_roll',
323 SELECT ccs.id, pcp_id, cpcp.title as pcp_title, pcp_display_in_roll, pcp_roll_nickname, pcp_personal_note, ccs.currency as currency, amount, ccs.contact_id as contact_id, c.display_name, ccs.soft_credit_type_id
324 FROM civicrm_contribution_soft ccs INNER JOIN civicrm_contact c on c.id = ccs.contact_id
325 LEFT JOIN civicrm_pcp cpcp ON ccs.pcp_id = cpcp.id
326 WHERE contribution_id = %1;
329 $params = array(1 => array($contributionID, 'Integer'));
331 $dao = CRM_Core_DAO
::executeQuery($query, $params);
333 $softContribution = array();
335 while ($dao->fetch()) {
338 foreach ($pcpFields as $val) {
339 $softContribution[$val] = $dao->$val;
341 $softContribution['pcp_soft_credit_to_name'] = $dao->display_name
;
342 $softContribution['pcp_soft_credit_to_id'] = $dao->contact_id
;
346 $softContribution['soft_credit'][$count] = array(
347 'contact_id' => $dao->contact_id
,
348 'soft_credit_id' => $dao->id
,
349 'currency' => $dao->currency
,
350 'amount' => $dao->amount
,
351 'contact_name' => $dao->display_name
,
352 'soft_credit_type' => $dao->soft_credit_type_id
,
353 'soft_credit_type_label' => CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $dao->soft_credit_type_id
),
359 return $softContribution;
363 * @param int $contributionID
368 public static function getSoftCreditIds($contributionID, $isPCP = FALSE) {
371 FROM civicrm_contribution_soft
372 WHERE contribution_id = %1
376 $query .= " AND pcp_id IS NOT NULL";
379 $query .= " AND pcp_id IS NULL";
381 $params = array(1 => array($contributionID, 'Integer'));
383 $dao = CRM_Core_DAO
::executeQuery($query, $params);
386 while ($dao->fetch()) {
396 * Wrapper for ajax soft contribution selector.
398 * @param array $params
399 * Associated array for params.
402 * Associated array of soft contributions
404 public static function getSoftContributionSelector($params) {
406 if (!empty($params['isTest'])) {
407 $isTest = $params['isTest'];
409 // Format the params.
410 $params['offset'] = ($params['page'] - 1) * $params['rp'];
411 $params['rowCount'] = $params['rp'];
412 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
413 $contactId = $params['cid'];
416 if ($params['context'] == 'membership' && !empty($params['entityID']) && $contactId) {
417 $filter = " AND cc.id IN (SELECT contribution_id FROM civicrm_membership_payment WHERE membership_id = {$params['entityID']})";
420 $softCreditList = self
::getSoftContributionList($contactId, $filter, $isTest, $params);
422 $softCreditListDT = array();
423 $softCreditListDT['data'] = array_values($softCreditList);
424 $softCreditListDT['recordsTotal'] = $params['total'];
425 $softCreditListDT['recordsFiltered'] = $params['total'];
427 return $softCreditListDT;
431 * Function to retrieve the list of soft contributions for given contact.
433 * @param int $contact_id
435 * @param string $filter
437 * Additional filter criteria, later used in where clause.
438 * @param array $dTParams
442 public static function getSoftContributionList($contact_id, $filter = NULL, $isTest = 0, &$dTParams = NULL) {
443 $config = CRM_Core_Config
::singleton();
445 CRM_Core_Action
::VIEW
=> array(
446 'name' => ts('View'),
447 'url' => 'civicrm/contact/view/contribution',
448 'qs' => 'reset=1&id=%%contributionid%%&cid=%%contactId%%&action=view&context=contribution&selectedChild=contribute',
449 'title' => ts('View related contribution'),
452 $orderBy = 'cc.receive_date DESC';
453 if (!empty($dTParams['sort'])) {
454 $orderBy = $dTParams['sort'];
457 if (!empty($dTParams['rowCount']) && $dTParams['rowCount'] > 0) {
458 $limit = " LIMIT {$dTParams['offset']}, {$dTParams['rowCount']} ";
460 $softOgId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'soft_credit_type', 'id', 'name');
461 $statusOgId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'contribution_status', 'id', 'name');
464 SELECT SQL_CALC_FOUND_ROWS ccs.id, ccs.amount as amount,
467 ccs.pcp_display_in_roll,
468 ccs.pcp_roll_nickname,
469 ccs.pcp_personal_note,
470 ccs.soft_credit_type_id,
471 sov.label as sct_label,
473 cc.contact_id as contributor_id,
474 cc.contribution_status_id as contribution_status_id,
475 cov.label as contribution_status,
476 cp.title as pcp_title,
478 contact.display_name as contributor_name,
479 cct.name as financial_type
480 FROM civicrm_contribution_soft ccs
481 LEFT JOIN civicrm_contribution cc
482 ON ccs.contribution_id = cc.id
483 LEFT JOIN civicrm_pcp cp
484 ON ccs.pcp_id = cp.id
485 LEFT JOIN civicrm_contact contact ON
486 ccs.contribution_id = cc.id AND cc.contact_id = contact.id
487 LEFT JOIN civicrm_financial_type cct ON cc.financial_type_id = cct.id
488 LEFT JOIN civicrm_option_value sov ON sov.option_group_id = %3 AND ccs.soft_credit_type_id = sov.value
489 LEFT JOIN civicrm_option_value cov ON cov.option_group_id = %4 AND cc.contribution_status_id = cov.value
493 WHERE cc.is_test = %2 AND ccs.contact_id = %1";
498 $query .= "{$where} ORDER BY {$orderBy} {$limit}";
501 1 => array($contact_id, 'Integer'),
502 2 => array($isTest, 'Integer'),
503 3 => array($softOgId, 'Integer'),
504 4 => array($statusOgId, 'Integer'),
506 $cs = CRM_Core_DAO
::executeQuery($query, $params);
508 $dTParams['total'] = CRM_Core_DAO
::singleValueQuery('SELECT FOUND_ROWS()');
510 while ($cs->fetch()) {
511 $result[$cs->id
]['amount'] = CRM_Utils_Money
::format($cs->amount
, $cs->currency
);
512 $result[$cs->id
]['currency'] = $cs->currency
;
513 $result[$cs->id
]['contributor_id'] = $cs->contributor_id
;
514 $result[$cs->id
]['contribution_id'] = $cs->contribution_id
;
515 $result[$cs->id
]['contributor_name'] = CRM_Utils_System
::href(
516 $cs->contributor_name
,
517 'civicrm/contact/view',
518 "reset=1&cid={$cs->contributor_id}"
520 $result[$cs->id
]['financial_type'] = $cs->financial_type
;
521 $result[$cs->id
]['receive_date'] = CRM_Utils_Date
::customFormat($cs->receive_date
, $config->dateformatDatetime
);
522 $result[$cs->id
]['pcp_id'] = $cs->pcp_id
;
523 $result[$cs->id
]['pcp_title'] = ($cs->pcp_title
) ?
$cs->pcp_title
: 'n/a';
524 $result[$cs->id
]['pcp_display_in_roll'] = $cs->pcp_display_in_roll
;
525 $result[$cs->id
]['pcp_roll_nickname'] = $cs->pcp_roll_nickname
;
526 $result[$cs->id
]['pcp_personal_note'] = $cs->pcp_personal_note
;
527 $result[$cs->id
]['contribution_status'] = $cs->contribution_status
;
528 $result[$cs->id
]['sct_label'] = $cs->sct_label
;
530 'contributionid' => $cs->contribution_id
,
531 'contactId' => $cs->contributor_id
,
533 $result[$cs->id
]['links'] = CRM_Core_Action
::formLink($links, NULL, $replace);
536 $result[$cs->id
]['contribution_status'] = $result[$cs->id
]['contribution_status'] . '<br /> (test)';
543 * Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id)
544 * is passed then whole honoreeprofile fields with title/value assoc array assigned or only honoreeName
547 * @param CRM_Core_Form $form
548 * @param array $params
549 * @param int $honorId
551 public static function formatHonoreeProfileFields($form, $params, $honorId = NULL) {
552 if (empty($form->_values
['honoree_profile_id'])) {
555 $profileContactType = CRM_Core_BAO_UFGroup
::getContactType($form->_values
['honoree_profile_id']);
556 $profileFields = CRM_Core_BAO_UFGroup
::getFields($form->_values
['honoree_profile_id']);
557 $honoreeProfileFields = $values = array();
561 CRM_Core_BAO_UFGroup
::getValues($honorId, $profileFields, $values, FALSE, $params);
562 if (empty($params)) {
563 foreach ($profileFields as $name => $field) {
564 $title = $field['title'];
565 $params[$field['name']] = $values[$title];
570 //remove name related fields and construct name string with prefix/suffix
571 //which will be later assigned to template
572 switch ($profileContactType) {
574 if (array_key_exists('prefix_id', $params)) {
575 $honorName = CRM_Utils_Array
::value(CRM_Utils_Array
::value('prefix_id', $params),
576 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id')
578 unset($profileFields['prefix_id']);
580 $honorName .= ' ' . $params['first_name'] . ' ' . $params['last_name'];
581 unset($profileFields['first_name']);
582 unset($profileFields['last_name']);
583 if (array_key_exists('suffix_id', $params)) {
584 $honorName .= ' ' . CRM_Utils_Array
::value(CRM_Utils_Array
::value('suffix_id', $params),
585 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id')
587 unset($profileFields['suffix_id']);
592 $honorName = $params['organization_name'];
593 unset($profileFields['organization_name']);
597 $honorName = $params['household_name'];
598 unset($profileFields['household_name']);
603 $honoreeProfileFields['Name'] = $honorName;
604 foreach ($profileFields as $name => $field) {
605 $title = $field['title'];
606 $honoreeProfileFields[$title] = $values[$title];
608 $form->assign('honoreeProfile', $honoreeProfileFields);
611 $form->assign('honorName', $honorName);