Merge pull request #4906 from eileenmcnaughton/minor-tidies
[civicrm-core.git] / CRM / Contribute / BAO / ContributionSoft.php
CommitLineData
a45a51e3 1<?php
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
a45a51e3 5 +--------------------------------------------------------------------+
06b69b18 6 | Copyright CiviCRM LLC (c) 2004-2014 |
a45a51e3 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 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. |
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
06b69b18 31 * @copyright CiviCRM LLC (c) 2004-2014
a45a51e3 32 * $Id$
33 *
34 */
35class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_ContributionSoft {
36
8cb2c285 37 /**
100fef9d 38 * Construct method
8cb2c285 39 */
00be9182 40 public function __construct() {
a45a51e3 41 parent::__construct();
42 }
43
44 /**
100fef9d 45 * Add contribution soft credit record
a45a51e3 46 *
014c4014
TO
47 * @param array $params
48 * (reference ) an assoc array of name/value pairs.
a45a51e3 49 *
a6c01b45
CW
50 * @return object
51 * soft contribution of object that is added
a45a51e3 52 */
07a88eec 53 public static function add(&$params) {
a45a51e3 54 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
55 $contributionSoft->copyValues($params);
6dcc4d9d 56
57 // set currency for CRM-1496
58 if (!isset($contributionSoft->currency)) {
59 $config = CRM_Core_Config::singleton();
60 $contributionSoft->currency = $config->defaultCurrency;
61 }
a45a51e3 62 return $contributionSoft->save();
63 }
64
65 /**
c490a46a 66 * Fetch object based on array of properties
a45a51e3 67 *
014c4014
TO
68 * @param array $params
69 * (reference ) an assoc array of name/value pairs.
70 * @param array $defaults
71 * (reference ) an assoc array to hold the flattened values.
a45a51e3 72 *
16b10e64 73 * @return CRM_Contribute_BAO_ContributionSoft
a45a51e3 74 * @static
75 */
00be9182 76 public static function retrieve(&$params, &$defaults) {
a45a51e3 77 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
78 $contributionSoft->copyValues($params);
79 if ($contributionSoft->find(TRUE)) {
80 CRM_Core_DAO::storeValues($contributionSoft, $defaults);
81 return $contributionSoft;
82 }
83 return NULL;
84 }
85
86 /**
100fef9d 87 * Delete soft credits
a45a51e3 88 *
c490a46a 89 * @param array $params
6c8f6e67 90 *
a45a51e3 91 * @static
92 */
00be9182 93 public static function del($params) {
a45a51e3 94 //delete from contribution soft table
95 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
22e263ad 96 foreach ($params as $column => $value) {
2cfc0f58 97 $contributionSoft->$column = $value;
98 }
a45a51e3 99 $contributionSoft->delete();
100 }
6dcc4d9d 101
186c9c17 102 /**
100fef9d 103 * @param int $contact_id
186c9c17
EM
104 * @param int $isTest
105 *
106 * @return array
107 */
00be9182 108 public static function getSoftContributionTotals($contact_id, $isTest = 0) {
8cb2c285
KJ
109 $query = '
110 SELECT SUM(amount) as amount, AVG(total_amount) as average, cc.currency
111 FROM civicrm_contribution_soft ccs
112 LEFT JOIN civicrm_contribution cc ON ccs.contribution_id = cc.id
113 WHERE cc.is_test = %2 AND ccs.contact_id = %1
114 GROUP BY currency';
6dcc4d9d 115
874c9be7 116 $params = array(
353ffa53
TO
117 1 => array($contact_id, 'Integer'),
118 2 => array($isTest, 'Integer')
119 );
6dcc4d9d 120
121 $cs = CRM_Core_DAO::executeQuery($query, $params);
122
123 $count = 0;
124 $amount = $average = array();
125
126 while ($cs->fetch()) {
127 if ($cs->amount > 0) {
128 $count++;
91bb24a7 129 $amount[] = $cs->amount;
130 $average[] = $cs->average;
6dcc4d9d 131 $currency[] = $cs->currency;
132 }
133 }
134
135 if ($count > 0) {
91bb24a7 136 return array(
137 implode(',&nbsp;', $amount),
6dcc4d9d 138 implode(',&nbsp;', $average),
139 implode(',&nbsp;', $currency),
140 );
141 }
142 return array(0, 0);
143 }
144
145 /**
100fef9d 146 * Retrieve soft contributions for contribution record.
6dcc4d9d 147 *
100fef9d 148 * @param int $contributionID
014c4014
TO
149 * @param bool $all
150 * Include PCP data.
dd244018 151 *
a6c01b45 152 * @return array
16b10e64 153 * Array of soft contribution ids, amounts, and associated contact ids
dd244018 154 * @static
6dcc4d9d 155 */
00be9182 156 public static function getSoftContribution($contributionID, $all = FALSE) {
17db9f82
KJ
157 $pcpFields = array(
158 'pcp_id',
b6545333 159 'pcp_title',
17db9f82
KJ
160 'pcp_display_in_roll',
161 'pcp_roll_nickname',
162 'pcp_personal_note',
163 );
164
7ccf8829 165 $query = '
b6545333 166 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
7ccf8829 167 FROM civicrm_contribution_soft ccs INNER JOIN civicrm_contact c on c.id = ccs.contact_id
b6545333 168 LEFT JOIN civicrm_pcp cpcp ON ccs.pcp_id = cpcp.id
7ccf8829
KJ
169 WHERE contribution_id = %1;
170 ';
171
172 $params = array(1 => array($contributionID, 'Integer'));
173
174 $dao = CRM_Core_DAO::executeQuery($query, $params);
175
176 $softContribution = array();
177 $count = 1;
178 while ($dao->fetch()) {
b6545333 179 if ($dao->pcp_id) {
6dcc4d9d 180 if ($all) {
17db9f82 181 foreach ($pcpFields as $val) {
b6545333 182 $softContribution[$val] = $dao->$val;
6dcc4d9d 183 }
b6545333 184 $softContribution['pcp_soft_credit_to_name'] = $dao->display_name;
185 $softContribution['pcp_soft_credit_to_id'] = $dao->contact_id;
6dcc4d9d 186 }
b6545333 187 }
188 else {
35729234 189 $softContribution['soft_credit'][$count] = array(
b6545333 190 'contact_id' => $dao->contact_id,
191 'soft_credit_id' => $dao->id,
192 'currency' => $dao->currency,
193 'amount' => $dao->amount,
194 'contact_name' => $dao->display_name,
195 'soft_credit_type' => $dao->soft_credit_type_id,
21dfd5f5 196 'soft_credit_type_label' => CRM_Core_OptionGroup::getLabel('soft_credit_type', $dao->soft_credit_type_id),
35729234
KJ
197 );
198 $count++;
6dcc4d9d 199 }
200 }
7ccf8829 201
6dcc4d9d 202 return $softContribution;
203 }
204
186c9c17 205 /**
100fef9d 206 * @param int $contributionID
186c9c17
EM
207 * @param bool $isPCP
208 *
209 * @return array
210 */
874c9be7 211 public static function getSoftCreditIds($contributionID, $isPCP = FALSE) {
91bb24a7 212 $query = "
b6545333 213 SELECT id
2cfc0f58 214 FROM civicrm_contribution_soft
215 WHERE contribution_id = %1
216 ";
b6545333 217
218 if ($isPCP) {
219 $query .= " AND pcp_id IS NOT NULL";
220 }
1221efe9 221 else {
222 $query .= " AND pcp_id IS NULL";
223 }
2cfc0f58 224 $params = array(1 => array($contributionID, 'Integer'));
225
226 $dao = CRM_Core_DAO::executeQuery($query, $params);
227 $id = array();
7f880799 228 $type = '';
2cfc0f58 229 while ($dao->fetch()) {
b6545333 230 if ($isPCP) {
231 return $dao->id;
2cfc0f58 232 }
233 $id[] = $dao->id;
234 }
b6545333 235 return $id;
2cfc0f58 236 }
91bb24a7 237
6dcc4d9d 238 /**
91bb24a7 239 * Function to retrieve the list of soft contributions for given contact.
6dcc4d9d 240 *
014c4014
TO
241 * @param int $contact_id
242 * Contact id.
243 * @param int $isTest
244 * @param string $filter
245 * Additional filter criteria, later used in where clause.
dd244018
EM
246 *
247 * @return array
248 * @static
6dcc4d9d 249 */
00be9182 250 public static function getSoftContributionList($contact_id, $filter = NULL, $isTest = 0) {
8cb2c285 251 $query = '
6dcc4d9d 252 SELECT ccs.id, ccs.amount as amount,
8cb2c285
KJ
253 ccs.contribution_id,
254 ccs.pcp_id,
255 ccs.pcp_display_in_roll,
256 ccs.pcp_roll_nickname,
257 ccs.pcp_personal_note,
51fa20cb 258 ccs.soft_credit_type_id,
8cb2c285
KJ
259 cc.receive_date,
260 cc.contact_id as contributor_id,
261 cc.contribution_status_id as contribution_status_id,
262 cp.title as pcp_title,
263 cc.currency,
264 contact.display_name,
265 cct.name as contributionType
266 FROM civicrm_contribution_soft ccs
267 LEFT JOIN civicrm_contribution cc
268 ON ccs.contribution_id = cc.id
269 LEFT JOIN civicrm_pcp cp
270 ON ccs.pcp_id = cp.id
271 LEFT JOIN civicrm_contact contact ON
272 ccs.contribution_id = cc.id AND cc.contact_id = contact.id
273 LEFT JOIN civicrm_financial_type cct ON cc.financial_type_id = cct.id
91ef9be0 274 ';
275
276 $where = "
277 WHERE cc.is_test = %2 AND ccs.contact_id = %1";
278 if ($filter) {
279 $where .= $filter;
280 }
281
282 $query .= "{$where} ORDER BY cc.receive_date DESC";
8cb2c285
KJ
283
284 $params = array(
285 1 => array($contact_id, 'Integer'),
21dfd5f5 286 2 => array($isTest, 'Integer'),
8cb2c285
KJ
287 );
288 $cs = CRM_Core_DAO::executeQuery($query, $params);
6dcc4d9d 289 $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus();
8cb2c285 290 $result = array();
6dcc4d9d 291 while ($cs->fetch()) {
292 $result[$cs->id]['amount'] = $cs->amount;
293 $result[$cs->id]['currency'] = $cs->currency;
294 $result[$cs->id]['contributor_id'] = $cs->contributor_id;
295 $result[$cs->id]['contribution_id'] = $cs->contribution_id;
296 $result[$cs->id]['contributor_name'] = $cs->display_name;
297 $result[$cs->id]['financial_type'] = $cs->contributionType;
298 $result[$cs->id]['receive_date'] = $cs->receive_date;
299 $result[$cs->id]['pcp_id'] = $cs->pcp_id;
300 $result[$cs->id]['pcp_title'] = $cs->pcp_title;
301 $result[$cs->id]['pcp_display_in_roll'] = $cs->pcp_display_in_roll;
302 $result[$cs->id]['pcp_roll_nickname'] = $cs->pcp_roll_nickname;
303 $result[$cs->id]['pcp_personal_note'] = $cs->pcp_personal_note;
304 $result[$cs->id]['contribution_status'] = CRM_Utils_Array::value($cs->contribution_status_id, $contributionStatus);
51fa20cb 305 $result[$cs->id]['sct_label'] = CRM_Core_OptionGroup::getLabel('soft_credit_type', $cs->soft_credit_type_id);
6dcc4d9d 306
307 if ($isTest) {
308 $result[$cs->id]['contribution_status'] = $result[$cs->id]['contribution_status'] . '<br /> (test)';
309 }
310 }
311 return $result;
312 }
1421174e 313
186c9c17 314 /**
d424ffde
CW
315 * Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id)
316 * is passed then whole honoreeprofile fields with title/value assoc array assigned or only honoreeName
317 * is assigned
318 *
c490a46a
CW
319 * @param CRM_Core_Form $form
320 * @param array $params
100fef9d
CW
321 * @param int $honoreeprofileId
322 * @param int $honorId
186c9c17 323 */
00be9182 324 public static function formatHonoreeProfileFields($form, $params, $honoreeprofileId, $honorId = NULL) {
1421174e 325 $profileContactType = CRM_Core_BAO_UFGroup::getContactType($honoreeprofileId);
326 $profileFields = CRM_Core_BAO_UFGroup::getFields($honoreeprofileId);
327 $honoreeProfileFields = $values = array();
8af73472 328 $honorName = NULL;
1421174e 329
330 if ($honorId) {
331 CRM_Core_BAO_UFGroup::getValues($honorId, $profileFields, $values, FALSE, $params);
8af73472 332 if (empty($params)) {
333 foreach ($profileFields as $name => $field) {
334 $title = $field['title'];
335 $params[$field['name']] = $values[$title];
336 }
337 }
1421174e 338 }
339
340 //remove name related fields and construct name string with prefix/suffix
341 //which will be later assigned to template
342 switch ($profileContactType) {
343 case 'Individual':
344 if (array_key_exists('prefix_id', $params)) {
345 $honorName = CRM_Utils_Array::value(CRM_Utils_Array::value('prefix_id', $params),
346 CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id')
347 );
348 unset($profileFields['prefix_id']);
349 }
874c9be7
TO
350 $honorName .= ' ' . $params['first_name'] . ' ' . $params['last_name'];
351 unset($profileFields['first_name']);
352 unset($profileFields['last_name']);
353 if (array_key_exists('suffix_id', $params)) {
354 $honorName .= ' ' . CRM_Utils_Array::value(CRM_Utils_Array::value('suffix_id', $params),
1421174e 355 CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id')
356 );
874c9be7
TO
357 unset($profileFields['suffix_id']);
358 }
359 break;
360
361 case 'Organization':
362 $honorName = $params['organization_name'];
363 unset($profileFields['organization_name']);
364 break;
365
366 case 'Household':
367 $honorName = $params['household_name'];
368 unset($profileFields['household_name']);
369 break;
1421174e 370 }
371
372 if ($honorId) {
373 $honoreeProfileFields['Name'] = $honorName;
374 foreach ($profileFields as $name => $field) {
375 $title = $field['title'];
376 $honoreeProfileFields[$title] = $values[$title];
377 }
378 $form->assign('honoreeProfile', $honoreeProfileFields);
379 }
380 else {
381 $form->assign('honorName', $honorName);
382 }
383 }
a45a51e3 384}