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