CRM/Report/Form/Contribute/Summary.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_Report_Form_Contribute_Summary extends CRM_Report_Form {
  34   protected $_addressField = FALSE;
  35
  36   protected $_charts = array(
  37     '' => 'Tabular',
  38     'barChart' => 'Bar Chart',
  39     'pieChart' => 'Pie Chart',
  40   );
  41   protected $_customGroupExtends = array('Contribution');
  42   protected $_customGroupGroupBy = TRUE;
  43
  44   public $_drilldownReport = array('contribute/detail' => 'Link to Detail Report');
  45
  46   /**
  47    * To what frequency group-by a date column
  48    *
  49    * @var array
  50    */
  51   protected $_groupByDateFreq = array(
  52     'MONTH' => 'Month',
  53     'YEARWEEK' => 'Week',
  54     'QUARTER' => 'Quarter',
  55     'YEAR' => 'Year',
  56     'FISCALYEAR' => 'Fiscal Year',
  57   );
  58
  59   /**
  60    * Class constructor.
  61    */
  62   public function __construct() {
  63
  64     // Check if CiviCampaign is a) enabled and b) has active campaigns
  65     $config = CRM_Core_Config::singleton();
  66     $campaignEnabled = in_array("CiviCampaign", $config->enableComponents);
  67     if ($campaignEnabled) {
  68       $getCampaigns = CRM_Campaign_BAO_Campaign::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
  69       $this->activeCampaigns = $getCampaigns['campaigns'];
  70       asort($this->activeCampaigns);
  71     }
  72
  73     $this->_columns = array(
  74       'civicrm_contact' => array(
  75         'dao' => 'CRM_Contact_DAO_Contact',
  76         'fields' => array_merge(
  77           $this->getBasicContactFields(),
  78           array(
  79             'sort_name' => array(
  80               'title' => ts('Contact Name'),
  81               'no_repeat' => TRUE,
  82             ),
  83           )
  84         ),
  85         'grouping' => 'contact-fields',
  86         'group_bys' => array(
  87           'id' => array('title' => ts('Contact ID')),
  88           'sort_name' => array(
  89             'title' => ts('Contact Name'),
  90           ),
  91         ),
  92       ),
  93       'civicrm_email' => array(
  94         'dao' => 'CRM_Core_DAO_Email',
  95         'fields' => array(
  96           'email' => array(
  97             'title' => ts('Email'),
  98             'no_repeat' => TRUE,
  99           ),
 100         ),
 101         'grouping' => 'contact-fields',
 102       ),
 103       'civicrm_line_item' => array(
 104         'dao' => 'CRM_Price_DAO_LineItem',
 105       ),
 106       'civicrm_phone' => array(
 107         'dao' => 'CRM_Core_DAO_Phone',
 108         'fields' => array(
 109           'phone' => array(
 110             'title' => ts('Phone'),
 111             'no_repeat' => TRUE,
 112           ),
 113         ),
 114         'grouping' => 'contact-fields',
 115       ),
 116       'civicrm_financial_type' => array(
 117         'dao' => 'CRM_Financial_DAO_FinancialType',
 118         'fields' => array('financial_type' => NULL),
 119         'grouping' => 'contri-fields',
 120         'group_bys' => array(
 121           'financial_type' => array('title' => ts('Financial Type')),
 122         ),
 123       ),
 124       'civicrm_contribution' => array(
 125         'dao' => 'CRM_Contribute_DAO_Contribution',
 126           //'bao'           => 'CRM_Contribute_BAO_Contribution',
 127         'fields' => array(
 128           'contribution_status_id' => array(
 129             'title' => ts('Contribution Status'),
 130           ),
 131           'contribution_source' => array('title' => ts('Source')),
 132           'currency' => array(
 133             'required' => TRUE,
 134             'no_display' => TRUE,
 135           ),
 136           'total_amount' => array(
 137             'title' => ts('Contribution Amount Stats'),
 138             'default' => TRUE,
 139             'statistics' => array(
 140               'count' => ts('Contributions'),
 141               'sum' => ts('Contribution Aggregate'),
 142               'avg' => ts('Contribution Avg'),
 143             ),
 144           ),
 145         ),
 146         'grouping' => 'contri-fields',
 147         'filters' => array(
 148           'receive_date' => array('operatorType' => CRM_Report_Form::OP_DATE),
 149           'contribution_status_id' => array(
 150             'title' => ts('Contribution Status'),
 151             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 152             'options' => CRM_Contribute_PseudoConstant::contributionStatus(),
 153             'default' => array(1),
 154             'type' => CRM_Utils_Type::T_INT,
 155           ),
 156           'currency' => array(
 157             'title' => 'Currency',
 158             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 159             'options' => CRM_Core_OptionGroup::values('currencies_enabled'),
 160             'default' => NULL,
 161             'type' => CRM_Utils_Type::T_STRING,
 162           ),
 163           'financial_type_id' => array(
 164             'title' => ts('Financial Type'),
 165             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 166             'options' => CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes(),
 167             'type' => CRM_Utils_Type::T_INT,
 168           ),
 169           'contribution_page_id' => array(
 170             'title' => ts('Contribution Page'),
 171             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 172             'options' => CRM_Contribute_PseudoConstant::contributionPage(),
 173             'type' => CRM_Utils_Type::T_INT,
 174           ),
 175           'total_amount' => array(
 176             'title' => ts('Contribution Amount'),
 177           ),
 178           'total_sum' => array(
 179             'title' => ts('Contribution Aggregate'),
 180             'type' => CRM_Report_Form::OP_INT,
 181             'dbAlias' => 'civicrm_contribution_total_amount_sum',
 182             'having' => TRUE,
 183           ),
 184           'total_count' => array(
 185             'title' => ts('Contribution Count'),
 186             'type' => CRM_Report_Form::OP_INT,
 187             'dbAlias' => 'civicrm_contribution_total_amount_count',
 188             'having' => TRUE,
 189           ),
 190           'total_avg' => array(
 191             'title' => ts('Contribution Avg'),
 192             'type' => CRM_Report_Form::OP_INT,
 193             'dbAlias' => 'civicrm_contribution_total_amount_avg',
 194             'having' => TRUE,
 195           ),
 196         ),
 197         'group_bys' => array(
 198           'receive_date' => array(
 199             'frequency' => TRUE,
 200             'default' => TRUE,
 201             'chart' => TRUE,
 202           ),
 203           'contribution_source' => NULL,
 204           'contribution_status_id' => array(
 205             'title' => ts('Contribution Status'),
 206             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 207             'options' => CRM_Contribute_PseudoConstant::contributionStatus(),
 208             'default' => array(1),
 209             'type' => CRM_Utils_Type::T_INT,
 210           ),
 211         ),
 212       ),
 213       'civicrm_batch' => array(
 214         'dao' => 'CRM_Batch_DAO_EntityBatch',
 215         'grouping' => 'contri-fields',
 216         'filters' => array(
 217           'batch_id' => array(
 218             'title' => ts('Batch Title'),
 219             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 220             'options' => CRM_Batch_BAO_Batch::getBatches(),
 221             'type' => CRM_Utils_Type::T_INT,
 222           ),
 223         ),
 224       ),
 225       'civicrm_contribution_soft' => array(
 226         'dao' => 'CRM_Contribute_DAO_ContributionSoft',
 227         'fields' => array(
 228           'soft_amount' => array(
 229             'title' => ts('Soft Credit Amount Stats'),
 230             'name' => 'amount',
 231             'statistics' => array(
 232               'count' => ts('Soft Credits'),
 233               'sum' => ts('Soft Credit Aggregate'),
 234               'avg' => ts('Soft Credit Avg'),
 235             ),
 236           ),
 237         ),
 238         'grouping' => 'contri-fields',
 239         'filters' => array(
 240           'amount' => array(
 241             'title' => ts('Soft Credit Amount'),
 242           ),
 243           'soft_credit_type_id' => array(
 244             'title' => 'Soft Credit Type',
 245             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 246             'options' => CRM_Core_OptionGroup::values('soft_credit_type'),
 247             'default' => NULL,
 248             'type' => CRM_Utils_Type::T_STRING,
 249           ),
 250           'soft_sum' => array(
 251             'title' => ts('Soft Credit Aggregate'),
 252             'type' => CRM_Report_Form::OP_INT,
 253             'dbAlias' => 'civicrm_contribution_soft_soft_amount_sum',
 254             'having' => TRUE,
 255           ),
 256           'soft_count' => array(
 257             'title' => ts('Soft Credits Count'),
 258             'type' => CRM_Report_Form::OP_INT,
 259             'dbAlias' => 'civicrm_contribution_soft_soft_amount_count',
 260             'having' => TRUE,
 261           ),
 262           'soft_avg' => array(
 263             'title' => ts('Soft Credit Avg'),
 264             'type' => CRM_Report_Form::OP_INT,
 265             'dbAlias' => 'civicrm_contribution_soft_soft_amount_avg',
 266             'having' => TRUE,
 267           ),
 268         ),
 269       ),
 270     ) + $this->addAddressFields();
 271
 272     // If we have a campaign, build out the relevant elements
 273     if ($campaignEnabled && !empty($this->activeCampaigns)) {
 274       $this->_columns['civicrm_contribution']['fields']['campaign_id'] = array(
 275         'title' => 'Campaign',
 276         'default' => 'false',
 277       );
 278       $this->_columns['civicrm_contribution']['filters']['campaign_id'] = array(
 279         'title' => ts('Campaign'),
 280         'type' => CRM_Utils_Type::T_INT,
 281         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 282         'options' => $this->activeCampaigns,
 283       );
 284       $this->_columns['civicrm_contribution']['group_bys']['campaign_id'] = array('title' => ts('Campaign'));
 285     }
 286
 287     $this->_tagFilter = TRUE;
 288     $this->_groupFilter = TRUE;
 289     $this->_currencyColumn = 'civicrm_contribution_currency';
 290     parent::__construct();
 291   }
 292
 293   /**
 294    * Set select clause.
 295    */
 296   public function select() {
 297     $select = array();
 298     $this->_columnHeaders = array();
 299     foreach ($this->_columns as $tableName => $table) {
 300       if (array_key_exists('group_bys', $table)) {
 301         foreach ($table['group_bys'] as $fieldName => $field) {
 302           if ($tableName == 'civicrm_address') {
 303             $this->_addressField = TRUE;
 304           }
 305           if (!empty($this->_params['group_bys'][$fieldName])) {
 306             switch (CRM_Utils_Array::value($fieldName, $this->_params['group_bys_freq'])) {
 307               case 'YEARWEEK':
 308                 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL WEEKDAY({$field['dbAlias']}) DAY) AS {$tableName}_{$fieldName}_start";
 309                 $select[] = "YEARWEEK({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
 310                 $select[] = "WEEKOFYEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
 311                 $field['title'] = 'Week';
 312                 break;
 313
 314               case 'YEAR':
 315                 $select[] = "MAKEDATE(YEAR({$field['dbAlias']}), 1)  AS {$tableName}_{$fieldName}_start";
 316                 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
 317                 $select[] = "YEAR({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
 318                 $field['title'] = 'Year';
 319                 break;
 320
 321               case 'FISCALYEAR':
 322                 $config = CRM_Core_Config::singleton();
 323                 $fy = $config->fiscalYearStart;
 324                 $fiscal = self::fiscalYearOffset($field['dbAlias']);
 325
 326                 $select[] = "DATE_ADD(MAKEDATE({$fiscal}, 1), INTERVAL ({$fy{'M'}})-1 MONTH) AS {$tableName}_{$fieldName}_start";
 327                 $select[] = "{$fiscal} AS {$tableName}_{$fieldName}_subtotal";
 328                 $select[] = "{$fiscal} AS {$tableName}_{$fieldName}_interval";
 329                 $field['title'] = 'Fiscal Year';
 330                 break;
 331
 332               case 'MONTH':
 333                 $select[] = "DATE_SUB({$field['dbAlias']}, INTERVAL (DAYOFMONTH({$field['dbAlias']})-1) DAY) as {$tableName}_{$fieldName}_start";
 334                 $select[] = "MONTH({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
 335                 $select[] = "MONTHNAME({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
 336                 $field['title'] = 'Month';
 337                 break;
 338
 339               case 'QUARTER':
 340                 $select[] = "STR_TO_DATE(CONCAT( 3 * QUARTER( {$field['dbAlias']} ) -2 , '/', '1', '/', YEAR( {$field['dbAlias']} ) ), '%m/%d/%Y') AS {$tableName}_{$fieldName}_start";
 341                 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_subtotal";
 342                 $select[] = "QUARTER({$field['dbAlias']}) AS {$tableName}_{$fieldName}_interval";
 343                 $field['title'] = 'Quarter';
 344                 break;
 345             }
 346             if (!empty($this->_params['group_bys_freq'][$fieldName])) {
 347               $this->_interval = $field['title'];
 348               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['title'] = $field['title'] . ' Beginning';
 349               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['type'] = $field['type'];
 350               $this->_columnHeaders["{$tableName}_{$fieldName}_start"]['group_by'] = $this->_params['group_bys_freq'][$fieldName];
 351
 352               // just to make sure these values are transferred to rows.
 353               // since we need that for calculation purpose,
 354               // e.g making subtotals look nicer or graphs
 355               $this->_columnHeaders["{$tableName}_{$fieldName}_interval"] = array('no_display' => TRUE);
 356               $this->_columnHeaders["{$tableName}_{$fieldName}_subtotal"] = array('no_display' => TRUE);
 357             }
 358           }
 359         }
 360       }
 361
 362       if (array_key_exists('fields', $table)) {
 363         foreach ($table['fields'] as $fieldName => $field) {
 364           if ($tableName == 'civicrm_address') {
 365             $this->_addressField = TRUE;
 366           }
 367           if (!empty($field['required']) ||
 368             !empty($this->_params['fields'][$fieldName])
 369           ) {
 370             // only include statistics columns if set
 371             if (!empty($field['statistics'])) {
 372               foreach ($field['statistics'] as $stat => $label) {
 373                 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
 374                 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
 375                 $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}";
 376                 switch (strtolower($stat)) {
 377                   case 'sum':
 378                     $select[] = "SUM({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}";
 379                     break;
 380
 381                   case 'count':
 382                     $select[] = "COUNT({$field['dbAlias']}) as {$tableName}_{$fieldName}_{$stat}";
 383                     $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = CRM_Utils_Type::T_INT;
 384                     break;
 385
 386                   case 'avg':
 387                     $select[] = "ROUND(AVG({$field['dbAlias']}),2) as {$tableName}_{$fieldName}_{$stat}";
 388                     break;
 389                 }
 390               }
 391             }
 392             else {
 393               $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
 394               $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
 395               $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field);
 396             }
 397           }
 398         }
 399       }
 400     }
 401
 402     $this->_select = "SELECT " . implode(', ', $select) . " ";
 403   }
 404
 405   /**
 406    * Set form rules.
 407    *
 408    * @param array $fields
 409    * @param array $files
 410    * @param CRM_Report_Form_Contribute_Summary $self
 411    *
 412    * @return array
 413    */
 414   public static function formRule($fields, $files, $self) {
 415     // Check for searching combination of display columns and
 416     // grouping criteria
 417     $ignoreFields = array('total_amount', 'sort_name');
 418     $errors = $self->customDataFormRule($fields, $ignoreFields);
 419
 420     if (empty($fields['fields']['total_amount'])) {
 421       foreach (array(
 422                  'total_count_value',
 423                  'total_sum_value',
 424                  'total_avg_value',
 425                ) as $val) {
 426         if (!empty($fields[$val])) {
 427           $errors[$val] = ts("Please select the Amount Statistics");
 428         }
 429       }
 430     }
 431
 432     return $errors;
 433   }
 434
 435   /**
 436    * Set from clause.
 437    *
 438    * @param string $entity
 439    */
 440   public function from($entity = NULL) {
 441     $softCreditJoinType = "LEFT";
 442     if (!empty($this->_params['fields']['soft_amount']) &&
 443       empty($this->_params['fields']['total_amount'])
 444     ) {
 445       // if its only soft credit stats, use inner join
 446       $softCreditJoinType = "INNER";
 447     }
 448
 449     $softCreditJoin = "{$softCreditJoinType} JOIN civicrm_contribution_soft {$this->_aliases['civicrm_contribution_soft']}
 450                        ON {$this->_aliases['civicrm_contribution_soft']}.contribution_id = {$this->_aliases['civicrm_contribution']}.id";
 451     if ($entity == 'contribution' || empty($this->_params['fields']['soft_amount'])) {
 452       $softCreditJoin .= " AND {$this->_aliases['civicrm_contribution_soft']}.id = (SELECT MIN(id) FROM civicrm_contribution_soft cs WHERE cs.contribution_id = {$this->_aliases['civicrm_contribution']}.id) ";
 453     }
 454
 455     $this->_from = "
 456         FROM civicrm_contact  {$this->_aliases['civicrm_contact']} {$this->_aclFrom}
 457              INNER JOIN civicrm_contribution   {$this->_aliases['civicrm_contribution']}
 458                      ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution']}.contact_id AND
 459                         {$this->_aliases['civicrm_contribution']}.is_test = 0
 460              {$softCreditJoin}
 461              LEFT  JOIN civicrm_financial_type  {$this->_aliases['civicrm_financial_type']}
 462                      ON {$this->_aliases['civicrm_contribution']}.financial_type_id ={$this->_aliases['civicrm_financial_type']}.id
 463              LEFT  JOIN civicrm_email {$this->_aliases['civicrm_email']}
 464                      ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id AND
 465                         {$this->_aliases['civicrm_email']}.is_primary = 1)
 466
 467              LEFT  JOIN civicrm_phone {$this->_aliases['civicrm_phone']}
 468                      ON ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_phone']}.contact_id AND
 469                         {$this->_aliases['civicrm_phone']}.is_primary = 1)";
 470
 471     if ($this->_addressField) {
 472       $this->_from .= "
 473                   LEFT JOIN civicrm_address {$this->_aliases['civicrm_address']}
 474                          ON {$this->_aliases['civicrm_contact']}.id =
 475                             {$this->_aliases['civicrm_address']}.contact_id AND
 476                             {$this->_aliases['civicrm_address']}.is_primary = 1\n";
 477     }
 478     if (!empty($this->_params['batch_id_value'])) {
 479       $this->_from .= "
 480                  LEFT JOIN civicrm_entity_financial_trxn eft
 481                         ON eft.entity_id = {$this->_aliases['civicrm_contribution']}.id AND
 482                            eft.entity_table = 'civicrm_contribution'
 483                  LEFT JOIN civicrm_entity_batch {$this->_aliases['civicrm_batch']}
 484                         ON {$this->_aliases['civicrm_batch']}.entity_id = eft.financial_trxn_id AND
 485                            {$this->_aliases['civicrm_batch']}.entity_table = 'civicrm_financial_trxn'\n";
 486     }
 487     $this->getPermissionedFTQuery($this);
 488   }
 489
 490   /**
 491    * Set group by clause.
 492    */
 493   public function groupBy() {
 494     $this->_groupBy = "";
 495     $append = FALSE;
 496     if (!empty($this->_params['group_bys']) &&
 497       is_array($this->_params['group_bys'])
 498     ) {
 499       foreach ($this->_columns as $tableName => $table) {
 500         if (array_key_exists('group_bys', $table)) {
 501           foreach ($table['group_bys'] as $fieldName => $field) {
 502             if (!empty($this->_params['group_bys'][$fieldName])) {
 503               if (!empty($field['chart'])) {
 504                 $this->assign('chartSupported', TRUE);
 505               }
 506
 507               if (!empty($table['group_bys'][$fieldName]['frequency']) &&
 508                 !empty($this->_params['group_bys_freq'][$fieldName])
 509               ) {
 510
 511                 $append = "YEAR({$field['dbAlias']}),";
 512                 if (in_array(strtolower($this->_params['group_bys_freq'][$fieldName]),
 513                   array('year')
 514                 )) {
 515                   $append = '';
 516                 }
 517                 if ($this->_params['group_bys_freq'][$fieldName] == 'FISCALYEAR') {
 518                   $this->_groupBy[] = self::fiscalYearOffset($field['dbAlias']);
 519                 }
 520                 else {
 521                   $this->_groupBy[] = "$append {$this->_params['group_bys_freq'][$fieldName]}({$field['dbAlias']})";
 522                 }
 523                 $append = TRUE;
 524               }
 525               else {
 526                 $this->_groupBy[] = $field['dbAlias'];
 527               }
 528             }
 529           }
 530         }
 531       }
 532
 533       if (!empty($this->_statFields) &&
 534         (($append && count($this->_groupBy) <= 1) || (!$append)) &&
 535         !$this->_having
 536       ) {
 537         $this->_rollup = " WITH ROLLUP";
 538       }
 539       $this->_groupBy = "GROUP BY " . implode(', ', $this->_groupBy) .
 540         " {$this->_rollup} ";
 541     }
 542     else {
 543       $this->_groupBy = "GROUP BY {$this->_aliases['civicrm_contact']}.id";
 544     }
 545   }
 546
 547   /**
 548    * Store having clauses as an array.
 549    */
 550   public function storeWhereHavingClauseArray() {
 551     parent::storeWhereHavingClauseArray();
 552     if (empty($this->_params['fields']['soft_amount']) &&
 553       !empty($this->_havingClauses)
 554     ) {
 555       foreach ($this->_havingClauses as $key => $havingClause) {
 556         if (stristr($havingClause, 'soft_soft')) {
 557           unset($this->_havingClauses[$key]);
 558         }
 559       }
 560     }
 561   }
 562
 563   /**
 564    * Set statistics.
 565    *
 566    * @param array $rows
 567    *
 568    * @return array
 569    */
 570   public function statistics(&$rows) {
 571     $statistics = parent::statistics($rows);
 572
 573     $softCredit = CRM_Utils_Array::value('soft_amount', $this->_params['fields']);
 574     $onlySoftCredit = $softCredit && !CRM_Utils_Array::value('total_amount', $this->_params['fields']);
 575     $group = "\nGROUP BY {$this->_aliases['civicrm_contribution']}.currency";
 576
 577     $this->from('contribution');
 578     $this->customDataFrom();
 579
 580     $contriQuery = "
 581 COUNT({$this->_aliases['civicrm_contribution']}.total_amount )        as civicrm_contribution_total_amount_count,
 582 SUM({$this->_aliases['civicrm_contribution']}.total_amount )          as civicrm_contribution_total_amount_sum,
 583 ROUND(AVG({$this->_aliases['civicrm_contribution']}.total_amount), 2) as civicrm_contribution_total_amount_avg,
 584 {$this->_aliases['civicrm_contribution']}.currency                    as currency
 585 {$this->_from} {$this->_where}";
 586
 587     if ($softCredit) {
 588       $this->from();
 589       $select = "
 590 COUNT({$this->_aliases['civicrm_contribution_soft']}.amount )        as civicrm_contribution_soft_soft_amount_count,
 591 SUM({$this->_aliases['civicrm_contribution_soft']}.amount )          as civicrm_contribution_soft_soft_amount_sum,
 592 ROUND(AVG({$this->_aliases['civicrm_contribution_soft']}.amount), 2) as civicrm_contribution_soft_soft_amount_avg";
 593       $contriQuery = "{$select}, {$contriQuery}";
 594       $softSQL = "SELECT {$select}, {$this->_aliases['civicrm_contribution']}.currency as currency
 595       {$this->_from} {$this->_where} {$group} {$this->_having}";
 596     }
 597
 598     $contriSQL = "SELECT {$contriQuery} {$group} {$this->_having}";
 599     $contriDAO = CRM_Core_DAO::executeQuery($contriSQL);
 600
 601     $totalAmount = $average = $mode = $median = $softTotalAmount = $softAverage = array();
 602     $count = $softCount = 0;
 603     while ($contriDAO->fetch()) {
 604       $totalAmount[]
 605         = CRM_Utils_Money::format($contriDAO->civicrm_contribution_total_amount_sum, $contriDAO->currency) .
 606         " (" . $contriDAO->civicrm_contribution_total_amount_count . ")";
 607       $average[] = CRM_Utils_Money::format($contriDAO->civicrm_contribution_total_amount_avg, $contriDAO->currency);
 608       $count += $contriDAO->civicrm_contribution_total_amount_count;
 609     }
 610
 611     $groupBy = "\n{$group}, {$this->_aliases['civicrm_contribution']}.total_amount";
 612     $orderBy = "\nORDER BY civicrm_contribution_total_amount_count DESC";
 613     $modeSQL = "SELECT civicrm_contribution_total_amount_count, amount, currency
 614     FROM (SELECT {$this->_aliases['civicrm_contribution']}.total_amount as amount,
 615     {$contriQuery} {$groupBy} {$orderBy}) as mode GROUP BY currency";
 616
 617     $mode = CRM_Contribute_BAO_Contribution::computeStats('mode', $modeSQL);
 618
 619     $medianSQL = "{$this->_from} {$this->_where}";
 620     $median = CRM_Contribute_BAO_Contribution::computeStats('median', $medianSQL, $this->_aliases['civicrm_contribution']);
 621
 622     if ($softCredit) {
 623       $softDAO = CRM_Core_DAO::executeQuery($softSQL);
 624       while ($softDAO->fetch()) {
 625         $softTotalAmount[]
 626           = CRM_Utils_Money::format($softDAO->civicrm_contribution_soft_soft_amount_sum, $softDAO->currency) .
 627           " (" . $softDAO->civicrm_contribution_soft_soft_amount_count . ")";
 628         $softAverage[] = CRM_Utils_Money::format($softDAO->civicrm_contribution_soft_soft_amount_avg, $softDAO->currency);
 629         $softCount += $softDAO->civicrm_contribution_soft_soft_amount_count;
 630       }
 631     }
 632
 633     if (!$onlySoftCredit) {
 634       $statistics['counts']['amount'] = array(
 635         'title' => ts('Total Amount'),
 636         'value' => implode(',  ', $totalAmount),
 637         'type' => CRM_Utils_Type::T_STRING,
 638       );
 639       $statistics['counts']['count'] = array(
 640         'title' => ts('Total Contributions'),
 641         'value' => $count,
 642       );
 643       $statistics['counts']['avg'] = array(
 644         'title' => ts('Average'),
 645         'value' => implode(',  ', $average),
 646         'type' => CRM_Utils_Type::T_STRING,
 647       );
 648       $statistics['counts']['mode'] = array(
 649         'title' => ts('Mode'),
 650         'value' => implode(',  ', $mode),
 651         'type' => CRM_Utils_Type::T_STRING,
 652       );
 653       $statistics['counts']['median'] = array(
 654         'title' => ts('Median'),
 655         'value' => implode(',  ', $median),
 656         'type' => CRM_Utils_Type::T_STRING,
 657       );
 658     }
 659     if ($softCredit) {
 660       $statistics['counts']['soft_amount'] = array(
 661         'title' => ts('Total Soft Credit Amount'),
 662         'value' => implode(',  ', $softTotalAmount),
 663         'type' => CRM_Utils_Type::T_STRING,
 664       );
 665       $statistics['counts']['soft_count'] = array(
 666         'title' => ts('Total Soft Credits'),
 667         'value' => $softCount,
 668       );
 669       $statistics['counts']['soft_avg'] = array(
 670         'title' => ts('Average Soft Credit'),
 671         'value' => implode(',  ', $softAverage),
 672         'type' => CRM_Utils_Type::T_STRING,
 673       );
 674     }
 675     return $statistics;
 676   }
 677
 678   /**
 679    * Post process function.
 680    */
 681   public function postProcess() {
 682     $this->buildACLClause($this->_aliases['civicrm_contact']);
 683     parent::postProcess();
 684   }
 685
 686   /**
 687    * Build table rows for output.
 688    *
 689    * @param string $sql
 690    * @param array $rows
 691    */
 692   public function buildRows($sql, &$rows) {
 693     $dao = CRM_Core_DAO::executeQuery($sql);
 694     if (!is_array($rows)) {
 695       $rows = array();
 696     }
 697
 698     // use this method to modify $this->_columnHeaders
 699     $this->modifyColumnHeaders();
 700     $contriRows = array();
 701     $unselectedSectionColumns = $this->unselectedSectionColumns();
 702
 703     //CRM-16338 if both soft-credit and contribution are enabled then process the contribution's
 704     //total amount's average, count and sum separately and add it to the respective result list
 705     $softCredit = (!empty($this->_params['fields']['soft_amount']) && !empty($this->_params['fields']['total_amount'])) ? TRUE : FALSE;
 706     if ($softCredit) {
 707       $this->from('contribution');
 708       $contriSQL = "{$this->_select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy} {$this->_limit}";
 709       $contriDAO = CRM_Core_DAO::executeQuery($contriSQL);
 710       $contriFields = array(
 711         'civicrm_contribution_total_amount_sum',
 712         'civicrm_contribution_total_amount_avg',
 713         'civicrm_contribution_total_amount_count');
 714       $contriRows = array();
 715       while ($contriDAO->fetch()) {
 716         $contriRow = array();
 717         foreach ($contriFields as $column) {
 718           $contriRow[$column] = $contriDAO->$column;
 719         }
 720         $contriRows[] = $contriRow;
 721       }
 722     }
 723
 724     $count = 0;
 725     while ($dao->fetch()) {
 726       $row = array();
 727       foreach ($this->_columnHeaders as $key => $value) {
 728         if ($softCredit && array_key_exists($key, $contriRows[$count])) {
 729           $row[$key] = $contriRows[$count][$key];
 730         }
 731         elseif (property_exists($dao, $key)) {
 732           $row[$key] = $dao->$key;
 733         }
 734       }
 735
 736       // section headers not selected for display need to be added to row
 737       foreach ($unselectedSectionColumns as $key => $values) {
 738         if (property_exists($dao, $key)) {
 739           $row[$key] = $dao->$key;
 740         }
 741       }
 742
 743       $count++;
 744       $rows[] = $row;
 745     }
 746
 747   }
 748
 749   /**
 750    * Build chart.
 751    *
 752    * @param array $rows
 753    */
 754   public function buildChart(&$rows) {
 755     $graphRows = array();
 756
 757     if (!empty($this->_params['charts'])) {
 758       if (!empty($this->_params['group_bys']['receive_date'])) {
 759
 760         $contrib = !empty($this->_params['fields']['total_amount']) ? TRUE : FALSE;
 761         $softContrib = !empty($this->_params['fields']['soft_amount']) ? TRUE : FALSE;
 762
 763         foreach ($rows as $key => $row) {
 764           if ($row['civicrm_contribution_receive_date_subtotal']) {
 765             $graphRows['receive_date'][] = $row['civicrm_contribution_receive_date_start'];
 766             $graphRows[$this->_interval][] = $row['civicrm_contribution_receive_date_interval'];
 767             if ($softContrib && $contrib) {
 768               // both contri & soft contri stats are present
 769               $graphRows['multiValue'][0][] = $row['civicrm_contribution_total_amount_sum'];
 770               $graphRows['multiValue'][1][] = $row['civicrm_contribution_soft_soft_amount_sum'];
 771             }
 772             elseif ($softContrib) {
 773               // only soft contributions
 774               $graphRows['multiValue'][0][] = $row['civicrm_contribution_soft_soft_amount_sum'];
 775             }
 776             else {
 777               // only contributions
 778               $graphRows['multiValue'][0][] = $row['civicrm_contribution_total_amount_sum'];
 779             }
 780           }
 781         }
 782
 783         if ($softContrib && $contrib) {
 784           $graphRows['barKeys'][0] = ts('Contributions');
 785           $graphRows['barKeys'][1] = ts('Soft Credits');
 786           $graphRows['legend'] = ts('Contributions and Soft Credits');
 787         }
 788         elseif ($softContrib) {
 789           $graphRows['legend'] = ts('Soft Credits');
 790         }
 791
 792         // build the chart.
 793         $config = CRM_Core_Config::Singleton();
 794         $graphRows['xname'] = $this->_interval;
 795         $graphRows['yname'] = "Amount ({$config->defaultCurrency})";
 796         CRM_Utils_OpenFlashChart::chart($graphRows, $this->_params['charts'], $this->_interval);
 797         $this->assign('chartType', $this->_params['charts']);
 798       }
 799     }
 800   }
 801
 802   /**
 803    * Alter display of rows.
 804    *
 805    * Iterate through the rows retrieved via SQL and make changes for display purposes,
 806    * such as rendering contacts as links.
 807    *
 808    * @param array $rows
 809    *   Rows generated by SQL, with an array for each row.
 810    */
 811   public function alterDisplay(&$rows) {
 812     $entryFound = FALSE;
 813     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus();
 814
 815     foreach ($rows as $rowNum => $row) {
 816       // make count columns point to detail report
 817       if (!empty($this->_params['group_bys']['receive_date']) &&
 818         !empty($row['civicrm_contribution_receive_date_start']) &&
 819         CRM_Utils_Array::value('civicrm_contribution_receive_date_start', $row) &&
 820         !empty($row['civicrm_contribution_receive_date_subtotal'])
 821       ) {
 822
 823         $dateStart = CRM_Utils_Date::customFormat($row['civicrm_contribution_receive_date_start'], '%Y%m%d');
 824         $endDate = new DateTime($dateStart);
 825         $dateEnd = array();
 826
 827         list($dateEnd['Y'], $dateEnd['M'], $dateEnd['d']) = explode(':', $endDate->format('Y:m:d'));
 828
 829         switch (strtolower($this->_params['group_bys_freq']['receive_date'])) {
 830           case 'month':
 831             $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] + 1,
 832               $dateEnd['d'] - 1, $dateEnd['Y']
 833             ));
 834             break;
 835
 836           case 'year':
 837             $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
 838               $dateEnd['d'] - 1, $dateEnd['Y'] + 1
 839             ));
 840             break;
 841
 842           case 'fiscalyear':
 843             $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
 844               $dateEnd['d'] - 1, $dateEnd['Y'] + 1
 845             ));
 846             break;
 847
 848           case 'yearweek':
 849             $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'],
 850               $dateEnd['d'] + 6, $dateEnd['Y']
 851             ));
 852             break;
 853
 854           case 'quarter':
 855             $dateEnd = date("Ymd", mktime(0, 0, 0, $dateEnd['M'] + 3,
 856               $dateEnd['d'] - 1, $dateEnd['Y']
 857             ));
 858             break;
 859         }
 860         $url = CRM_Report_Utils_Report::getNextUrl('contribute/detail',
 861           "reset=1&force=1&receive_date_from={$dateStart}&receive_date_to={$dateEnd}",
 862           $this->_absoluteUrl,
 863           $this->_id,
 864           $this->_drilldownReport
 865         );
 866         $rows[$rowNum]['civicrm_contribution_receive_date_start_link'] = $url;
 867         $rows[$rowNum]['civicrm_contribution_receive_date_start_hover'] = ts('List all contribution(s) for this date unit.');
 868         $entryFound = TRUE;
 869       }
 870
 871       // make subtotals look nicer
 872       if (array_key_exists('civicrm_contribution_receive_date_subtotal', $row) &&
 873         !$row['civicrm_contribution_receive_date_subtotal']
 874       ) {
 875         $this->fixSubTotalDisplay($rows[$rowNum], $this->_statFields);
 876         $entryFound = TRUE;
 877       }
 878
 879       // convert display name to links
 880       if (array_key_exists('civicrm_contact_sort_name', $row) &&
 881         array_key_exists('civicrm_contact_id', $row)
 882       ) {
 883         $url = CRM_Report_Utils_Report::getNextUrl('contribute/detail',
 884           'reset=1&force=1&id_op=eq&id_value=' . $row['civicrm_contact_id'],
 885           $this->_absoluteUrl, $this->_id, $this->_drilldownReport
 886         );
 887         $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
 888         $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("Lists detailed contribution(s) for this record.");
 889         $entryFound = TRUE;
 890       }
 891
 892       // convert contribution status id to status name
 893       if ($value = CRM_Utils_Array::value('civicrm_contribution_contribution_status_id', $row)) {
 894         $rows[$rowNum]['civicrm_contribution_contribution_status_id'] = $contributionStatus[$value];
 895         $entryFound = TRUE;
 896       }
 897
 898       // If using campaigns, convert campaign_id to campaign title
 899       if (array_key_exists('civicrm_contribution_campaign_id', $row)) {
 900         if ($value = $row['civicrm_contribution_campaign_id']) {
 901           $rows[$rowNum]['civicrm_contribution_campaign_id'] = $this->activeCampaigns[$value];
 902         }
 903         $entryFound = TRUE;
 904       }
 905
 906       $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s) for this ') ? TRUE : $entryFound;
 907       $entryFound = $this->alterDisplayContactFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s) for this ') ? TRUE : $entryFound;
 908
 909       // skip looking further in rows, if first row itself doesn't
 910       // have the column we need
 911       if (!$entryFound) {
 912         break;
 913       }
 914     }
 915   }
 916
 917 }