CRM/Report/Form/Contribute/HouseholdSummary.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28 */
  29
  30 /**
  31  *
  32  * @package CRM
  33  * @copyright CiviCRM LLC (c) 2004-2013
  34  * $Id$
  35  *
  36  */
  37 class CRM_Report_Form_Contribute_HouseholdSummary extends CRM_Report_Form {
  38
  39   protected $_addressField = FALSE;
  40
  41   protected $_emailField = FALSE;
  42
  43   public $_drilldownReport = array('contribute/detail' => 'Link to Detail Report');
  44
  45   protected $_summary = NULL;
  46
  47   function __construct() {
  48     self::validRelationships();
  49
  50     $config = CRM_Core_Config::singleton();
  51     $campaignEnabled = in_array("CiviCampaign", $config->enableComponents);
  52     if ($campaignEnabled) {
  53       $getCampaigns = CRM_Campaign_BAO_Campaign::getPermissionedCampaigns(NULL, NULL, TRUE, FALSE, TRUE);
  54       $this->activeCampaigns = $getCampaigns['campaigns'];
  55       asort($this->activeCampaigns);
  56     }
  57
  58     $this->_columns = array(
  59       'civicrm_contact_household' =>
  60       array(
  61         'dao' => 'CRM_Contact_DAO_Contact',
  62         'fields' =>
  63         array(
  64           'household_name' =>
  65           array('title' => ts('Household Name'),
  66             'required' => TRUE,
  67           ),
  68           'id' =>
  69           array(
  70             'no_display' => TRUE,
  71             'required' => TRUE,
  72           ),
  73         ),
  74         'filters' =>
  75         array(
  76           'household_name' =>
  77           array('title' => ts('Household Name')),
  78         ),
  79         'grouping' => 'household-fields',
  80       ),
  81       'civicrm_relationship' =>
  82       array(
  83         'dao' => 'CRM_Contact_DAO_Relationship',
  84         'fields' =>
  85         array(
  86           'relationship_type_id' =>
  87           array('title' => ts('Relationship Type'),
  88           ),
  89         ),
  90         'filters' =>
  91         array(
  92           'relationship_type_id' =>
  93           array(
  94             'title' => ts('Relationship Type'),
  95             'type' => CRM_Utils_Type::T_INT,
  96             'operatorType' => CRM_Report_Form::OP_SELECT,
  97             'options' => $this->relationTypes,
  98             'default' => array(1),
  99           ),
 100         ),
 101         'grouping' => 'household-fields',
 102       ),
 103       'civicrm_contact' =>
 104       array(
 105         'dao' => 'CRM_Contact_DAO_Contact',
 106         'fields' =>
 107         array(
 108           'sort_name' =>
 109           array('title' => ts('Contact Name'),
 110             'required' => TRUE,
 111           ),
 112           'id' =>
 113           array(
 114             'no_display' => TRUE,
 115             'required' => TRUE,
 116           ),
 117         ),
 118         'grouping' => 'contact-fields',
 119       ),
 120       'civicrm_contribution' =>
 121       array(
 122         'dao' => 'CRM_Contribute_DAO_Contribution',
 123         'fields' =>
 124         array('total_amount' => array('title' => ts('Amount'),
 125             'required' => TRUE,
 126           ),
 127           'id' => array(
 128             'no_display' => TRUE,
 129             'required' => TRUE,
 130           ),
 131           'contribution_status_id' => array(
 132             'title' => 'Contribution Status',
 133             'default' => TRUE,
 134           ),
 135           'currency' => array(
 136             'required' => TRUE,
 137             'no_display' => TRUE,
 138           ),
 139           'trxn_id' => NULL,
 140           'receive_date' => array('default' => TRUE),
 141           'receipt_date' => NULL,
 142         ),
 143         'filters' =>
 144         array(
 145           'receive_date' =>
 146           array('operatorType' => CRM_Report_Form::OP_DATE),
 147           'total_amount' =>
 148           array('title' => ts('Amount Between')),
 149           'currency' =>
 150           array('title' => 'Currency',
 151             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 152             'options' => CRM_Core_OptionGroup::values('currencies_enabled'),
 153             'default' => NULL,
 154             'type' => CRM_Utils_Type::T_STRING,
 155           ),
 156           'contribution_status_id' =>
 157           array('title' => ts('Contribution Status'),
 158             'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 159             'options' => CRM_Contribute_PseudoConstant::contributionStatus(),
 160             'default' => array(1),
 161           ),
 162         ),
 163         'grouping' => 'contri-fields',
 164       ),
 165       'civicrm_address' =>
 166       array(
 167         'dao' => 'CRM_Core_DAO_Address',
 168         'fields' =>
 169         array(
 170           'street_address' => NULL,
 171           'city' => NULL,
 172           'postal_code' => NULL,
 173           'state_province_id' =>
 174           array('title' => ts('State/Province'),
 175           ),
 176           'country_id' =>
 177           array('title' => ts('Country'),
 178           ),
 179         ),
 180         'grouping' => 'contact-fields',
 181       ),
 182       'civicrm_email' =>
 183       array(
 184         'dao' => 'CRM_Core_DAO_Email',
 185         'fields' =>
 186         array('email' => NULL),
 187         'grouping' => 'contact-fields',
 188       ),
 189     );
 190
 191     if ($campaignEnabled && !empty($this->activeCampaigns)) {
 192       $this->_columns['civicrm_contribution']['fields']['campaign_id'] = array(
 193         'title' => 'Campaign',
 194         'default' => 'false',
 195       );
 196       $this->_columns['civicrm_contribution']['filters']['campaign_id'] = array('title' => ts('Campaign'),
 197         'operatorType' => CRM_Report_Form::OP_MULTISELECT,
 198         'options' => $this->activeCampaigns,
 199       );
 200     }
 201     $this->_currencyColumn = 'civicrm_contribution_currency';
 202     parent::__construct();
 203   }
 204
 205   function preProcess() {
 206     parent::preProcess();
 207   }
 208
 209   function select() {
 210     $this->_columnHeaders = $select = array();
 211     foreach ($this->_columns as $tableName => $table) {
 212       if (array_key_exists('fields', $table)) {
 213         foreach ($table['fields'] as $fieldName => $field) {
 214           if (CRM_Utils_Array::value('required', $field) ||
 215             CRM_Utils_Array::value($fieldName, $this->_params['fields'])
 216           ) {
 217             if ($tableName == 'civicrm_address') {
 218               $this->_addressField = TRUE;
 219             }
 220             elseif ($tableName == 'civicrm_email') {
 221               $this->_emailField = TRUE;
 222             }
 223
 224             if (CRM_Utils_Array::value('statistics', $field)) {
 225               foreach ($field['statistics'] as $stat => $label) {
 226                 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}_{$stat}";
 227                 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['title'] = $label;
 228                 $this->_columnHeaders["{$tableName}_{$fieldName}_{$stat}"]['type'] = $field['type'];
 229                 $this->_statFields[] = "{$tableName}_{$fieldName}_{$stat}";
 230               }
 231             }
 232             else {
 233               $select[] = "{$table['alias']}.{$fieldName} as {$tableName}_{$fieldName}";
 234
 235               $this->_columnHeaders["{$tableName}_{$fieldName}"]['title'] = CRM_Utils_Array::value('title', $field);
 236               $this->_columnHeaders["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array::value('type', $field);
 237             }
 238           }
 239         }
 240       }
 241     }
 242     $this->_select = "SELECT " . implode(', ', $select) . " ";
 243   }
 244
 245   function from() {
 246
 247     $this->_from = NULL;
 248     $this->_from = "
 249         FROM  civicrm_relationship {$this->_aliases['civicrm_relationship']}
 250             LEFT  JOIN civicrm_contact {$this->_aliases['civicrm_contact_household']} ON
 251                       ({$this->_aliases['civicrm_contact_household']}.id = {$this->_aliases['civicrm_relationship']}.$this->householdContact AND {$this->_aliases['civicrm_contact_household']}.contact_type='Household')
 252             LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']} ON
 253                       ({$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_relationship']}.$this->otherContact )
 254             {$this->_aclFrom}
 255             INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']} ON
 256                       ({$this->_aliases['civicrm_contribution']}.contact_id = {$this->_aliases['civicrm_relationship']}.$this->otherContact ) AND {$this->_aliases['civicrm_contribution']}.is_test = 0 ";
 257
 258     if ($this->_addressField) {
 259       $this->_from .= "
 260             LEFT JOIN civicrm_address  {$this->_aliases['civicrm_address']} ON
 261                       {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_address']}.contact_id AND
 262                       {$this->_aliases['civicrm_address']}.is_primary = 1\n ";
 263     }
 264     if ($this->_emailField) {
 265       $this->_from .= "
 266             LEFT JOIN civicrm_email {$this->_aliases['civicrm_email']} ON
 267                       {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_email']}.contact_id AND
 268                       {$this->_aliases['civicrm_email']}.is_primary = 1\n ";
 269     }
 270   }
 271
 272   function where() {
 273     $clauses = array();
 274     foreach ($this->_columns as $tableName => $table) {
 275       if (array_key_exists('filters', $table)) {
 276         foreach ($table['filters'] as $fieldName => $field) {
 277           $clause = NULL;
 278           if (CRM_Utils_Array::value('type', $field) & CRM_Utils_Type::T_DATE) {
 279             $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
 280             $from     = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
 281             $to       = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
 282
 283             $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
 284           }
 285           else {
 286             $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
 287             if ($op) {
 288               if ($fieldName == 'relationship_type_id') {
 289                 $clause = "{$this->_aliases['civicrm_relationship']}.relationship_type_id=" . $this->relationshipId;
 290               }
 291               else {
 292                 $clause = $this->whereClause($field,
 293                   $op,
 294                   CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
 295                   CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
 296                   CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
 297                 );
 298               }
 299             }
 300           }
 301
 302           if (!empty($clause)) {
 303             $clauses[] = $clause;
 304           }
 305         }
 306       }
 307     }
 308
 309     if (empty($clauses)) {
 310       $this->_where = "WHERE ( 1 )";
 311     }
 312     else {
 313       $this->_where = "WHERE " . implode(' AND ', $clauses);
 314     }
 315
 316     if ($this->_aclWhere) {
 317       $this->_where .= " AND {$this->_aclWhere} ";
 318     }
 319   }
 320
 321   function groupBy() {
 322     $this->_groupBy = " GROUP BY {$this->_aliases['civicrm_relationship']}.$this->householdContact, {$this->_aliases['civicrm_relationship']}.$this->otherContact , {$this->_aliases['civicrm_contribution']}.id, {$this->_aliases['civicrm_relationship']}.relationship_type_id ";
 323   }
 324
 325   function orderBy() {
 326     $this->_orderBy = " ORDER BY {$this->_aliases['civicrm_contact_household']}.household_name, {$this->_aliases['civicrm_relationship']}.$this->householdContact, {$this->_aliases['civicrm_contact']}.sort_name, {$this->_aliases['civicrm_relationship']}.$this->otherContact";
 327   }
 328
 329   function statistics(&$rows) {
 330     $statistics = parent::statistics($rows);
 331
 332     //hack filter display for relationship type
 333     $type = substr($this->_params['relationship_type_id_value'], -3);
 334     foreach ($statistics['filters'] as $id => $value) {
 335       if (
 336         $value['title'] == 'Relationship Type' &&
 337         isset($this->relationTypes[$this->relationshipId . '_' . $type])
 338       ) {
 339         $statistics['filters'][$id]['value'] = 'Is equal to ' . $this->relationTypes[$this->relationshipId . '_' . $type];
 340       }
 341     }
 342     return $statistics;
 343   }
 344
 345   function postProcess() {
 346
 347     $this->beginPostProcess();
 348     $getRelationship = $this->_params['relationship_type_id_value'];
 349     $type = substr($getRelationship, -3);
 350     $this->relationshipId = intval((substr($getRelationship, 0, strpos($getRelationship, '_'))));
 351     if ($type == 'b_a') {
 352       $this->householdContact = 'contact_id_b';
 353       $this->otherContact = 'contact_id_a';
 354     }
 355     else {
 356       $this->householdContact = 'contact_id_a';
 357       $this->otherContact = 'contact_id_b';
 358     }
 359     $this->buildACLClause(array($this->_aliases['civicrm_contact'], $this->_aliases['civicrm_contact_household']));
 360     $sql = $this->buildQuery(TRUE);
 361     $rows = array();
 362
 363     $this->buildRows($sql, $rows);
 364     $this->formatDisplay($rows);
 365     $this->doTemplateAssignment($rows);
 366     $this->endPostProcess($rows);
 367   }
 368
 369   function validRelationships() {
 370     $this->relationTypes = $relationTypes = array();
 371
 372     $params = array('contact_type_b' => 'Household', 'version' => 3);
 373     $typesA = civicrm_api('relationship_type', 'get', $params);
 374     if (!CRM_Utils_Array::value('is_error', $typesA)) {
 375       foreach ($typesA['values'] as $rel) {
 376         $relationTypes[$rel['id']][$rel['id'] . '_b_a'] = $rel['label_b_a'];
 377       }
 378     }
 379     $params = array('contact_type_a' => 'Household', 'version' => 3);
 380     $typesB = civicrm_api('relationship_type', 'get', $params);
 381     if (!CRM_Utils_Array::value('is_error', $typesB)) {
 382       foreach ($typesB['values'] as $rel) {
 383         $relationTypes[$rel['id']][$rel['id'] . '_a_b'] = $rel['label_a_b'];
 384         //$this->relationTypes[$rel['id'].'_a_b'] = $rel['label_a_b'];
 385       }
 386     }
 387
 388     ksort($relationTypes);
 389     foreach ($relationTypes as $relationship) {
 390       foreach ($relationship as $index => $label) {
 391         $this->relationTypes[$index] = $label;
 392       }
 393     }
 394   }
 395
 396   function alterDisplay(&$rows) {
 397     // custom code to alter rows
 398     $type = substr($this->_params['relationship_type_id_value'], -3);
 399
 400     $entryFound = FALSE;
 401     $flagHousehold = $flagContact = 0;
 402     foreach ($rows as $rowNum => $row) {
 403
 404       //replace retionship id by relationship name
 405       if (array_key_exists('civicrm_relationship_relationship_type_id', $row)) {
 406         if ($value = $row['civicrm_relationship_relationship_type_id']) {
 407           $rows[$rowNum]['civicrm_relationship_relationship_type_id'] = $this->relationTypes[$value . '_' . $type];
 408           $entryFound = TRUE;
 409         }
 410       }
 411
 412       //remove duplicate Organization names
 413       if (array_key_exists('civicrm_contact_household_household_name', $row) && $this->_outputMode != 'csv') {
 414         if ($value = $row['civicrm_contact_household_household_name']) {
 415           if ($rowNum == 0) {
 416             $priviousHousehold = $value;
 417           }
 418           else {
 419             if ($priviousHousehold == $value) {
 420               $flagHousehold = 1;
 421               $priviousHousehold = $value;
 422             }
 423             else {
 424               $flagHousehold = 0;
 425               $priviousHousehold = $value;
 426             }
 427           }
 428
 429           if ($flagHousehold == 1) {
 430             $rows[$rowNum]['civicrm_contact_household_household_name'] = "";
 431           }
 432           else {
 433             $url = CRM_Utils_System::url('civicrm/contact/view',
 434               'reset=1&cid=' . $rows[$rowNum]['civicrm_contact_household_id'],
 435               $this->_absoluteUrl
 436             );
 437
 438             $rows[$rowNum]['civicrm_contact_household_household_name'] = "<a href='$url' title='" . ts('View contact summary for this househould') . "'>" . $value . '</a>';
 439           }
 440           $entryFound = TRUE;
 441         }
 442       }
 443
 444       //remove duplicate Contact names and relationship type
 445       if (array_key_exists('civicrm_contact_id', $row) && $this->_outputMode != 'csv') {
 446         if ($value = $row['civicrm_contact_id']) {
 447           if ($rowNum == 0) {
 448             $priviousContact = $value;
 449           }
 450           else {
 451             if ($priviousContact == $value) {
 452               $flagContact = 1;
 453               $priviousContact = $value;
 454             }
 455             else {
 456               $flagContact = 0;
 457               $priviousContact = $value;
 458             }
 459           }
 460
 461           if ($flagContact == 1 && $flagHousehold == 1) {
 462             $rows[$rowNum]['civicrm_contact_sort_name'] = "";
 463             $rows[$rowNum]['civicrm_relationship_relationship_type_id'] = "";
 464           }
 465
 466           $entryFound = TRUE;
 467         }
 468       }
 469
 470       if (array_key_exists('civicrm_contribution_contribution_status_id', $row)) {
 471         if ($value = $row['civicrm_contribution_contribution_status_id']) {
 472           $rows[$rowNum]['civicrm_contribution_contribution_status_id'] = CRM_Contribute_PseudoConstant::contributionStatus($value);
 473         }
 474       }
 475
 476       // handle state province
 477       if (array_key_exists('civicrm_address_state_province_id', $row)) {
 478         if ($value = $row['civicrm_address_state_province_id']) {
 479           $rows[$rowNum]['civicrm_address_state_province_id'] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($value, FALSE);
 480         }
 481         $entryFound = TRUE;
 482       }
 483
 484       // handle country
 485       if (array_key_exists('civicrm_address_country_id', $row)) {
 486         if ($value = $row['civicrm_address_country_id']) {
 487           $rows[$rowNum]['civicrm_address_country_id'] = CRM_Core_PseudoConstant::country($value, FALSE);
 488         }
 489         $entryFound = TRUE;
 490       }
 491
 492       // convert display name to links
 493       if (array_key_exists('civicrm_contact_sort_name', $row) &&
 494         $rows[$rowNum]['civicrm_contact_sort_name'] &&
 495         array_key_exists('civicrm_contact_id', $row)
 496       ) {
 497         $url = CRM_Report_Utils_Report::getNextUrl('contribute/detail',
 498           'reset=1&force=1&id_op=eq&id_value=' . $row['civicrm_contact_id'],
 499           $this->_absoluteUrl, $this->_id, $this->_drilldownReport
 500         );
 501         $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
 502         $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts('View contribution details for this individual');
 503
 504         $entryFound = TRUE;
 505       }
 506
 507       if (CRM_Utils_Array::value('civicrm_contribution_total_amount', $row)) {
 508         $row['civicrm_contribution_total_amount'] = CRM_Utils_Money::format($row['civicrm_contribution_total_amount'], $row['civicrm_contribution_currency']);
 509       }
 510
 511       // Contribution amount links to view contribution
 512       if (($value = CRM_Utils_Array::value('civicrm_contribution_total_amount', $row)) &&
 513         CRM_Core_Permission::check('access CiviContribute')
 514       ) {
 515         $url = CRM_Utils_System::url("civicrm/contact/view/contribution",
 516           "reset=1&id=" . $row['civicrm_contribution_id'] . "&cid=" . $row['civicrm_contact_id'] . "&action=view&context=contribution&selectedChild=contribute",
 517           $this->_absoluteUrl
 518         );
 519         $rows[$rowNum]['civicrm_contribution_total_amount_link'] = $url;
 520         $rows[$rowNum]['civicrm_contribution_total_amount_hover'] = ts("View this contribution.");
 521         $entryFound = TRUE;
 522       }
 523
 524       // convert campaign_id to campaign title
 525       if (array_key_exists('civicrm_contribution_campaign_id', $row)) {
 526         if ($value = $row['civicrm_contribution_campaign_id']) {
 527           $rows[$rowNum]['civicrm_contribution_campaign_id'] = $this->activeCampaigns[$value];
 528           $entryFound = TRUE;
 529         }
 530       }
 531
 532       // skip looking further in rows, if first row itself doesn't
 533       if (!$entryFound) {
 534         break;
 535       }
 536       $lastKey = $rowNum;
 537     }
 538   }
 539 }
 540