CRM/Contribute/BAO/ContributionSoft.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_ContributionSoft {
  36
  37   /**
  38    * construct method
  39    */
  40   function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * function to add contribution soft credit record
  46    *
  47    * @param array  $params (reference ) an assoc array of name/value pairs
  48    *
  49    * @return object soft contribution of object that is added
  50    * @access public
  51    *
  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    * Takes a bunch of params that are needed to match certain criteria and
  67    * retrieves the relevant objects. Typically the valid params are only
  68    * contact_id. We'll tweak this function to be more full featured over a period
  69    * of time. This is the inverse function of create. It also stores all the retrieved
  70    * values in the default array
  71    *
  72    * @param array $params   (reference ) an assoc array of name/value pairs
  73    * @param array $defaults (reference ) an assoc array to hold the flattened values
  74    *
  75    * @return object CRM_Contribute_BAO_ContributionSoft object
  76    * @access public
  77    * @static
  78    */
  79   static function retrieve(&$params, &$defaults) {
  80     $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
  81     $contributionSoft->copyValues($params);
  82     if ($contributionSoft->find(TRUE)) {
  83       CRM_Core_DAO::storeValues($contributionSoft, $defaults);
  84       return $contributionSoft;
  85     }
  86     return NULL;
  87   }
  88
  89   /**
  90    * Function to delete soft credits
  91    *
  92    * @param int $contributionTypeId
  93    * @static
  94    */
  95   static function del($params) {
  96     //delete from contribution soft table
  97     $contributionSoft = new CRM_Contribute_DAO_ContributionSoft();
  98     foreach($params as $column => $value) {
  99       $contributionSoft->$column = $value;
 100     }
 101     $contributionSoft->delete();
 102   }
 103
 104   static function getSoftContributionTotals($contact_id, $isTest = 0) {
 105     $query = '
 106     SELECT SUM(amount) as amount, AVG(total_amount) as average, cc.currency
 107     FROM civicrm_contribution_soft  ccs
 108       LEFT JOIN civicrm_contribution cc ON ccs.contribution_id = cc.id
 109     WHERE cc.is_test = %2 AND ccs.contact_id = %1
 110     GROUP BY currency';
 111
 112     $params = array(1 => array($contact_id, 'Integer'),
 113       2 => array($isTest, 'Integer'));
 114
 115     $cs = CRM_Core_DAO::executeQuery($query, $params);
 116
 117     $count = 0;
 118     $amount = $average = array();
 119
 120     while ($cs->fetch()) {
 121       if ($cs->amount > 0) {
 122         $count++;
 123         $amount[] = $cs->amount;
 124         $average[] = $cs->average;
 125         $currency[] = $cs->currency;
 126       }
 127     }
 128
 129     if ($count > 0) {
 130       return array(
 131         implode(',&nbsp;', $amount),
 132         implode(',&nbsp;', $average),
 133         implode(',&nbsp;', $currency),
 134       );
 135     }
 136     return array(0, 0);
 137   }
 138
 139   /**
 140    *  Function to retrieve soft contributions for contribution record.
 141    *  @param array $params an associated array
 142    *  @param boolean $all include PCP data
 143    *
 144    *  @return array of soft contribution ids, amounts, and associated contact ids
 145    *  @static
 146    */
 147   static function getSoftContribution($contributionID, $all = FALSE) {
 148     $pcpFields = array(
 149       'pcp_id',
 150       'pcp_display_in_roll',
 151       'pcp_roll_nickname',
 152       'pcp_personal_note',
 153     );
 154
 155     $query = '
 156     SELECT ccs.id, pcp_id, pcp_display_in_roll, pcp_roll_nickname, pcp_personal_note, amount, contact_id, c.display_name
 157     FROM civicrm_contribution_soft ccs INNER JOIN civicrm_contact c on c.id = ccs.contact_id
 158     WHERE contribution_id = %1;
 159     ';
 160
 161     $params = array(1 => array($contributionID, 'Integer'));
 162
 163     $dao = CRM_Core_DAO::executeQuery($query, $params);
 164
 165     $softContribution = array();
 166     $count = 1;
 167     while ($dao->fetch()) {
 168       if ($all) {
 169         foreach ($pcpFields as $val) {
 170           $softContribution[$val] = $dao->$val;
 171         }
 172       }
 173
 174       $softContribution['soft_credit'][$count] = array(
 175         'contact_id' => $dao->contact_id,
 176         'soft_credit_id' => $dao->id,
 177         'amount' => $dao->amount,
 178         'contact_name' => $dao->display_name
 179       );
 180       $count++;
 181     }
 182
 183     /*
 184      * FIX API before deleting this
 185     $cs = new CRM_Contribute_DAO_ContributionSoft();
 186     $cs->copyValues($params);
 187     $softContribution = array();
 188     $cs->find();
 189
 190     if ($cs->N > 0) {
 191       $count = 1;
 192       while ($cs->fetch()) {
 193         if ($all) {
 194           foreach ($pcpFields as $val) {
 195             $softContribution['pcp'][$val] = $cs->$val;
 196           }
 197         }
 198
 199         $softContribution['soft_credit'][$count] = array(
 200           'soft_credit_to' => $cs->contact_id,
 201           'soft_credit_id' => $cs->id,
 202           'soft_credit_amount' => $cs->amount,
 203         );
 204         $count++;
 205       }
 206     }
 207     */
 208
 209     return $softContribution;
 210   }
 211
 212   static function getSoftCreditType($contributionID) {
 213     $query = "
 214   SELECT id, pcp_id
 215   FROM  civicrm_contribution_soft
 216   WHERE contribution_id = %1
 217   ";
 218     $params = array(1 => array($contributionID, 'Integer'));
 219
 220     $dao = CRM_Core_DAO::executeQuery($query, $params);
 221     $id = array();
 222     $type = '';
 223     while ($dao->fetch()) {
 224       if ($dao->pcp_id) {
 225         $type = 'pcp';
 226       }
 227       else {
 228         $type = 'soft';
 229       }
 230       $id[] = $dao->id;
 231     }
 232     return array($type, $id);
 233   }
 234
 235   /**
 236    *  Function to retrieve the list of soft contributions for given contact.
 237    *  @param int $contact_id contact id
 238    *
 239    *  @return array
 240    *  @static
 241    */
 242   static function getSoftContributionList($contact_id, $isTest = 0) {
 243     $query = '
 244     SELECT ccs.id, ccs.amount as amount,
 245            ccs.contribution_id,
 246            ccs.pcp_id,
 247            ccs.pcp_display_in_roll,
 248            ccs.pcp_roll_nickname,
 249            ccs.pcp_personal_note,
 250            cc.receive_date,
 251            cc.contact_id as contributor_id,
 252            cc.contribution_status_id as contribution_status_id,
 253            cp.title as pcp_title,
 254            cc.currency,
 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
 265     WHERE cc.is_test = %2 AND ccs.contact_id = %1
 266     ORDER BY cc.receive_date DESC';
 267
 268     $params = array(
 269       1 => array($contact_id, 'Integer'),
 270       2 => array($isTest, 'Integer')
 271     );
 272     $cs = CRM_Core_DAO::executeQuery($query, $params);
 273     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus();
 274     $result = array();
 275     while ($cs->fetch()) {
 276       $result[$cs->id]['amount'] = $cs->amount;
 277       $result[$cs->id]['currency'] = $cs->currency;
 278       $result[$cs->id]['contributor_id'] = $cs->contributor_id;
 279       $result[$cs->id]['contribution_id'] = $cs->contribution_id;
 280       $result[$cs->id]['contributor_name'] = $cs->display_name;
 281       $result[$cs->id]['financial_type'] = $cs->contributionType;
 282       $result[$cs->id]['receive_date'] = $cs->receive_date;
 283       $result[$cs->id]['pcp_id'] = $cs->pcp_id;
 284       $result[$cs->id]['pcp_title'] = $cs->pcp_title;
 285       $result[$cs->id]['pcp_display_in_roll'] = $cs->pcp_display_in_roll;
 286       $result[$cs->id]['pcp_roll_nickname'] = $cs->pcp_roll_nickname;
 287       $result[$cs->id]['pcp_personal_note'] = $cs->pcp_personal_note;
 288       $result[$cs->id]['contribution_status'] = CRM_Utils_Array::value($cs->contribution_status_id, $contributionStatus);
 289
 290       if ($isTest) {
 291         $result[$cs->id]['contribution_status'] = $result[$cs->id]['contribution_status'] . '<br /> (test)';
 292       }
 293     }
 294     return $result;
 295   }
 296 }
 297