crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Report/Form/Contribute/PCP.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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_PCP extends CRM_Report_Form {
  36   /**
  37    */
  38   /**
  39    */
  40   public function __construct() {
  41     $this->_columns = array(
  42       'civicrm_contact' => array(
  43         'dao' => 'CRM_Contact_DAO_Contact',
  44         'fields' => array(
  45           'sort_name' => array(
  46             'title' => ts('Supporter'),
  47             'required' => TRUE,
  48             'default' => TRUE,
  49           ),
  50           'id' => array(
  51             'required' => TRUE,
  52             'no_display' => TRUE,
  53           ),
  54           'contact_type' => array(
  55             'title' => ts('Supporter Contact Type'),
  56           ),
  57           'contact_sub_type' => array(
  58             'title' => ts('Supporter Contact Subtype'),
  59           ),
  60         ),
  61         'filters' => array(
  62           'sort_name' => array(
  63             'title' => ts('Supporter Name'),
  64             'type' => CRM_Utils_Type::T_STRING,
  65             'operator' => 'like',
  66           ),
  67           'id' => array(
  68             'title' => ts('Contact ID'),
  69             'no_display' => TRUE,
  70           ),
  71         ),
  72         'grouping' => 'pcp-fields',
  73       ),
  74       'civicrm_contribution_page' => array(
  75         'dao' => 'CRM_Contribute_DAO_ContributionPage',
  76         'fields' => array(
  77           'page_title' => array(
  78             'title' => ts('Contribution Page Title'),
  79             'name' => 'title',
  80             'default' => TRUE,
  81           ),
  82         ),
  83         'filters' => array(
  84           'page_title' => array(
  85             'title' => ts('Contribution Page Title'),
  86             'name' => 'title',
  87             'type' => CRM_Utils_Type::T_STRING,
  88           ),
  89         ),
  90         'grouping' => 'pcp-fields',
  91       ),
  92       'civicrm_pcp' => array(
  93         'dao' => 'CRM_PCP_DAO_PCP',
  94         'fields' => array(
  95           'title' => array(
  96             'title' => ts('Personal Campaign Title'),
  97             'default' => TRUE,
  98           ),
  99           'goal_amount' => array(
 100             'title' => ts('Goal Amount'),
 101             'type' => CRM_Utils_Type::T_MONEY,
 102             'default' => TRUE,
 103           ),
 104         ),
 105         'filters' => array(
 106           'title' => array(
 107             'title' => ts('Personal Campaign Title'),
 108             'type' => CRM_Utils_Type::T_STRING,
 109           ),
 110         ),
 111         'grouping' => 'pcp-fields',
 112       ),
 113       'civicrm_contribution_soft' => array(
 114         'dao' => 'CRM_Contribute_DAO_ContributionSoft',
 115         'fields' => array(
 116           'amount_1' => array(
 117             'title' => ts('Committed Amount'),
 118             'name' => 'amount',
 119             'type' => CRM_Utils_Type::T_MONEY,
 120             'default' => TRUE,
 121             'statistics' => array(
 122               'sum' => ts('Committed Amount'),
 123             ),
 124           ),
 125           'amount_2' => array(
 126             'title' => ts('Amount Received'),
 127             'name' => 'amount',
 128             'type' => CRM_Utils_Type::T_MONEY,
 129             'default' => TRUE,
 130             // nice trick with dbAlias
 131             'dbAlias' => 'SUM(IF( contribution_civireport.contribution_status_id > 1, 0, contribution_soft_civireport.amount))',
 132           ),
 133           'soft_id' => array(
 134             'title' => ts('Number of Donors'),
 135             'name' => 'id',
 136             'default' => TRUE,
 137             'statistics' => array(
 138               'count' => ts('Number of Donors'),
 139             ),
 140           ),
 141         ),
 142         'filters' => array(
 143           'amount_2' => array(
 144             'title' => ts('Amount Received'),
 145             'type' => CRM_Utils_Type::T_MONEY,
 146             'dbAlias' => 'SUM(IF( contribution_civireport.contribution_status_id > 1, 0, contribution_soft_civireport.amount))',
 147           ),
 148         ),
 149         'grouping' => 'pcp-fields',
 150       ),
 151       'civicrm_contribution' => array(
 152         'dao' => 'CRM_Contribute_DAO_Contribution',
 153         'fields' => array(
 154           'contribution_id' => array(
 155             'name' => 'id',
 156             'no_display' => TRUE,
 157             'required' => TRUE,
 158           ),
 159           'receive_date' => array(
 160             'title' => ts('Most Recent Contribution'),
 161             'default' => TRUE,
 162             'statistics' => array(
 163               'max' => ts('Most Recent Contribution'),
 164             ),
 165           ),
 166         ),
 167         'grouping' => 'pcp-fields',
 168       ),
 169     );
 170
 171     parent::__construct();
 172   }
 173
 174   public function from() {
 175     $this->_from = "
 176 FROM civicrm_pcp {$this->_aliases['civicrm_pcp']}
 177
 178 LEFT JOIN civicrm_contribution_soft {$this->_aliases['civicrm_contribution_soft']}
 179           ON {$this->_aliases['civicrm_pcp']}.id =
 180              {$this->_aliases['civicrm_contribution_soft']}.pcp_id
 181
 182 LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
 183           ON {$this->_aliases['civicrm_contribution_soft']}.contribution_id =
 184              {$this->_aliases['civicrm_contribution']}.id
 185
 186 LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']}
 187           ON {$this->_aliases['civicrm_pcp']}.contact_id =
 188              {$this->_aliases['civicrm_contact']}.id
 189
 190 LEFT JOIN civicrm_contribution_page {$this->_aliases['civicrm_contribution_page']}
 191           ON {$this->_aliases['civicrm_pcp']}.page_id =
 192              {$this->_aliases['civicrm_contribution_page']}.id";
 193   }
 194
 195   public function groupBy() {
 196     $this->_groupBy = "GROUP BY {$this->_aliases['civicrm_pcp']}.id";
 197   }
 198
 199   public function orderBy() {
 200     $this->_orderBy = " ORDER BY {$this->_aliases['civicrm_contact']}.sort_name ";
 201   }
 202
 203   public function where() {
 204     $whereClauses = $havingClauses = array();
 205
 206     foreach ($this->_columns as $tableName => $table) {
 207       if (array_key_exists('filters', $table)) {
 208         foreach ($table['filters'] as $fieldName => $field) {
 209           $clause = NULL;
 210
 211           if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
 212             $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
 213             $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
 214             $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
 215             $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
 216           }
 217           else {
 218             $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
 219
 220             if ($op) {
 221               $clause = $this->whereClause($field,
 222                 $op,
 223                 CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
 224                 CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
 225                 CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
 226               );
 227             }
 228           }
 229
 230           if (!empty($clause)) {
 231             if ($tableName == 'civicrm_contribution_soft' &&
 232               $fieldName == 'amount_2'
 233             ) {
 234               $havingClauses[] = $clause;
 235             }
 236             else {
 237               $whereClauses[] = $clause;
 238             }
 239           }
 240         }
 241       }
 242     }
 243     if (empty($whereClauses)) {
 244       $this->_where = "WHERE ( 1 ) ";
 245     }
 246     else {
 247       $this->_where = "WHERE " . implode(' AND ', $whereClauses);
 248     }
 249     if ($this->_aclWhere) {
 250       $this->_where .= " AND {$this->_aclWhere} ";
 251     }
 252     $this->_having = "";
 253     if (!empty($havingClauses)) {
 254       // use this clause to construct group by clause.
 255       $this->_having = "HAVING " . implode(' AND ', $havingClauses);
 256     }
 257   }
 258
 259   /**
 260    * @param $rows
 261    *
 262    * @return array
 263    */
 264   public function statistics(&$rows) {
 265     $statistics = parent::statistics($rows);
 266
 267     $select
 268       = "SELECT SUM({$this->_aliases['civicrm_pcp']}.goal_amount) as goal_total, " .
 269         "SUM({$this->_aliases['civicrm_contribution_soft']}.amount) as committed_total, " .
 270         "COUNT({$this->_aliases['civicrm_contribution_soft']}.id) as donors_total, " .
 271         "SUM(IF( contribution_civireport.contribution_status_id > 1, 0, contribution_soft_civireport.amount)) AS received_total ";
 272     $sql = "{$select} {$this->_from} {$this->_where}";
 273     $dao = CRM_Core_DAO::executeQuery($sql);
 274     $dao->fetch();
 275     $statistics['counts']['goal_total'] = array(
 276       'title' => ts('Goal Total'),
 277       'value' => $dao->goal_total,
 278       'type' => CRM_Utils_Type::T_MONEY,
 279     );
 280     $statistics['counts']['committed_total'] = array(
 281       'title' => ts('Total Committed'),
 282       'value' => $dao->committed_total,
 283       'type' => CRM_Utils_Type::T_MONEY,
 284     );
 285     $statistics['counts']['received_total'] = array(
 286       'title' => ts('Total Received'),
 287       'value' => $dao->received_total,
 288       'type' => CRM_Utils_Type::T_MONEY,
 289     );
 290     $statistics['counts']['donors_total'] = array(
 291       'title' => ts('Total Donors'),
 292       'value' => $dao->donors_total,
 293       'type' => CRM_Utils_Type::T_INT,
 294     );
 295     return $statistics;
 296   }
 297
 298   /**
 299    * Alter display of rows.
 300    *
 301    * Iterate through the rows retrieved via SQL and make changes for display purposes,
 302    * such as rendering contacts as links.
 303    *
 304    * @param array $rows
 305    *   Rows generated by SQL, with an array for each row.
 306    */
 307   public function alterDisplay(&$rows) {
 308     $entryFound = FALSE;
 309     $checkList = array();
 310     foreach ($rows as $rowNum => $row) {
 311       if (!empty($this->_noRepeats) && $this->_outputMode != 'csv') {
 312         // not repeat contact sort names if it matches with the one
 313         // in previous row
 314         $repeatFound = FALSE;
 315
 316         foreach ($row as $colName => $colVal) {
 317           if (!empty($checkList[$colName]) &&
 318             is_array($checkList[$colName]) &&
 319             in_array($colVal, $checkList[$colName])
 320           ) {
 321             $rows[$rowNum][$colName] = "";
 322             $repeatFound = TRUE;
 323           }
 324           if (in_array($colName, $this->_noRepeats)) {
 325             $checkList[$colName][] = $colVal;
 326           }
 327         }
 328       }
 329
 330       if (array_key_exists('civicrm_contact_sort_name', $row) &&
 331         $rows[$rowNum]['civicrm_contact_sort_name'] &&
 332         array_key_exists('civicrm_contact_id', $row)
 333       ) {
 334         $url = CRM_Utils_System::url("civicrm/contact/view",
 335           'reset=1&cid=' . $row['civicrm_contact_id'],
 336           $this->_absoluteUrl
 337         );
 338         $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
 339         $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact Summary for this Contact.");
 340         $entryFound = TRUE;
 341       }
 342
 343       if (!$entryFound) {
 344         break;
 345       }
 346     }
 347   }
 348
 349 }