CRM/Contribute/BAO/ContributionSoft.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  32  */
  33 class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_ContributionSoft {
  34
  35   /**
  36    * Construct method.
  37    */
  38   public function __construct() {
  39     parent::__construct();
  40   }
  41
  42   /**
  43    * Add contribution soft credit record.
  44    *
  45    * @param array $params
  46    *   (reference ) an assoc array of name/value pairs.
  47    *
  48    * @return object
  49    *   soft contribution of object that is added
  50    */
  51   public static function add(&$params) {
  52     $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
  53     $contributionSoft->copyValues($params);
  54
  55     // set currency for CRM-1496
  56     if (!isset($contributionSoft->currency)) {
  57       $config = CRM_Core_Config::singleton();
  58       $contributionSoft->currency = $config->defaultCurrency;
  59     }
  60     return $contributionSoft->save();
  61   }
  62
  63   /**
  64    * Process the soft contribution and/or link to personal campaign page.
  65    *
  66    * @param array $params
  67    * @param object $contribution CRM_Contribute_DAO_Contribution
  68    *
  69    */
  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);
  74
  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'
  82       );
  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);
  93       }
  94     }
  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);
  99     }
 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]);
 107         }
 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;
 113         }
 114         CRM_Contribute_BAO_ContributionSoft::add($softParam);
 115       }
 116
 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);
 122         }
 123       }
 124     }
 125   }
 126
 127   /**
 128    * Function used to save pcp / soft credit entry.
 129    *
 130    * This is used by contribution and also event pcps
 131    *
 132    * @param array $params
 133    * @param object $form
 134    *   Form object.
 135    */
 136   public static function formatSoftCreditParams(&$params, &$form) {
 137     $pcp = $softParams = $softIDs = array();
 138     if (!empty($params['pcp_made_through_id'])) {
 139       $fields = array(
 140         'pcp_made_through_id',
 141         'pcp_display_in_roll',
 142         'pcp_roll_nickname',
 143         'pcp_personal_note',
 144       );
 145       foreach ($fields as $f) {
 146         $pcp[$f] = CRM_Utils_Array::value($f, $params);
 147       }
 148     }
 149
 150     if (!empty($form->_values['honoree_profile_id']) && !empty($params['soft_credit_type_id'])) {
 151       $honorId = NULL;
 152
 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);
 159       if (count($ids)) {
 160         $honorId = CRM_Utils_Array::value(0, $ids);
 161       }
 162
 163       $honorId = CRM_Contact_BAO_Contact::createProfileContact(
 164         $params['honor'], CRM_Core_DAO::$_nullArray,
 165         $honorId, NULL,
 166         $form->_values['honoree_profile_id']
 167       );
 168       $softParams[] = array(
 169         'contact_id' => $honorId,
 170         'soft_credit_type_id' => $params['soft_credit_type_id'],
 171       );
 172
 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")
 178           ),
 179           'honor_id' => $honorId,
 180           'honor_profile_id' => $form->_values['honoree_profile_id'],
 181           'honor_profile_values' => $params['honor'],
 182         );
 183       }
 184     }
 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];
 194           }
 195         }
 196       }
 197     }
 198
 199     $params['pcp'] = !empty($pcp) ? $pcp : NULL;
 200     $params['soft_credit'] = $softParams;
 201     $params['soft_credit_ids'] = $softIDs;
 202   }
 203
 204   /**
 205    * Fetch object based on array of properties.
 206    *
 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.
 211    *
 212    * @return CRM_Contribute_BAO_ContributionSoft
 213    */
 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;
 220     }
 221     return NULL;
 222   }
 223
 224   /**
 225    * Delete soft credits.
 226    *
 227    * @param array $params
 228    *
 229    */
 230   public static function del($params) {
 231     //delete from contribution soft table
 232     $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
 233     foreach ($params as $column => $value) {
 234       $contributionSoft->$column = $value;
 235     }
 236     $contributionSoft->delete();
 237   }
 238
 239   /**
 240    * @param int $contact_id
 241    * @param int $isTest
 242    *
 243    * @return array
 244    */
 245   public static function getSoftContributionTotals($contact_id, $isTest = 0) {
 246
 247     $whereClause = "AND cc.cancel_date IS NULL";
 248
 249     $query = "
 250     SELECT SUM(amount) as amount, AVG(total_amount) as average, cc.currency
 251     FROM civicrm_contribution_soft  ccs
 252       LEFT JOIN civicrm_contribution cc ON ccs.contribution_id = cc.id
 253     WHERE cc.is_test = %2 AND ccs.contact_id = %1 {$whereClause}
 254     GROUP BY currency";
 255
 256     $params = array(
 257       1 => array($contact_id, 'Integer'),
 258       2 => array($isTest, 'Integer'),
 259     );
 260
 261     $cs = CRM_Core_DAO::executeQuery($query, $params);
 262
 263     $count = 0;
 264     $amount = $average = $cancelAmount = array();
 265
 266     while ($cs->fetch()) {
 267       if ($cs->amount > 0) {
 268         $count++;
 269         $amount[] = $cs->amount;
 270         $average[] = $cs->average;
 271         $currency[] = $cs->currency;
 272       }
 273     }
 274
 275     //to get cancel amount
 276     $cancelAmountWhereClause = "AND cc.cancel_date IS NOT NULL";
 277     $query = str_replace($whereClause, $cancelAmountWhereClause, $query);
 278     $cancelAmountSQL  = CRM_Core_DAO::executeQuery($query, $params);
 279     while ($cancelAmountSQL->fetch()) {
 280       if ($cancelAmountSQL->amount > 0) {
 281         $count++;
 282         $cancelAmount[] = $cancelAmountSQL->amount;
 283       }
 284     }
 285
 286     if ($count > 0) {
 287       return array(
 288         implode(',&nbsp;', $amount),
 289         implode(',&nbsp;', $average),
 290         implode(',&nbsp;', $currency),
 291         implode(',&nbsp;', $cancelAmount),
 292       );
 293     }
 294     return array(0, 0);
 295   }
 296
 297   /**
 298    * Retrieve soft contributions for contribution record.
 299    *
 300    * @param int $contributionID
 301    * @param bool $all
 302    *   Include PCP data.
 303    *
 304    * @return array
 305    *   Array of soft contribution ids, amounts, and associated contact ids
 306    */
 307   public static function getSoftContribution($contributionID, $all = FALSE) {
 308     $pcpFields = array(
 309       'pcp_id',
 310       'pcp_title',
 311       'pcp_display_in_roll',
 312       'pcp_roll_nickname',
 313       'pcp_personal_note',
 314     );
 315
 316     $query = '
 317     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
 318     FROM civicrm_contribution_soft ccs INNER JOIN civicrm_contact c on c.id = ccs.contact_id
 319     LEFT JOIN civicrm_pcp cpcp ON ccs.pcp_id = cpcp.id
 320     WHERE contribution_id = %1;
 321     ';
 322
 323     $params = array(1 => array($contributionID, 'Integer'));
 324
 325     $dao = CRM_Core_DAO::executeQuery($query, $params);
 326
 327     $softContribution = array();
 328     $count = 1;
 329     while ($dao->fetch()) {
 330       if ($dao->pcp_id) {
 331         if ($all) {
 332           foreach ($pcpFields as $val) {
 333             $softContribution[$val] = $dao->$val;
 334           }
 335           $softContribution['pcp_soft_credit_to_name'] = $dao->display_name;
 336           $softContribution['pcp_soft_credit_to_id'] = $dao->contact_id;
 337         }
 338       }
 339       else {
 340         $softContribution['soft_credit'][$count] = array(
 341           'contact_id' => $dao->contact_id,
 342           'soft_credit_id' => $dao->id,
 343           'currency' => $dao->currency,
 344           'amount' => $dao->amount,
 345           'contact_name' => $dao->display_name,
 346           'soft_credit_type' => $dao->soft_credit_type_id,
 347           'soft_credit_type_label' => CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $dao->soft_credit_type_id),
 348         );
 349         $count++;
 350       }
 351     }
 352
 353     return $softContribution;
 354   }
 355
 356   /**
 357    * @param int $contributionID
 358    * @param bool $isPCP
 359    *
 360    * @return array
 361    */
 362   public static function getSoftCreditIds($contributionID, $isPCP = FALSE) {
 363     $query = "
 364   SELECT id
 365   FROM  civicrm_contribution_soft
 366   WHERE contribution_id = %1
 367   ";
 368
 369     if ($isPCP) {
 370       $query .= " AND pcp_id IS NOT NULL";
 371     }
 372     else {
 373       $query .= " AND pcp_id IS NULL";
 374     }
 375     $params = array(1 => array($contributionID, 'Integer'));
 376
 377     $dao = CRM_Core_DAO::executeQuery($query, $params);
 378     $id = array();
 379     $type = '';
 380     while ($dao->fetch()) {
 381       if ($isPCP) {
 382         return $dao->id;
 383       }
 384       $id[] = $dao->id;
 385     }
 386     return $id;
 387   }
 388
 389   /**
 390    *  Function to retrieve the list of soft contributions for given contact.
 391    *
 392    * @param int $contact_id
 393    *   Contact id.
 394    * @param string $filter
 395    * @param int $isTest
 396    *   Additional filter criteria, later used in where clause.
 397    *
 398    * @return array
 399    */
 400   public static function getSoftContributionList($contact_id, $filter = NULL, $isTest = 0) {
 401     $query = '
 402     SELECT ccs.id, ccs.amount as amount,
 403            ccs.contribution_id,
 404            ccs.pcp_id,
 405            ccs.pcp_display_in_roll,
 406            ccs.pcp_roll_nickname,
 407            ccs.pcp_personal_note,
 408            ccs.soft_credit_type_id,
 409            cc.receive_date,
 410            cc.contact_id as contributor_id,
 411            cc.contribution_status_id as contribution_status_id,
 412            cp.title as pcp_title,
 413            cc.currency,
 414            contact.display_name,
 415            cct.name as contributionType
 416     FROM civicrm_contribution_soft ccs
 417       LEFT JOIN civicrm_contribution cc
 418             ON ccs.contribution_id = cc.id
 419       LEFT JOIN civicrm_pcp cp
 420             ON ccs.pcp_id = cp.id
 421       LEFT JOIN civicrm_contact contact ON
 422       ccs.contribution_id = cc.id AND cc.contact_id = contact.id
 423       LEFT JOIN civicrm_financial_type cct ON cc.financial_type_id = cct.id
 424     ';
 425
 426     $where = "
 427       WHERE cc.is_test = %2 AND ccs.contact_id = %1";
 428     if ($filter) {
 429       $where .= $filter;
 430     }
 431
 432     $query .= "{$where} ORDER BY cc.receive_date DESC";
 433
 434     $params = array(
 435       1 => array($contact_id, 'Integer'),
 436       2 => array($isTest, 'Integer'),
 437     );
 438     $cs = CRM_Core_DAO::executeQuery($query, $params);
 439     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus();
 440     $result = array();
 441     while ($cs->fetch()) {
 442       $result[$cs->id]['amount'] = $cs->amount;
 443       $result[$cs->id]['currency'] = $cs->currency;
 444       $result[$cs->id]['contributor_id'] = $cs->contributor_id;
 445       $result[$cs->id]['contribution_id'] = $cs->contribution_id;
 446       $result[$cs->id]['contributor_name'] = $cs->display_name;
 447       $result[$cs->id]['financial_type'] = $cs->contributionType;
 448       $result[$cs->id]['receive_date'] = $cs->receive_date;
 449       $result[$cs->id]['pcp_id'] = $cs->pcp_id;
 450       $result[$cs->id]['pcp_title'] = $cs->pcp_title;
 451       $result[$cs->id]['pcp_display_in_roll'] = $cs->pcp_display_in_roll;
 452       $result[$cs->id]['pcp_roll_nickname'] = $cs->pcp_roll_nickname;
 453       $result[$cs->id]['pcp_personal_note'] = $cs->pcp_personal_note;
 454       $result[$cs->id]['contribution_status'] = CRM_Utils_Array::value($cs->contribution_status_id, $contributionStatus);
 455       $result[$cs->id]['sct_label'] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $cs->soft_credit_type_id);
 456
 457       if ($isTest) {
 458         $result[$cs->id]['contribution_status'] = $result[$cs->id]['contribution_status'] . '<br /> (test)';
 459       }
 460     }
 461     return $result;
 462   }
 463
 464   /**
 465    * Function to assign honor profile fields to template/form, if $honorId (as soft-credit's contact_id)
 466    * is passed  then  whole honoreeprofile fields with title/value assoc array assigned or only honoreeName
 467    * is assigned
 468    *
 469    * @param CRM_Core_Form $form
 470    * @param array $params
 471    * @param int $honorId
 472    */
 473   public static function formatHonoreeProfileFields($form, $params, $honorId = NULL) {
 474     if (empty($form->_values['honoree_profile_id'])) {
 475       return;
 476     }
 477     $profileContactType = CRM_Core_BAO_UFGroup::getContactType($form->_values['honoree_profile_id']);
 478     $profileFields = CRM_Core_BAO_UFGroup::getFields($form->_values['honoree_profile_id']);
 479     $honoreeProfileFields = $values = array();
 480     $honorName = NULL;
 481
 482     if ($honorId) {
 483       CRM_Core_BAO_UFGroup::getValues($honorId, $profileFields, $values, FALSE, $params);
 484       if (empty($params)) {
 485         foreach ($profileFields as $name => $field) {
 486           $title = $field['title'];
 487           $params[$field['name']] = $values[$title];
 488         }
 489       }
 490     }
 491
 492     //remove name related fields and construct name string with prefix/suffix
 493     //which will be later assigned to template
 494     switch ($profileContactType) {
 495       case 'Individual':
 496         if (array_key_exists('prefix_id', $params)) {
 497           $honorName = CRM_Utils_Array::value(CRM_Utils_Array::value('prefix_id', $params),
 498             CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id')
 499           );
 500           unset($profileFields['prefix_id']);
 501         }
 502         $honorName .= ' ' . $params['first_name'] . ' ' . $params['last_name'];
 503         unset($profileFields['first_name']);
 504         unset($profileFields['last_name']);
 505         if (array_key_exists('suffix_id', $params)) {
 506           $honorName .= ' ' . CRM_Utils_Array::value(CRM_Utils_Array::value('suffix_id', $params),
 507               CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id')
 508             );
 509           unset($profileFields['suffix_id']);
 510         }
 511         break;
 512
 513       case 'Organization':
 514         $honorName = $params['organization_name'];
 515         unset($profileFields['organization_name']);
 516         break;
 517
 518       case 'Household':
 519         $honorName = $params['household_name'];
 520         unset($profileFields['household_name']);
 521         break;
 522     }
 523
 524     if ($honorId) {
 525       $honoreeProfileFields['Name'] = $honorName;
 526       foreach ($profileFields as $name => $field) {
 527         $title = $field['title'];
 528         $honoreeProfileFields[$title] = $values[$title];
 529       }
 530       $form->assign('honoreeProfile', $honoreeProfileFields);
 531     }
 532     else {
 533       $form->assign('honorName', $honorName);
 534     }
 535   }
 536
 537 }