CRM/Report/Form/Contribute/Detail.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35 class CRM_Report_Form_Contribute_Detail extends CRM_Report_Form {
  36   protected $_addressField = FALSE;
  37
  38   protected $_emailField = FALSE;
  39
  40   protected $_summary = NULL;
  41   protected $_allBatches = NULL;
  42
  43   protected $_softFrom = NULL;
  44
  45   protected $_customGroupExtends = array(
  46     'Contact',
  47     'Individual',
  48     'Contribution',
  49   );
  50
  51   /**
  52    */
  53   public function __construct() {
  54     $this->_autoIncludeIndexedFieldsAsOrderBys = 1;
  55     // Check if CiviCampaign is a) enabled and b) has active campaigns
  56     $config = CRM_Core_Config::singleton();
  57     $campaignEnabled = in_array("CiviCampaign", $config->enableComponents);
  58     if ($campaignEnabled) {
  59       $getCampaigns = CRM_Campaign_BAO_Campaign::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
  60       $this->activeCampaigns = $getCampaigns['campaigns'];
  61       asort($this->activeCampaigns);
  62     }
  63     $this->_columns = array(
  64       'civicrm_contact' => array(
  65         'dao' => 'CRM_Contact_DAO_Contact',
  66         'fields' => array(
  67           'sort_name' => array(
  68             'title' => ts('Donor Name'),
  69             'required' => TRUE,
  70           ),
  71           'first_name' => array(
  72             'title' => ts('First Name'),
  73           ),
  74           'middle_name' => array(
  75             'title' => ts('Middle Name'),
  76           ),
  77           'last_name' => array(
  78             'title' => ts('Last Name'),
  79           ),
  80           'id' => array(
  81             'no_display' => TRUE,
  82             'required' => TRUE,
  83           ),
  84           'gender_id' => array(
  85             'title' => ts('Gender'),
  86           ),
  87           'birth_date' => array(
  88             'title' => ts('Birth Date'),
  89           ),
  90           'age' => array(
  91             'title' => ts('Age'),
  92             'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
  93           ),
  94           'contact_type' => array(
  95             'title' => ts('Contact Type'),
  96           ),
  97           'contact_sub_type' => array(
  98             'title' => ts('Contact Subtype'),
  99           ),
 100         ),
 101         'filters' => array(
 102           'sort_name' => array(
 103             'title' => ts('Donor Name'),
 104             'operator' => 'like',
 105           ),
 106           'id' => array(
 107             'title' => ts('Contact ID'),
 108             'no_display' => TRUE,
 109             'type' => CRM_Utils_Type::T_INT,
 110           ),
 111           'gender_id' => array(
 112             'title' => ts('Gender'),
 113             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 114             'options' => CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id'),
 115           ),
 116           'birth_date' => array(
 117             'title' => ts('Birth Date'),
 118             'operatorType' => CRM_Report_Form::OP_DATE,
 119           ),
 120           'contact_type' => array(
 121             'title' => ts('Contact Type'),
 122           ),
 123           'contact_sub_type' => array(
 124             'title' => ts('Contact Subtype'),
 125           ),
 126         ),
 127         'grouping' => 'contact-fields',
 128         'order_bys' => array(
 129           'sort_name' => array(
 130             'title' => ts('Last Name, First Name'),
 131             'default' => '1',
 132             'default_weight' => '0',
 133             'default_order' => 'ASC',
 134           ),
 135           'first_name' => array(
 136             'name' => 'first_name',
 137             'title' => ts('First Name'),
 138           ),
 139           'gender_id' => array(
 140             'name' => 'gender_id',
 141             'title' => ts('Gender'),
 142           ),
 143           'birth_date' => array(
 144             'name' => 'birth_date',
 145             'title' => ts('Birth Date'),
 146           ),
 147           'contact_type' => array(
 148             'title' => ts('Contact Type'),
 149           ),
 150           'contact_sub_type' => array(
 151             'title' => ts('Contact Subtype'),
 152           ),
 153         ),
 154
 155       ),
 156       'civicrm_email' => array(
 157         'dao' => 'CRM_Core_DAO_Email',
 158         'fields' => array(
 159           'email' => array(
 160             'title' => ts('Donor Email'),
 161             'default' => TRUE,
 162           ),
 163         ),
 164         'grouping' => 'contact-fields',
 165       ),
 166       'civicrm_line_item' => array(
 167         'dao' => 'CRM_Price_DAO_LineItem',
 168       ),
 169       'civicrm_phone' => array(
 170         'dao' => 'CRM_Core_DAO_Phone',
 171         'fields' => array(
 172           'phone' => array(
 173             'title' => ts('Donor Phone'),
 174             'default' => TRUE,
 175             'no_repeat' => TRUE,
 176           ),
 177         ),
 178         'grouping' => 'contact-fields',
 179       ),
 180       'civicrm_contribution' => array(
 181         'dao' => 'CRM_Contribute_DAO_Contribution',
 182         'fields' => array(
 183           'contribution_id' => array(
 184             'name' => 'id',
 185             'no_display' => TRUE,
 186             'required' => TRUE,
 187           ),
 188           'list_contri_id' => array(
 189             'name' => 'id',
 190             'title' => ts('Contribution ID'),
 191           ),
 192           'financial_type_id' => array(
 193             'title' => ts('Financial Type'),
 194             'default' => TRUE,
 195           ),
 196           'contribution_status_id' => array(
 197             'title' => ts('Contribution Status'),
 198           ),
 199           'contribution_page_id' => array(
 200             'title' => ts('Contribution Page'),
 201           ),
 202           'source' => array(
 203             'title' => ts('Source'),
 204           ),
 205           'payment_instrument_id' => array(
 206             'title' => ts('Payment Type'),
 207           ),
 208           'check_number' => array(
 209             'title' => ts('Check Number'),
 210           ),
 211           'currency' => array(
 212             'required' => TRUE,
 213             'no_display' => TRUE,
 214           ),
 215           'trxn_id' => NULL,
 216           'receive_date' => array('default' => TRUE),
 217           'receipt_date' => NULL,
 218           'total_amount' => array(
 219             'title' => ts('Amount'),
 220             'required' => TRUE,
 221             'statistics' => array('sum' => ts('Amount')),
 222           ),
 223           'fee_amount' => NULL,
 224           'net_amount' => NULL,
 225           'contribution_or_soft' => array(
 226             'title' => ts('Contribution OR Soft Credit?'),
 227             'dbAlias' => "'Contribution'",
 228           ),
 229           'soft_credits' => array(
 230             'title' => ts('Soft Credits'),
 231             'dbAlias' => "NULL",
 232           ),
 233           'soft_credit_for' => array(
 234             'title' => ts('Soft Credit For'),
 235             'dbAlias' => "NULL",
 236           ),
 237         ),
 238         'filters' => array(
 239           'contribution_or_soft' => array(
 240             'title' => ts('Contribution OR Soft Credit?'),
 241             'clause' => "(1)",
 242             'operatorType' => CRM_Report_Form::OP_SELECT,
 243             'type' => CRM_Utils_Type::T_STRING,
 244             'options' => array(
 245               'both' => ts('Both'),
 246               'contributions_only' => ts('Contributions Only'),
 247               'soft_credits_only' => ts('Soft Credits Only'),
 248             ),
 249           ),
 250           'receive_date' => array('operatorType' => CRM_Report_Form::OP_DATE),
 251           'currency' => array(
 252             'title' => 'Currency',
 253             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 254             'options' => CRM_Core_OptionGroup::values('currencies_enabled'),
 255             'default' => NULL,
 256             'type' => CRM_Utils_Type::T_STRING,
 257           ),
 258           'financial_type_id' => array(
 259             'title' => ts('Financial Type'),
 260             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 261             'options' => CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes(),
 262             'type' => CRM_Utils_Type::T_INT,
 263           ),
 264           'contribution_page_id' => array(
 265             'title' => ts('Contribution Page'),
 266             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 267             'options' => CRM_Contribute_PseudoConstant::contributionPage(),
 268             'type' => CRM_Utils_Type::T_INT,
 269           ),
 270           'payment_instrument_id' => array(
 271             'title' => ts('Payment Type'),
 272             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 273             'options' => CRM_Contribute_PseudoConstant::paymentInstrument(),
 274             'type' => CRM_Utils_Type::T_INT,
 275           ),
 276           'contribution_status_id' => array(
 277             'title' => ts('Contribution Status'),
 278             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 279             'options' => CRM_Contribute_PseudoConstant::contributionStatus(),
 280             'default' => array(1),
 281             'type' => CRM_Utils_Type::T_INT,
 282           ),
 283           'total_amount' => array('title' => ts('Contribution Amount')),
 284         ),
 285         'order_bys' => array(
 286           'financial_type_id' => array('title' => ts('Financial Type')),
 287           'contribution_status_id' => array('title' => ts('Contribution Status')),
 288           'payment_instrument_id' => array('title' => ts('Payment Method')),
 289           'receive_date' => array('title' => ts('Date Received')),
 290         ),
 291         'grouping' => 'contri-fields',
 292       ),
 293       'civicrm_contribution_soft' => array(
 294         'dao' => 'CRM_Contribute_DAO_ContributionSoft',
 295         'fields' => array(
 296           'soft_credit_type_id' => array('title' => ts('Soft Credit Type')),
 297         ),
 298         'filters' => array(
 299           'soft_credit_type_id' => array(
 300             'title' => 'Soft Credit Type',
 301             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 302             'options' => CRM_Core_OptionGroup::values('soft_credit_type'),
 303             'default' => NULL,
 304             'type' => CRM_Utils_Type::T_STRING,
 305           ),
 306         ),
 307       ),
 308       'civicrm_contribution_ordinality' => array(
 309         'dao' => 'CRM_Contribute_DAO_Contribution',
 310         'alias' => 'cordinality',
 311         'filters' => array(
 312           'ordinality' => array(
 313             'title' => ts('Contribution Ordinality'),
 314             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 315             'options' => array(
 316               0 => 'First by Contributor',
 317               1 => 'Second or Later by Contributor',
 318             ),
 319             'type' => CRM_Utils_Type::T_INT,
 320           ),
 321         ),
 322       ),
 323       'civicrm_note' => array(
 324         'dao' => 'CRM_Core_DAO_Note',
 325         'fields' => array(
 326           'contribution_note' => array(
 327             'name' => 'note',
 328             'title' => ts('Contribution Note'),
 329           ),
 330         ),
 331         'filters' => array(
 332           'note' => array(
 333             'name' => 'note',
 334             'title' => ts('Contribution Note'),
 335             'operator' => 'like',
 336             'type' => CRM_Utils_Type::T_STRING,
 337           ),
 338         ),
 339       ),
 340     ) + $this->addAddressFields(FALSE);
 341
 342     $this->_groupFilter = TRUE;
 343     $this->_tagFilter = TRUE;
 344
 345     // Don't show Batch display column and filter unless batches are being used
 346     $this->_allBatches = CRM_Batch_BAO_Batch::getBatches();
 347     if (!empty($this->_allBatches)) {
 348       $this->_columns['civicrm_batch']['dao'] = 'CRM_Batch_DAO_Batch';
 349       $this->_columns['civicrm_batch']['fields']['batch_id'] = array(
 350         'name' => 'id',
 351         'title' => ts('Batch Name'),
 352       );
 353       $this->_columns['civicrm_batch']['filters']['bid'] = array(
 354         'name' => 'id',
 355         'title' => ts('Batch Name'),
 356         'type' => CRM_Utils_Type::T_INT,
 357         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 358         'options' => $this->_allBatches,
 359       );
 360       $this->_columns['civicrm_entity_batch']['dao'] = 'CRM_Batch_DAO_EntityBatch';
 361       $this->_columns['civicrm_entity_batch']['fields']['entity_batch_id'] = array(
 362         'name' => 'batch_id',
 363         'default' => TRUE,
 364         'no_display' => TRUE,
 365       );
 366     }
 367
 368     // If we have active campaigns add those elements to both the fields and filters
 369     if ($campaignEnabled && !empty($this->activeCampaigns)) {
 370       $this->_columns['civicrm_contribution']['fields']['campaign_id'] = array(
 371         'title' => ts('Campaign'),
 372         'default' => 'false',
 373       );
 374       $this->_columns['civicrm_contribution']['filters']['campaign_id'] = array(
 375         'title' => ts('Campaign'),
 376         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 377         'options' => $this->activeCampaigns,
 378       );
 379       $this->_columns['civicrm_contribution']['order_bys']['campaign_id'] = array('title' => ts('Campaign'));
 380     }
 381
 382     $this->_currencyColumn = 'civicrm_contribution_currency';
 383     parent::__construct();
 384   }
 385
 386   public function preProcess() {
 387     parent::preProcess();
 388   }
 389
 390   public function select() {
 391     $this->_columnHeaders = array();
 392
 393     parent::select();
 394     //total_amount was affected by sum as it is considered as one of the stat field
 395     //so it is been replaced with correct alias, CRM-13833
 396     $this->_select = str_replace("sum({$this->_aliases['civicrm_contribution']}.total_amount)", "{$this->_aliases['civicrm_contribution']}.total_amount", $this->_select);
 397   }
 398
 399   public function orderBy() {
 400     parent::orderBy();
 401
 402     // please note this will just add the order-by columns to select query, and not display in column-headers.
 403     // This is a solution to not throw fatal errors when there is a column in order-by, not present in select/display columns.
 404     foreach ($this->_orderByFields as $orderBy) {
 405       if (!array_key_exists($orderBy['name'], $this->_params['fields']) &&
 406         empty($orderBy['section'])
 407       ) {
 408         $this->_select .= ", {$orderBy['dbAlias']} as {$orderBy['tplField']}";
 409       }
 410     }
 411   }
 412
 413   /**
 414    * @param bool $softcredit
 415    */
 416   public function from($softcredit = FALSE) {
 417     $this->_from = "
 418         FROM  civicrm_contact      {$this->_aliases['civicrm_contact']} {$this->_aclFrom}
 419               INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
 420                       ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution']}.contact_id AND {$this->_aliases['civicrm_contribution']}.is_test = 0";
 421     $this->getPermissionedFTQuery($this);
 422
 423     if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
 424       'both'
 425     ) {
 426       $this->_from .= "\n LEFT JOIN civicrm_contribution_soft contribution_soft_civireport
 427                          ON contribution_soft_civireport.contribution_id = {$this->_aliases['civicrm_contribution']}.id";
 428     }
 429     elseif (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
 430       'soft_credits_only'
 431     ) {
 432       $this->_from .= "\n INNER JOIN civicrm_contribution_soft contribution_soft_civireport
 433                          ON contribution_soft_civireport.contribution_id = {$this->_aliases['civicrm_contribution']}.id";
 434     }
 435
 436     if ($softcredit) {
 437       $this->_from = "
 438         FROM  civireport_contribution_detail_temp1 temp1_civireport
 439                INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
 440                        ON temp1_civireport.civicrm_contribution_contribution_id = {$this->_aliases['civicrm_contribution']}.id
 441                INNER JOIN civicrm_contribution_soft contribution_soft_civireport
 442                        ON contribution_soft_civireport.contribution_id = {$this->_aliases['civicrm_contribution']}.id
 443                INNER JOIN civicrm_contact      {$this->_aliases['civicrm_contact']}
 444                        ON {$this->_aliases['civicrm_contact']}.id = contribution_soft_civireport.contact_id
 445                {$this->_aclFrom}";
 446     }
 447
 448     if (!empty($this->_params['ordinality_value'])) {
 449       $this->_from .= "
 450               INNER JOIN (SELECT c.id, IF(COUNT(oc.id) = 0, 0, 1) AS ordinality FROM civicrm_contribution c LEFT JOIN civicrm_contribution oc ON c.contact_id = oc.contact_id AND oc.receive_date < c.receive_date GROUP BY c.id) {$this->_aliases['civicrm_contribution_ordinality']}
 451                       ON {$this->_aliases['civicrm_contribution_ordinality']}.id = {$this->_aliases['civicrm_contribution']}.id";
 452     }
 453
 454     $this->addPhoneFromClause();
 455
 456     if ($this->_addressField OR
 457       (!empty($this->_params['state_province_id_value']) OR
 458         !empty($this->_params['country_id_value']))
 459     ) {
 460       $this->_from .= "
 461             LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
 462                    ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id AND
 463                       {$this->_aliases['civicrm_address']}.is_primary = 1\n";
 464     }
 465
 466     if ($this->_emailField) {
 467       $this->_from .= "
 468             LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']}
 469                    ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id AND
 470                       {$this->_aliases['civicrm_email']}.is_primary = 1\n";
 471     }
 472     // include contribution note
 473     if (!empty($this->_params['fields']['contribution_note']) ||
 474       !empty($this->_params['note_value'])
 475     ) {
 476       $this->_from .= "
 477             LEFT JOIN civicrm_note {$this->_aliases['civicrm_note']}
 478                       ON ( {$this->_aliases['civicrm_note']}.entity_table = 'civicrm_contribution' AND
 479                            {$this->_aliases['civicrm_contribution']}.id = {$this->_aliases['civicrm_note']}.entity_id )";
 480     }
 481     //for contribution batches
 482     if ($this->_allBatches &&
 483       (!empty($this->_params['fields']['batch_id']) ||
 484         !empty($this->_params['bid_value']))
 485     ) {
 486       $this->_from .= "
 487                 LEFT JOIN civicrm_entity_financial_trxn tx ON (tx.entity_id = {$this->_aliases['civicrm_contribution']}.id AND
 488                    tx.entity_table = 'civicrm_contribution')
 489                  LEFT JOIN  civicrm_entity_batch {$this->_aliases['civicrm_entity_batch']}
 490                         ON ({$this->_aliases['civicrm_entity_batch']}.entity_id = tx.financial_trxn_id AND
 491                         {$this->_aliases['civicrm_entity_batch']}.entity_table = 'civicrm_financial_trxn')
 492                  LEFT JOIN civicrm_batch {$this->_aliases['civicrm_batch']}
 493                         ON {$this->_aliases['civicrm_batch']}.id = {$this->_aliases['civicrm_entity_batch']}.batch_id";
 494     }
 495   }
 496
 497   public function groupBy() {
 498     $this->_groupBy = " GROUP BY {$this->_aliases['civicrm_contact']}.id, {$this->_aliases['civicrm_contribution']}.id ";
 499   }
 500
 501   /**
 502    * @param $rows
 503    *
 504    * @return array
 505    */
 506   public function statistics(&$rows) {
 507     $statistics = parent::statistics($rows);
 508
 509     $totalAmount = $average = array();
 510     $count = 0;
 511     $select = "
 512         SELECT COUNT({$this->_aliases['civicrm_contribution']}.total_amount ) as count,
 513                SUM( {$this->_aliases['civicrm_contribution']}.total_amount ) as amount,
 514                ROUND(AVG({$this->_aliases['civicrm_contribution']}.total_amount), 2) as avg,
 515                {$this->_aliases['civicrm_contribution']}.currency as currency
 516         ";
 517
 518     $group = "\nGROUP BY {$this->_aliases['civicrm_contribution']}.currency";
 519     $sql = "{$select} {$this->_from} {$this->_where} {$group}";
 520     $dao = CRM_Core_DAO::executeQuery($sql);
 521
 522     while ($dao->fetch()) {
 523       $totalAmount[] = CRM_Utils_Money::format($dao->amount, $dao->currency) . " (" .
 524         $dao->count . ")";
 525       $average[] = CRM_Utils_Money::format($dao->avg, $dao->currency);
 526       $count += $dao->count;
 527     }
 528     $statistics['counts']['amount'] = array(
 529       'title' => ts('Total Amount (Contributions)'),
 530       'value' => implode(',  ', $totalAmount),
 531       'type' => CRM_Utils_Type::T_STRING,
 532     );
 533     $statistics['counts']['count'] = array(
 534       'title' => ts('Total Contributions'),
 535       'value' => $count,
 536     );
 537     $statistics['counts']['avg'] = array(
 538       'title' => ts('Average'),
 539       'value' => implode(',  ', $average),
 540       'type' => CRM_Utils_Type::T_STRING,
 541     );
 542
 543     // Stats for soft credits
 544     if ($this->_softFrom &&
 545       CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) !=
 546       'contributions_only'
 547     ) {
 548       $totalAmount = $average = array();
 549       $count = 0;
 550       $select = "
 551 SELECT COUNT(contribution_soft_civireport.amount ) as count,
 552        SUM(contribution_soft_civireport.amount ) as amount,
 553        ROUND(AVG(contribution_soft_civireport.amount), 2) as avg,
 554        {$this->_aliases['civicrm_contribution']}.currency as currency";
 555       $sql = "
 556 {$select}
 557 {$this->_softFrom}
 558 GROUP BY {$this->_aliases['civicrm_contribution']}.currency";
 559       $dao = CRM_Core_DAO::executeQuery($sql);
 560       while ($dao->fetch()) {
 561         $totalAmount[] = CRM_Utils_Money::format($dao->amount, $dao->currency) . " (" .
 562           $dao->count . ")";
 563         $average[] = CRM_Utils_Money::format($dao->avg, $dao->currency);
 564         $count += $dao->count;
 565       }
 566       $statistics['counts']['softamount'] = array(
 567         'title' => ts('Total Amount (Soft Credits)'),
 568         'value' => implode(',  ', $totalAmount),
 569         'type' => CRM_Utils_Type::T_STRING,
 570       );
 571       $statistics['counts']['softcount'] = array(
 572         'title' => ts('Total Soft Credits'),
 573         'value' => $count,
 574       );
 575       $statistics['counts']['softavg'] = array(
 576         'title' => ts('Average (Soft Credits)'),
 577         'value' => implode(',  ', $average),
 578         'type' => CRM_Utils_Type::T_STRING,
 579       );
 580     }
 581
 582     return $statistics;
 583   }
 584
 585   public function postProcess() {
 586     // get the acl clauses built before we assemble the query
 587     $this->buildACLClause($this->_aliases['civicrm_contact']);
 588
 589     $this->beginPostProcess();
 590
 591     if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
 592       'contributions_only' &&
 593       !empty($this->_params['fields']['soft_credit_type_id'])
 594     ) {
 595       unset($this->_params['fields']['soft_credit_type_id']);
 596       if (!empty($this->_params['soft_credit_type_id_value'])) {
 597         $this->_params['soft_credit_type_id_value'] = array();
 598       }
 599     }
 600
 601     // 1. use main contribution query to build temp table 1
 602     $sql = $this->buildQuery();
 603     $tempQuery = 'CREATE TEMPORARY TABLE civireport_contribution_detail_temp1 AS ' . $sql;
 604     CRM_Core_DAO::executeQuery($tempQuery);
 605     $this->setPager();
 606
 607     // 2. customize main contribution query for soft credit, and build temp table 2 with soft credit contributions only
 608     $this->from(TRUE);
 609     // also include custom group from if included
 610     // since this might be included in select
 611     $this->customDataFrom();
 612
 613     $select = str_ireplace('contribution_civireport.total_amount', 'contribution_soft_civireport.amount', $this->_select);
 614     $select = str_ireplace("'Contribution' as", "'Soft Credit' as", $select);
 615     // we inner join with temp1 to restrict soft contributions to those in temp1 table
 616     $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy}";
 617     $tempQuery = 'CREATE TEMPORARY TABLE civireport_contribution_detail_temp2 AS ' . $sql;
 618     CRM_Core_DAO::executeQuery($tempQuery);
 619     if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
 620       'soft_credits_only'
 621     ) {
 622       // revise pager : prev, next based on soft-credits only
 623       $this->setPager();
 624     }
 625
 626     // copy _from for later use of stats calculation for soft credits, and reset $this->_from to main query
 627     $this->_softFrom = $this->_from;
 628
 629     // simple reset of ->_from
 630     $this->from();
 631
 632     // also include custom group from if included
 633     // since this might be included in select
 634     $this->customDataFrom();
 635
 636     // 3. Decide where to populate temp3 table from
 637     if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
 638       'contributions_only'
 639     ) {
 640       $tempQuery = "(SELECT * FROM civireport_contribution_detail_temp1)";
 641     }
 642     elseif (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
 643       'soft_credits_only'
 644     ) {
 645       $tempQuery = "(SELECT * FROM civireport_contribution_detail_temp2)";
 646     }
 647     else {
 648       $tempQuery = "
 649 (SELECT * FROM civireport_contribution_detail_temp1)
 650 UNION ALL
 651 (SELECT * FROM civireport_contribution_detail_temp2)";
 652     }
 653
 654     // 4. build temp table 3
 655     $sql = "CREATE TEMPORARY TABLE civireport_contribution_detail_temp3 AS {$tempQuery}";
 656     CRM_Core_DAO::executeQuery($sql);
 657
 658     // 5. Re-construct order-by to make sense for final query on temp3 table
 659     $orderBy = '';
 660     if (!empty($this->_orderByArray)) {
 661       $aliases = array_flip($this->_aliases);
 662       $orderClause = array();
 663       foreach ($this->_orderByArray as $clause) {
 664         list($alias, $rest) = explode('.', $clause);
 665         $orderClause[] = $aliases[$alias] . "_" . $rest;
 666       }
 667       $orderBy = (!empty($orderClause)) ? "ORDER BY " . implode(', ', $orderClause) : '';
 668     }
 669
 670     // 6. show result set from temp table 3
 671     $rows = array();
 672     $sql = "SELECT * FROM civireport_contribution_detail_temp3 {$orderBy}";
 673     $this->buildRows($sql, $rows);
 674
 675     // format result set.
 676     $this->formatDisplay($rows, FALSE);
 677
 678     // assign variables to templates
 679     $this->doTemplateAssignment($rows);
 680
 681     // do print / pdf / instance stuff if needed
 682     $this->endPostProcess($rows);
 683   }
 684
 685   /**
 686    * Alter display of rows.
 687    *
 688    * Iterate through the rows retrieved via SQL and make changes for display purposes,
 689    * such as rendering contacts as links.
 690    *
 691    * @param array $rows
 692    *   Rows generated by SQL, with an array for each row.
 693    */
 694   public function alterDisplay(&$rows) {
 695     $checkList = array();
 696     $entryFound = FALSE;
 697     $display_flag = $prev_cid = $cid = 0;
 698     $contributionTypes = CRM_Contribute_PseudoConstant::financialType();
 699     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus();
 700     $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument();
 701     $contributionPages = CRM_Contribute_PseudoConstant::contributionPage();
 702
 703     foreach ($rows as $rowNum => $row) {
 704       if (!empty($this->_noRepeats) && $this->_outputMode != 'csv') {
 705         // don't repeat contact details if its same as the previous row
 706         if (array_key_exists('civicrm_contact_id', $row)) {
 707           if ($cid = $row['civicrm_contact_id']) {
 708             if ($rowNum == 0) {
 709               $prev_cid = $cid;
 710             }
 711             else {
 712               if ($prev_cid == $cid) {
 713                 $display_flag = 1;
 714                 $prev_cid = $cid;
 715               }
 716               else {
 717                 $display_flag = 0;
 718                 $prev_cid = $cid;
 719               }
 720             }
 721
 722             if ($display_flag) {
 723               foreach ($row as $colName => $colVal) {
 724                 // Hide repeats in no-repeat columns, but not if the field's a section header
 725                 if (in_array($colName, $this->_noRepeats) &&
 726                   !array_key_exists($colName, $this->_sections)
 727                 ) {
 728                   unset($rows[$rowNum][$colName]);
 729                 }
 730               }
 731             }
 732             $entryFound = TRUE;
 733           }
 734         }
 735       }
 736
 737       if (CRM_Utils_Array::value('civicrm_contribution_contribution_or_soft', $rows[$rowNum]) ==
 738         'Contribution'
 739       ) {
 740         unset($rows[$rowNum]['civicrm_contribution_soft_soft_credit_type_id']);
 741       }
 742
 743       // convert donor sort name to link
 744       if (array_key_exists('civicrm_contact_sort_name', $row) &&
 745         !empty($rows[$rowNum]['civicrm_contact_sort_name']) &&
 746         array_key_exists('civicrm_contact_id', $row)
 747       ) {
 748         $url = CRM_Utils_System::url("civicrm/contact/view",
 749           'reset=1&cid=' . $row['civicrm_contact_id'],
 750           $this->_absoluteUrl
 751         );
 752         $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
 753         $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact Summary for this Contact.");
 754       }
 755
 756       if ($value = CRM_Utils_Array::value('civicrm_contribution_financial_type_id', $row)) {
 757         $rows[$rowNum]['civicrm_contribution_financial_type_id'] = $contributionTypes[$value];
 758         $entryFound = TRUE;
 759       }
 760       if ($value = CRM_Utils_Array::value('civicrm_contribution_contribution_status_id', $row)) {
 761         $rows[$rowNum]['civicrm_contribution_contribution_status_id'] = $contributionStatus[$value];
 762         $entryFound = TRUE;
 763       }
 764       if ($value = CRM_Utils_Array::value('civicrm_contribution_contribution_page_id', $row)) {
 765         $rows[$rowNum]['civicrm_contribution_contribution_page_id'] = $contributionPages[$value];
 766         $entryFound = TRUE;
 767       }
 768       if ($value = CRM_Utils_Array::value('civicrm_contribution_payment_instrument_id', $row)) {
 769         $rows[$rowNum]['civicrm_contribution_payment_instrument_id'] = $paymentInstruments[$value];
 770         $entryFound = TRUE;
 771       }
 772       if (array_key_exists('civicrm_batch_batch_id', $row)) {
 773         if ($value = $row['civicrm_batch_batch_id']) {
 774           $rows[$rowNum]['civicrm_batch_batch_id'] = CRM_Core_DAO::getFieldValue('CRM_Batch_DAO_Batch', $value, 'title');
 775         }
 776         $entryFound = TRUE;
 777       }
 778
 779       // Contribution amount links to viewing contribution
 780       if (($value = CRM_Utils_Array::value('civicrm_contribution_total_amount_sum', $row)) &&
 781         CRM_Core_Permission::check('access CiviContribute')
 782       ) {
 783         $url = CRM_Utils_System::url("civicrm/contact/view/contribution",
 784           "reset=1&id=" . $row['civicrm_contribution_contribution_id'] .
 785           "&cid=" . $row['civicrm_contact_id'] .
 786           "&action=view&context=contribution&selectedChild=contribute",
 787           $this->_absoluteUrl
 788         );
 789         $rows[$rowNum]['civicrm_contribution_total_amount_sum_link'] = $url;
 790         $rows[$rowNum]['civicrm_contribution_total_amount_sum_hover'] = ts("View Details of this Contribution.");
 791         $entryFound = TRUE;
 792       }
 793
 794       // convert campaign_id to campaign title
 795       if (array_key_exists('civicrm_contribution_campaign_id', $row)) {
 796         if ($value = $row['civicrm_contribution_campaign_id']) {
 797           $rows[$rowNum]['civicrm_contribution_campaign_id'] = $this->activeCampaigns[$value];
 798           $entryFound = TRUE;
 799         }
 800       }
 801
 802       // soft credits
 803       if (array_key_exists('civicrm_contribution_soft_credits', $row) &&
 804         'Contribution' ==
 805         CRM_Utils_Array::value('civicrm_contribution_contribution_or_soft', $rows[$rowNum]) &&
 806         array_key_exists('civicrm_contribution_contribution_id', $row)
 807       ) {
 808         $query = "
 809 SELECT civicrm_contact_id, civicrm_contact_sort_name, civicrm_contribution_total_amount_sum, civicrm_contribution_currency
 810 FROM   civireport_contribution_detail_temp2
 811 WHERE  civicrm_contribution_contribution_id={$row['civicrm_contribution_contribution_id']}";
 812         $dao = CRM_Core_DAO::executeQuery($query);
 813         $string = '';
 814         $separator = ($this->_outputMode !== 'csv') ? "<br/>" : ' ';
 815         while ($dao->fetch()) {
 816           $url = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' .
 817             $dao->civicrm_contact_id);
 818           $string = $string . ($string ? $separator : '') .
 819             "<a href='{$url}'>{$dao->civicrm_contact_sort_name}</a> " .
 820             CRM_Utils_Money::format($dao->civicrm_contribution_total_amount_sum, $dao->civicrm_contribution_currency);
 821         }
 822         $rows[$rowNum]['civicrm_contribution_soft_credits'] = $string;
 823       }
 824
 825       if (array_key_exists('civicrm_contribution_soft_credit_for', $row) &&
 826         'Soft Credit' ==
 827         CRM_Utils_Array::value('civicrm_contribution_contribution_or_soft', $rows[$rowNum]) &&
 828         array_key_exists('civicrm_contribution_contribution_id', $row)
 829       ) {
 830         $query = "
 831 SELECT civicrm_contact_id, civicrm_contact_sort_name
 832 FROM   civireport_contribution_detail_temp1
 833 WHERE  civicrm_contribution_contribution_id={$row['civicrm_contribution_contribution_id']}";
 834         $dao = CRM_Core_DAO::executeQuery($query);
 835         $string = '';
 836         while ($dao->fetch()) {
 837           $url = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' .
 838             $dao->civicrm_contact_id);
 839           $string = $string .
 840             "\n<a href='{$url}'>{$dao->civicrm_contact_sort_name}</a>";
 841         }
 842         $rows[$rowNum]['civicrm_contribution_soft_credit_for'] = $string;
 843       }
 844
 845       //convert soft_credit_type_id into label
 846       if (array_key_exists('civicrm_contribution_soft_soft_credit_type_id', $rows[$rowNum])) {
 847         $rows[$rowNum]['civicrm_contribution_soft_soft_credit_type_id'] = CRM_Core_PseudoConstant::getLabel(
 848           'CRM_Contribute_BAO_ContributionSoft',
 849           'soft_credit_type_id',
 850           $row['civicrm_contribution_soft_soft_credit_type_id']
 851         );
 852       }
 853
 854       $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s) for this ') ? TRUE : $entryFound;
 855
 856       //handle gender
 857       if (array_key_exists('civicrm_contact_gender_id', $row)) {
 858         if ($value = $row['civicrm_contact_gender_id']) {
 859           $gender = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
 860           $rows[$rowNum]['civicrm_contact_gender_id'] = $gender[$value];
 861         }
 862         $entryFound = TRUE;
 863       }
 864
 865       // display birthday in the configured custom format
 866       if (array_key_exists('civicrm_contact_birth_date', $row)) {
 867         $birthDate = $row['civicrm_contact_birth_date'];
 868         if ($birthDate) {
 869           $rows[$rowNum]['civicrm_contact_birth_date'] = CRM_Utils_Date::customFormat($birthDate, '%Y%m%d');
 870         }
 871         $entryFound = TRUE;
 872       }
 873
 874       // skip looking further in rows, if first row itself doesn't
 875       // have the column we need
 876       if (!$entryFound) {
 877         break;
 878       }
 879       $lastKey = $rowNum;
 880     }
 881   }
 882
 883   public function sectionTotals() {
 884
 885     // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
 886     if (empty($this->_selectAliases)) {
 887       return;
 888     }
 889
 890     if (!empty($this->_sections)) {
 891       // build the query with no LIMIT clause
 892       $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select);
 893       $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
 894
 895       // pull section aliases out of $this->_sections
 896       $sectionAliases = array_keys($this->_sections);
 897
 898       $ifnulls = array();
 899       foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) {
 900         $ifnulls[] = "ifnull($alias, '') as $alias";
 901       }
 902
 903       /* Group (un-limited) report by all aliases and get counts. This might
 904        * be done more efficiently when the contents of $sql are known, ie. by
 905        * overriding this method in the report class.
 906        */
 907
 908       $addtotals = '';
 909
 910       if (array_search("civicrm_contribution_total_amount_sum", $this->_selectAliases) !==
 911         FALSE
 912       ) {
 913         $addtotals = ", sum(civicrm_contribution_total_amount_sum) as sumcontribs";
 914         $showsumcontribs = TRUE;
 915       }
 916
 917       $query = "select "
 918         . implode(", ", $ifnulls)
 919         .
 920         "$addtotals, count(*) as ct from civireport_contribution_detail_temp3 group by " .
 921         implode(", ", $sectionAliases);
 922       // initialize array of total counts
 923       $sumcontribs = $totals = array();
 924       $dao = CRM_Core_DAO::executeQuery($query);
 925       while ($dao->fetch()) {
 926
 927         // let $this->_alterDisplay translate any integer ids to human-readable values.
 928         $rows[0] = $dao->toArray();
 929         $this->alterDisplay($rows);
 930         $row = $rows[0];
 931
 932         // add totals for all permutations of section values
 933         $values = array();
 934         $i = 1;
 935         $aliasCount = count($sectionAliases);
 936         foreach ($sectionAliases as $alias) {
 937           $values[] = $row[$alias];
 938           $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values);
 939           if ($i == $aliasCount) {
 940             // the last alias is the lowest-level section header; use count as-is
 941             $totals[$key] = $dao->ct;
 942             if ($showsumcontribs) {
 943               $sumcontribs[$key] = $dao->sumcontribs;
 944             }
 945           }
 946           else {
 947             // other aliases are higher level; roll count into their total
 948             $totals[$key] = (array_key_exists($key, $totals)) ? $totals[$key] + $dao->ct : $dao->ct;
 949             if ($showsumcontribs) {
 950               $sumcontribs[$key] = array_key_exists($key, $sumcontribs) ? $sumcontribs[$key] + $dao->sumcontribs : $dao->sumcontribs;
 951             }
 952           }
 953         }
 954       }
 955       if ($showsumcontribs) {
 956         $totalandsum = array();
 957         // ts exception to avoid having ts("%1 %2: %3")
 958         $title = '%1 contributions / soft-credits: %2';
 959
 960         if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
 961           'contributions_only'
 962         ) {
 963           $title = '%1 contributions: %2';
 964         }
 965         elseif (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
 966           'soft_credits_only'
 967         ) {
 968           $title = '%1 soft-credits: %2';
 969         }
 970         foreach ($totals as $key => $total) {
 971           $totalandsum[$key] = ts($title, array(
 972             1 => $total,
 973             2 => CRM_Utils_Money::format($sumcontribs[$key]),
 974           ));
 975         }
 976         $this->assign('sectionTotals', $totalandsum);
 977       }
 978       else {
 979         $this->assign('sectionTotals', $totals);
 980       }
 981     }
 982   }
 983
 984 }