3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Contribute_BAO_ContributionSoft
extends CRM_Contribute_DAO_ContributionSoft
{
40 public function __construct() {
41 parent
::__construct();
45 * Add contribution soft credit record
47 * @param array $params (reference ) an assoc array of name/value pairs
49 * @return object soft contribution of object that is added
52 public static function add(&$params) {
53 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
54 $contributionSoft->copyValues($params);
56 // set currency for CRM-1496
57 if (!isset($contributionSoft->currency
)) {
58 $config = CRM_Core_Config
::singleton();
59 $contributionSoft->currency
= $config->defaultCurrency
;
61 return $contributionSoft->save();
65 * Fetch object based on array of properties
67 * @param array $params (reference ) an assoc array of name/value pairs
68 * @param array $defaults (reference ) an assoc array to hold the flattened values
70 * @return CRM_Contribute_BAO_ContributionSoft object
73 public static function retrieve(&$params, &$defaults) {
74 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
75 $contributionSoft->copyValues($params);
76 if ($contributionSoft->find(TRUE)) {
77 CRM_Core_DAO
::storeValues($contributionSoft, $defaults);
78 return $contributionSoft;
86 * @param array $params
90 public static function del($params) {
91 //delete from contribution soft table
92 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
93 foreach($params as $column => $value) {
94 $contributionSoft->$column = $value;
96 $contributionSoft->delete();
100 * @param int $contact_id
105 public static function getSoftContributionTotals($contact_id, $isTest = 0) {
107 SELECT SUM(amount) as amount, AVG(total_amount) as average, cc.currency
108 FROM civicrm_contribution_soft ccs
109 LEFT JOIN civicrm_contribution cc ON ccs.contribution_id = cc.id
110 WHERE cc.is_test = %2 AND ccs.contact_id = %1
113 $params = array(1 => array($contact_id, 'Integer'),
114 2 => array($isTest, 'Integer'));
116 $cs = CRM_Core_DAO
::executeQuery($query, $params);
119 $amount = $average = array();
121 while ($cs->fetch()) {
122 if ($cs->amount
> 0) {
124 $amount[] = $cs->amount
;
125 $average[] = $cs->average
;
126 $currency[] = $cs->currency
;
132 implode(', ', $amount),
133 implode(', ', $average),
134 implode(', ', $currency),
141 * Retrieve soft contributions for contribution record.
143 * @param int $contributionID
144 * @param boolean $all include PCP data
146 * @return array of soft contribution ids, amounts, and associated contact ids
149 public static function getSoftContribution($contributionID, $all = FALSE) {
153 'pcp_display_in_roll',
159 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
160 FROM civicrm_contribution_soft ccs INNER JOIN civicrm_contact c on c.id = ccs.contact_id
161 LEFT JOIN civicrm_pcp cpcp ON ccs.pcp_id = cpcp.id
162 WHERE contribution_id = %1;
165 $params = array(1 => array($contributionID, 'Integer'));
167 $dao = CRM_Core_DAO
::executeQuery($query, $params);
169 $softContribution = array();
171 while ($dao->fetch()) {
174 foreach ($pcpFields as $val) {
175 $softContribution[$val] = $dao->$val;
177 $softContribution['pcp_soft_credit_to_name'] = $dao->display_name
;
178 $softContribution['pcp_soft_credit_to_id'] = $dao->contact_id
;
182 $softContribution['soft_credit'][$count] = array(
183 'contact_id' => $dao->contact_id
,
184 'soft_credit_id' => $dao->id
,
185 'currency' => $dao->currency
,
186 'amount' => $dao->amount
,
187 'contact_name' => $dao->display_name
,
188 'soft_credit_type' => $dao->soft_credit_type_id
,
189 'soft_credit_type_label' => CRM_Core_OptionGroup
::getLabel('soft_credit_type', $dao->soft_credit_type_id
)
195 return $softContribution;
199 * @param int $contributionID
204 public static function getSoftCreditIds($contributionID , $isPCP = FALSE) {
207 FROM civicrm_contribution_soft
208 WHERE contribution_id = %1
212 $query .= " AND pcp_id IS NOT NULL";
215 $query .= " AND pcp_id IS NULL";
217 $params = array(1 => array($contributionID, 'Integer'));
219 $dao = CRM_Core_DAO
::executeQuery($query, $params);
222 while ($dao->fetch()) {
232 * Function to retrieve the list of soft contributions for given contact.
234 * @param int $contact_id contact id
236 * @param string $filter additional filter criteria, later used in where clause
241 public static function getSoftContributionList($contact_id, $filter = NULL, $isTest = 0) {
243 SELECT ccs.id, ccs.amount as amount,
246 ccs.pcp_display_in_roll,
247 ccs.pcp_roll_nickname,
248 ccs.pcp_personal_note,
249 ccs.soft_credit_type_id,
251 cc.contact_id as contributor_id,
252 cc.contribution_status_id as contribution_status_id,
253 cp.title as pcp_title,
255 contact.display_name,
256 cct.name as contributionType
257 FROM civicrm_contribution_soft ccs
258 LEFT JOIN civicrm_contribution cc
259 ON ccs.contribution_id = cc.id
260 LEFT JOIN civicrm_pcp cp
261 ON ccs.pcp_id = cp.id
262 LEFT JOIN civicrm_contact contact ON
263 ccs.contribution_id = cc.id AND cc.contact_id = contact.id
264 LEFT JOIN civicrm_financial_type cct ON cc.financial_type_id = cct.id
268 WHERE cc.is_test = %2 AND ccs.contact_id = %1";
273 $query .= "{$where} ORDER BY cc.receive_date DESC";
276 1 => array($contact_id, 'Integer'),
277 2 => array($isTest, 'Integer')
279 $cs = CRM_Core_DAO
::executeQuery($query, $params);
280 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
282 while ($cs->fetch()) {
283 $result[$cs->id
]['amount'] = $cs->amount
;
284 $result[$cs->id
]['currency'] = $cs->currency
;
285 $result[$cs->id
]['contributor_id'] = $cs->contributor_id
;
286 $result[$cs->id
]['contribution_id'] = $cs->contribution_id
;
287 $result[$cs->id
]['contributor_name'] = $cs->display_name
;
288 $result[$cs->id
]['financial_type'] = $cs->contributionType
;
289 $result[$cs->id
]['receive_date'] = $cs->receive_date
;
290 $result[$cs->id
]['pcp_id'] = $cs->pcp_id
;
291 $result[$cs->id
]['pcp_title'] = $cs->pcp_title
;
292 $result[$cs->id
]['pcp_display_in_roll'] = $cs->pcp_display_in_roll
;
293 $result[$cs->id
]['pcp_roll_nickname'] = $cs->pcp_roll_nickname
;
294 $result[$cs->id
]['pcp_personal_note'] = $cs->pcp_personal_note
;
295 $result[$cs->id
]['contribution_status'] = CRM_Utils_Array
::value($cs->contribution_status_id
, $contributionStatus);
296 $result[$cs->id
]['sct_label'] = CRM_Core_OptionGroup
::getLabel('soft_credit_type', $cs->soft_credit_type_id
);
299 $result[$cs->id
]['contribution_status'] = $result[$cs->id
]['contribution_status'] . '<br /> (test)';
306 * Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id)
307 * is passed then whole honoreeprofile fields with title/value assoc array assigned or only honoreeName
314 * @param CRM_Core_Form $form
315 * @param array $params
316 * @param int $honoreeprofileId
317 * @param int $honorId
319 public static function formatHonoreeProfileFields($form, $params, $honoreeprofileId, $honorId = NULL) {
320 $profileContactType = CRM_Core_BAO_UFGroup
::getContactType($honoreeprofileId);
321 $profileFields = CRM_Core_BAO_UFGroup
::getFields($honoreeprofileId);
322 $honoreeProfileFields = $values = array();
326 CRM_Core_BAO_UFGroup
::getValues($honorId, $profileFields, $values, FALSE, $params);
327 if (empty($params)) {
328 foreach ($profileFields as $name => $field) {
329 $title = $field['title'];
330 $params[$field['name']] = $values[$title];
335 //remove name related fields and construct name string with prefix/suffix
336 //which will be later assigned to template
337 switch ($profileContactType) {
339 if (array_key_exists('prefix_id', $params)) {
340 $honorName = CRM_Utils_Array
::value(CRM_Utils_Array
::value('prefix_id', $params),
341 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id')
343 unset($profileFields['prefix_id']);
345 $honorName .= ' ' . $params['first_name'] . ' ' . $params['last_name'];
346 unset($profileFields['first_name']);
347 unset($profileFields['last_name']);
348 if (array_key_exists('suffix_id', $params)) {
349 $honorName .= ' ' . CRM_Utils_Array
::value(CRM_Utils_Array
::value('suffix_id', $params),
350 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id')
352 unset($profileFields['suffix_id']);
356 $honorName = $params['organization_name'];
357 unset($profileFields['organization_name']);
360 $honorName = $params['household_name'];
361 unset($profileFields['household_name']);
366 $honoreeProfileFields['Name'] = $honorName;
367 foreach ($profileFields as $name => $field) {
368 $title = $field['title'];
369 $honoreeProfileFields[$title] = $values[$title];
371 $form->assign('honoreeProfile', $honoreeProfileFields);
374 $form->assign('honorName', $honorName);