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
48 * (reference ) an assoc array of name/value pairs.
50 * @return object soft contribution of object that is added
53 public static function add(&$params) {
54 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
55 $contributionSoft->copyValues($params);
57 // set currency for CRM-1496
58 if (!isset($contributionSoft->currency
)) {
59 $config = CRM_Core_Config
::singleton();
60 $contributionSoft->currency
= $config->defaultCurrency
;
62 return $contributionSoft->save();
66 * Fetch object based on array of properties
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.
73 * @return CRM_Contribute_BAO_ContributionSoft object
76 public static function retrieve(&$params, &$defaults) {
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;
89 * @param array $params
93 public static function del($params) {
94 //delete from contribution soft table
95 $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
96 foreach ($params as $column => $value) {
97 $contributionSoft->$column = $value;
99 $contributionSoft->delete();
103 * @param int $contact_id
108 public static function getSoftContributionTotals($contact_id, $isTest = 0) {
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
117 1 => array($contact_id, 'Integer'),
118 2 => array($isTest, 'Integer'));
120 $cs = CRM_Core_DAO
::executeQuery($query, $params);
123 $amount = $average = array();
125 while ($cs->fetch()) {
126 if ($cs->amount
> 0) {
128 $amount[] = $cs->amount
;
129 $average[] = $cs->average
;
130 $currency[] = $cs->currency
;
136 implode(', ', $amount),
137 implode(', ', $average),
138 implode(', ', $currency),
145 * Retrieve soft contributions for contribution record.
147 * @param int $contributionID
151 * @return array of soft contribution ids, amounts, and associated contact ids
154 public static function getSoftContribution($contributionID, $all = FALSE) {
158 'pcp_display_in_roll',
164 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
165 FROM civicrm_contribution_soft ccs INNER JOIN civicrm_contact c on c.id = ccs.contact_id
166 LEFT JOIN civicrm_pcp cpcp ON ccs.pcp_id = cpcp.id
167 WHERE contribution_id = %1;
170 $params = array(1 => array($contributionID, 'Integer'));
172 $dao = CRM_Core_DAO
::executeQuery($query, $params);
174 $softContribution = array();
176 while ($dao->fetch()) {
179 foreach ($pcpFields as $val) {
180 $softContribution[$val] = $dao->$val;
182 $softContribution['pcp_soft_credit_to_name'] = $dao->display_name
;
183 $softContribution['pcp_soft_credit_to_id'] = $dao->contact_id
;
187 $softContribution['soft_credit'][$count] = array(
188 'contact_id' => $dao->contact_id
,
189 'soft_credit_id' => $dao->id
,
190 'currency' => $dao->currency
,
191 'amount' => $dao->amount
,
192 'contact_name' => $dao->display_name
,
193 'soft_credit_type' => $dao->soft_credit_type_id
,
194 'soft_credit_type_label' => CRM_Core_OptionGroup
::getLabel('soft_credit_type', $dao->soft_credit_type_id
),
200 return $softContribution;
204 * @param int $contributionID
209 public static function getSoftCreditIds($contributionID, $isPCP = FALSE) {
212 FROM civicrm_contribution_soft
213 WHERE contribution_id = %1
217 $query .= " AND pcp_id IS NOT NULL";
220 $query .= " AND pcp_id IS NULL";
222 $params = array(1 => array($contributionID, 'Integer'));
224 $dao = CRM_Core_DAO
::executeQuery($query, $params);
227 while ($dao->fetch()) {
237 * Function to retrieve the list of soft contributions for given contact.
239 * @param int $contact_id
242 * @param string $filter
243 * Additional filter criteria, later used in where clause.
248 public static function getSoftContributionList($contact_id, $filter = NULL, $isTest = 0) {
250 SELECT ccs.id, ccs.amount as amount,
253 ccs.pcp_display_in_roll,
254 ccs.pcp_roll_nickname,
255 ccs.pcp_personal_note,
256 ccs.soft_credit_type_id,
258 cc.contact_id as contributor_id,
259 cc.contribution_status_id as contribution_status_id,
260 cp.title as pcp_title,
262 contact.display_name,
263 cct.name as contributionType
264 FROM civicrm_contribution_soft ccs
265 LEFT JOIN civicrm_contribution cc
266 ON ccs.contribution_id = cc.id
267 LEFT JOIN civicrm_pcp cp
268 ON ccs.pcp_id = cp.id
269 LEFT JOIN civicrm_contact contact ON
270 ccs.contribution_id = cc.id AND cc.contact_id = contact.id
271 LEFT JOIN civicrm_financial_type cct ON cc.financial_type_id = cct.id
275 WHERE cc.is_test = %2 AND ccs.contact_id = %1";
280 $query .= "{$where} ORDER BY cc.receive_date DESC";
283 1 => array($contact_id, 'Integer'),
284 2 => array($isTest, 'Integer'),
286 $cs = CRM_Core_DAO
::executeQuery($query, $params);
287 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
289 while ($cs->fetch()) {
290 $result[$cs->id
]['amount'] = $cs->amount
;
291 $result[$cs->id
]['currency'] = $cs->currency
;
292 $result[$cs->id
]['contributor_id'] = $cs->contributor_id
;
293 $result[$cs->id
]['contribution_id'] = $cs->contribution_id
;
294 $result[$cs->id
]['contributor_name'] = $cs->display_name
;
295 $result[$cs->id
]['financial_type'] = $cs->contributionType
;
296 $result[$cs->id
]['receive_date'] = $cs->receive_date
;
297 $result[$cs->id
]['pcp_id'] = $cs->pcp_id
;
298 $result[$cs->id
]['pcp_title'] = $cs->pcp_title
;
299 $result[$cs->id
]['pcp_display_in_roll'] = $cs->pcp_display_in_roll
;
300 $result[$cs->id
]['pcp_roll_nickname'] = $cs->pcp_roll_nickname
;
301 $result[$cs->id
]['pcp_personal_note'] = $cs->pcp_personal_note
;
302 $result[$cs->id
]['contribution_status'] = CRM_Utils_Array
::value($cs->contribution_status_id
, $contributionStatus);
303 $result[$cs->id
]['sct_label'] = CRM_Core_OptionGroup
::getLabel('soft_credit_type', $cs->soft_credit_type_id
);
306 $result[$cs->id
]['contribution_status'] = $result[$cs->id
]['contribution_status'] . '<br /> (test)';
313 * Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id)
314 * is passed then whole honoreeprofile fields with title/value assoc array assigned or only honoreeName
321 * @param CRM_Core_Form $form
322 * @param array $params
323 * @param int $honoreeprofileId
324 * @param int $honorId
326 public static function formatHonoreeProfileFields($form, $params, $honoreeprofileId, $honorId = NULL) {
327 $profileContactType = CRM_Core_BAO_UFGroup
::getContactType($honoreeprofileId);
328 $profileFields = CRM_Core_BAO_UFGroup
::getFields($honoreeprofileId);
329 $honoreeProfileFields = $values = array();
333 CRM_Core_BAO_UFGroup
::getValues($honorId, $profileFields, $values, FALSE, $params);
334 if (empty($params)) {
335 foreach ($profileFields as $name => $field) {
336 $title = $field['title'];
337 $params[$field['name']] = $values[$title];
342 //remove name related fields and construct name string with prefix/suffix
343 //which will be later assigned to template
344 switch ($profileContactType) {
346 if (array_key_exists('prefix_id', $params)) {
347 $honorName = CRM_Utils_Array
::value(CRM_Utils_Array
::value('prefix_id', $params),
348 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id')
350 unset($profileFields['prefix_id']);
352 $honorName .= ' ' . $params['first_name'] . ' ' . $params['last_name'];
353 unset($profileFields['first_name']);
354 unset($profileFields['last_name']);
355 if (array_key_exists('suffix_id', $params)) {
356 $honorName .= ' ' . CRM_Utils_Array
::value(CRM_Utils_Array
::value('suffix_id', $params),
357 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id')
359 unset($profileFields['suffix_id']);
364 $honorName = $params['organization_name'];
365 unset($profileFields['organization_name']);
369 $honorName = $params['household_name'];
370 unset($profileFields['household_name']);
375 $honoreeProfileFields['Name'] = $honorName;
376 foreach ($profileFields as $name => $field) {
377 $title = $field['title'];
378 $honoreeProfileFields[$title] = $values[$title];
380 $form->assign('honoreeProfile', $honoreeProfileFields);
383 $form->assign('honorName', $honorName);