CRM/Contribute/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  */
  34 class CRM_Contribute_BAO_Query {
  35
  36   /**
  37    * Static field for all the export/import contribution fields.
  38    *
  39    * @var array
  40    */
  41   static $_contributionFields = NULL;
  42
  43   static $_contribOrSoftCredit = "only_contribs";
  44
  45   /**
  46    * Function get the import/export fields for contribution
  47    *
  48    * @return array
  49    *   self::$_contributionFields  associative array of contribution fields
  50    */
  51   public static function &getFields() {
  52     if (!self::$_contributionFields) {
  53       self::$_contributionFields = array();
  54
  55       $fields = CRM_Contribute_BAO_Contribution::exportableFields();
  56
  57       unset($fields['contribution_contact_id']);
  58
  59       self::$_contributionFields = $fields;
  60     }
  61     return self::$_contributionFields;
  62   }
  63
  64   /**
  65    * If contributions are involved, add the specific contribute fields.
  66    *
  67    * @param $query
  68    *
  69    * @return void
  70    */
  71   public static function select(&$query) {
  72     // if contribute mode add contribution id
  73     if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
  74       $query->_select['contribution_id'] = "civicrm_contribution.id as contribution_id";
  75       $query->_element['contribution_id'] = 1;
  76       $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
  77     }
  78
  79     // get financial_type
  80     if (!empty($query->_returnProperties['financial_type'])) {
  81       $query->_select['financial_type'] = "civicrm_financial_type.name as financial_type";
  82       $query->_element['financial_type'] = 1;
  83       $query->_tables['civicrm_contribution'] = 1;
  84       $query->_tables['civicrm_financial_type'] = 1;
  85     }
  86
  87     // get accounting code
  88     if (!empty($query->_returnProperties['accounting_code'])) {
  89       $query->_select['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code";
  90       $query->_element['accounting_code'] = 1;
  91       $query->_tables['civicrm_accounting_code'] = 1;
  92       $query->_tables['civicrm_financial_account'] = 1;
  93     }
  94
  95     if (!empty($query->_returnProperties['contribution_note'])) {
  96       $query->_select['contribution_note'] = "civicrm_note.note as contribution_note";
  97       $query->_element['contribution_note'] = 1;
  98       $query->_tables['contribution_note'] = 1;
  99       $query->_tables['civicrm_contribution'] = 1;
 100     }
 101
 102     if (!empty($query->_returnProperties['contribution_batch'])) {
 103       $query->_select['contribution_batch'] = "civicrm_batch.title as contribution_batch";
 104       $query->_element['contribution_batch'] = 1;
 105       $query->_tables['contribution_batch'] = 1;
 106     }
 107
 108     if (!empty($query->_returnProperties['contribution_source'])) {
 109       $query->_select['contribution_source'] = "civicrm_contribution.source as contribution_source";
 110       $query->_element['contribution_source'] = 1;
 111       $query->_tables['civicrm_contribution'] = 1;
 112     }
 113
 114     // get contribution_status
 115     if (!empty($query->_returnProperties['contribution_status_id'])) {
 116       $query->_select['contribution_status_id'] = "contribution_status.value as contribution_status_id";
 117       $query->_element['contribution_status_id'] = 1;
 118       $query->_tables['civicrm_contribution'] = 1;
 119       $query->_tables['contribution_status'] = 1;
 120     }
 121
 122     // get contribution_status label
 123     if (!empty($query->_returnProperties['contribution_status'])) {
 124       $query->_select['contribution_status'] = "contribution_status.label as contribution_status";
 125       $query->_element['contribution_status'] = 1;
 126       $query->_tables['civicrm_contribution'] = 1;
 127       $query->_tables['contribution_status'] = 1;
 128     }
 129
 130     // get payment instrument
 131     if (!empty($query->_returnProperties['payment_instrument'])) {
 132       $query->_select['payment_instrument'] = "contribution_payment_instrument.label as payment_instrument";
 133       $query->_element['payment_instrument'] = 1;
 134       $query->_tables['civicrm_contribution'] = 1;
 135       $query->_tables['contribution_payment_instrument'] = 1;
 136     }
 137
 138     // get payment instrument id
 139     if (!empty($query->_returnProperties['payment_instrument_id'])) {
 140       $query->_select['instrument_id'] = "contribution_payment_instrument.value as instrument_id";
 141       $query->_select['payment_instrument_id'] = "contribution_payment_instrument.value as payment_instrument_id";
 142       $query->_element['instrument_id'] = $query->_element['payment_instrument_id'] = 1;
 143       $query->_tables['civicrm_contribution'] = 1;
 144       $query->_tables['contribution_payment_instrument'] = 1;
 145     }
 146
 147     if (!empty($query->_returnProperties['check_number'])) {
 148       $query->_select['contribution_check_number'] = "civicrm_contribution.check_number as contribution_check_number";
 149       $query->_element['contribution_check_number'] = 1;
 150       $query->_tables['civicrm_contribution'] = 1;
 151     }
 152
 153     if (!empty($query->_returnProperties['contribution_campaign_id'])) {
 154       $query->_select['contribution_campaign_id'] = 'civicrm_contribution.campaign_id as contribution_campaign_id';
 155       $query->_element['contribution_campaign_id'] = 1;
 156       $query->_tables['civicrm_contribution'] = 1;
 157     }
 158
 159     // LCD 716
 160     if (!empty($query->_returnProperties['contribution_soft_credit_name'])) {
 161       $query->_select['contribution_soft_credit_name'] = "civicrm_contact_d.sort_name as contribution_soft_credit_name";
 162       $query->_element['contribution_soft_credit_name'] = 1;
 163
 164       // also include contact id. Will help build hyperlinks
 165       $query->_select['contribution_soft_credit_contact_id'] = "civicrm_contact_d.id as contribution_soft_credit_contact_id";
 166       $query->_element['contribution_soft_credit_contact_id'] = 1;
 167
 168       $query->_tables['civicrm_contribution'] = 1;
 169       $query->_tables['civicrm_contribution_soft'] = 1;
 170       $query->_tables['civicrm_contribution_soft_contact'] = 1;
 171     }
 172
 173     if (!empty($query->_returnProperties['contribution_soft_credit_contact_id'])) {
 174       $query->_tables['civicrm_contribution'] = 1;
 175       $query->_tables['civicrm_contribution_soft'] = 1;
 176     }
 177
 178     if (!empty($query->_returnProperties['contribution_soft_credit_amount'])) {
 179       $query->_select['contribution_soft_credit_amount'] = "civicrm_contribution_soft.amount as contribution_soft_credit_amount";
 180       $query->_element['contribution_soft_credit_amount'] = 1;
 181       $query->_tables['civicrm_contribution'] = 1;
 182       $query->_tables['civicrm_contribution_soft'] = 1;
 183     }
 184
 185     if (!empty($query->_returnProperties['contribution_soft_credit_type'])) {
 186       $query->_select['contribution_soft_credit_type'] = "contribution_softcredit_type.label as contribution_soft_credit_type";
 187       $query->_element['contribution_soft_credit_type'] = 1;
 188       $query->_tables['civicrm_contribution'] = 1;
 189       $query->_tables['contribution_softcredit_type'] = 1;
 190     }
 191
 192     if (!empty($query->_returnProperties['contribution_soft_credit_contribution_id'])) {
 193       $query->_select['contribution_soft_credit_contribution_id'] = "civicrm_contribution_soft.contribution_id as contribution_soft_credit_contribution_id";
 194       $query->_element['contribution_soft_credit_contribution_id'] = 1;
 195       $query->_tables['civicrm_contribution'] = 1;
 196       $query->_tables['civicrm_contribution_soft'] = 1;
 197     }
 198
 199     if (!empty($query->_returnProperties['contribution_soft_credit_email'])) {
 200       $query->_select['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email";
 201       $query->_element['contribution_soft_credit_email'] = 1;
 202       $query->_tables['civicrm_contribution'] = 1;
 203       $query->_tables['civicrm_contribution_soft'] = 1;
 204       $query->_tables['civicrm_contribution_soft_contact'] = 1;
 205       $query->_tables['civicrm_contribution_soft_email'] = 1;
 206     }
 207
 208     if (!empty($query->_returnProperties['contribution_soft_credit_phone'])) {
 209       $query->_select['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone";
 210       $query->_element['contribution_soft_credit_phone'] = 1;
 211       $query->_tables['civicrm_contribution'] = 1;
 212       $query->_tables['civicrm_contribution_soft'] = 1;
 213       $query->_tables['civicrm_contribution_soft_contact'] = 1;
 214       $query->_tables['civicrm_contribution_soft_phone'] = 1;
 215     }
 216     // LCD 716 END
 217   }
 218
 219   /**
 220    * @param $query
 221    */
 222   public static function where(&$query) {
 223     $grouping = NULL;
 224     self::initializeAnySoftCreditClause($query);
 225     foreach (array_keys($query->_params) as $id) {
 226       if (empty($query->_params[$id][0])) {
 227         continue;
 228       }
 229       if (substr($query->_params[$id][0], 0, 13) == 'contribution_' || substr($query->_params[$id][0], 0, 10) == 'financial_'  || substr($query->_params[$id][0], 0, 8) == 'payment_') {
 230         if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) {
 231           $query->_useDistinct = TRUE;
 232         }
 233         // CRM-12065
 234         if (
 235           $query->_params[$id][0] == 'contribution_type_id' ||
 236           $query->_params[$id][0] == 'contribution_type'
 237         ) {
 238           CRM_Core_Session::setStatus(
 239             ts('The contribution type criteria is now obsolete, please update your smart group'),
 240             '',
 241             'alert'
 242           );
 243           continue;
 244         }
 245
 246         $grouping = $query->_params[$id][3];
 247         self::whereClauseSingle($query->_params[$id], $query);
 248       }
 249     }
 250   }
 251
 252   /**
 253    * @param $values
 254    * @param $query
 255    */
 256   public static function whereClauseSingle(&$values, &$query) {
 257     list($name, $op, $value, $grouping, $wildcard) = $values;
 258
 259     $quoteValue = NULL;
 260     $fields = array_merge(CRM_Contribute_BAO_Contribution::fields(), self::getFields());
 261
 262     if (!empty($value) && !is_array($value)) {
 263       $quoteValue = "\"$value\"";
 264     }
 265
 266     $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
 267     foreach (self::getRecurringFields() as $dateField => $dateFieldTitle) {
 268       if (self::buildDateWhere($values, $query, $name, $dateField, $dateFieldTitle)) {
 269         return;
 270       }
 271     }
 272     switch ($name) {
 273       case 'contribution_date':
 274       case 'contribution_date_low':
 275       case 'contribution_date_low_time':
 276       case 'contribution_date_high':
 277       case 'contribution_date_high_time':
 278         // process to / from date
 279         $query->dateQueryBuilder($values,
 280           'civicrm_contribution', 'contribution_date', 'receive_date', 'Contribution Date'
 281         );
 282         return;
 283
 284       case 'contribution_amount':
 285       case 'contribution_amount_low':
 286       case 'contribution_amount_high':
 287         // process min/max amount
 288         $query->numberRangeBuilder($values,
 289           'civicrm_contribution', 'contribution_amount',
 290           'total_amount', 'Contribution Amount',
 291           NULL
 292         );
 293         return;
 294
 295       case 'contribution_thankyou_date_is_not_null':
 296         if ($value) {
 297           $op = "IS NOT NULL";
 298           $query->_qill[$grouping][] = ts('Contribution Thank-you Sent');
 299         }
 300         else {
 301           $op = "IS NULL";
 302           $query->_qill[$grouping][] = ts('Contribution Thank-you Not Sent');
 303         }
 304         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.thankyou_date", $op);
 305         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 306         return;
 307
 308       case 'contribution_receipt_date_is_not_null':
 309         if ($value) {
 310           $op = "IS NOT NULL";
 311           $query->_qill[$grouping][] = ts('Contribution Receipt Sent');
 312         }
 313         else {
 314           $op = "IS NULL";
 315           $query->_qill[$grouping][] = ts('Contribution Receipt Not Sent');
 316         }
 317         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.receipt_date", $op);
 318         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 319         return;
 320
 321       case 'financial_type_id':
 322       case 'contribution_page_id':
 323       case 'contribution_status_id':
 324       case 'contribution_id':
 325       case 'contribution_currency_type':
 326       case 'contribution_currency':
 327       case 'contribution_source':
 328       case 'contribution_trxn_id':
 329       case 'contribution_check_number':
 330       case (strpos($name, '_amount') !== FALSE):
 331       case (strpos($name, '_date') !== FALSE):
 332         $qillName = $name;
 333         $pseudoExtraParam = NULL;
 334         if ((strpos($name, '_amount') !== FALSE) || (strpos($name, '_date') !== FALSE) || in_array($name,
 335             array(
 336               'contribution_id',
 337               'contribution_currency',
 338               'contribution_source',
 339               'contribution_trxn_id',
 340               'contribution_check_number',
 341             )
 342           )
 343         ) {
 344           $name = str_replace('contribution_', '', $name);
 345           if (!in_array($name, array('source', 'id'))) {
 346             $qillName = str_replace('contribution_', '', $qillName);
 347           }
 348         }
 349         if (in_array($name, array('contribution_currency', 'contribution_currency_type'))) {
 350           $qillName = $name = 'currency';
 351           $pseudoExtraParam = array('labelColumn' => 'name');
 352         }
 353
 354         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 355
 356         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.$name", $op, $value, $dataType);
 357         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op, $pseudoExtraParam);
 358         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
 359         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 360         return;
 361
 362       case 'financial_type':
 363         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fields[$name]['where'], $op, $value, 'String');
 364         CRM_Core_Error::debug('$query', $query->_where[$grouping]);
 365         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
 366         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
 367         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 368         $query->_tables['civicrm_financial_type'] = $query->_whereTables['civicrm_financial_type'] = 1;
 369         return;
 370
 371       case 'contribution_page':
 372         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fields[$name]['where'], $op, $value, 'String');
 373         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
 374         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
 375         $query->_tables['civicrm_contribution_page'] = $query->_whereTables['civicrm_contribution_page'] = 1;
 376         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 377         return;
 378
 379       case 'contribution_payment_instrument':
 380       case 'contribution_payment_instrument_id':
 381         $name = str_replace('contribution_', '', $name);
 382       case 'payment_instrument':
 383       case 'payment_instrument_id':
 384         if ($name == 'payment_instrument') {
 385           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("contribution_payment_instrument.label", $op, $value);
 386         }
 387         else {
 388           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("contribution_payment_instrument.value", $op, $value, 'Int');
 389         }
 390         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', 'payment_instrument_id', $value, $op);
 391         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields['payment_instrument']['title'], 2 => $op, 3 => $value));
 392         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 393         $query->_tables['contribution_payment_instrument'] = $query->_whereTables['contribution_payment_instrument'] = 1;
 394         return;
 395
 396       case 'contribution_status':
 397         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$name.label", $op, $value, 'String');
 398         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
 399         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
 400         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 401         $query->_tables[$name] = $query->_whereTables[$name] = 1;
 402         break;
 403
 404       case 'contribution_pcp_made_through_id':
 405       case 'contribution_soft_credit_type_id':
 406         $qillName = $name;
 407         if ($name == 'contribution_pcp_made_through_id') {
 408           $qillName = $name = 'pcp_id';
 409           $fields[$name] = array('title' => ts('Personal Campaign Page'), 'type' => 2);
 410         }
 411         if ($name == 'contribution_soft_credit_type_id') {
 412           $qillName = str_replace('_id', '', $qillName);
 413           $fields[$qillName]['type'] = $fields[$qillName]['data_type'];
 414           $name = str_replace('contribution_', '', $name);
 415         }
 416         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_soft.$name",
 417           $op, $value, CRM_Utils_Type::typeToString($fields[$qillName]['type'])
 418         );
 419         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op);
 420         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
 421         $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 422         return;
 423
 424       case 'contribution_or_softcredits':
 425         if ($value == 'only_scredits') {
 426           $query->_where[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL";
 427           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only');
 428           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 429           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 430         }
 431         elseif ($value == 'both_related') {
 432           $query->_where[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL";
 433           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits with related Hard Credit');
 434           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 435           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 436         }
 437         elseif ($value == 'both') {
 438           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Both');
 439           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 440           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 441         }
 442         // default option: $value == 'only_contribs'
 443         return;
 444
 445       case 'contribution_is_test':
 446         // By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution
 447         // so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause
 448         $key = array_search('civicrm_contribution.is_test = 0', $query->_where[$grouping]);
 449         if (!empty($key)) {
 450           unset($query->_where[$grouping][$key]);
 451         }
 452       case 'contribution_test':
 453         // We dont want to include all tests for sql OR CRM-7827
 454         if (!$value || $query->getOperator() != 'OR') {
 455           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
 456           if ($value) {
 457             $query->_qill[$grouping][] = ts("Only Display Test Contributions");
 458           }
 459           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 460         }
 461         return;
 462
 463       case 'contribution_is_pay_later':
 464       case 'contribution_pay_later':
 465         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
 466         if ($value) {
 467           $query->_qill[$grouping][] = ts("Find Pay Later Contributions");
 468         }
 469         else {
 470           $query->_qill[$grouping][] = ts("Exclude Pay Later Contributions");
 471         }
 472         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 473         return;
 474
 475       case 'contribution_recurring':
 476         if ($value) {
 477           $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
 478           $query->_qill[$grouping][] = ts("Find Recurring Contributions");
 479           $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
 480         }
 481         else {
 482           $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
 483           $query->_qill[$grouping][] = ts("Exclude Recurring Contributions");
 484         }
 485         return;
 486
 487       case 'contribution_recur_id':
 488         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.contribution_recur_id",
 489           $op, $value, "Integer"
 490         );
 491         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 492         return;
 493
 494       case 'contribution_note':
 495         $value = $strtolower(CRM_Core_DAO::escapeString($value));
 496         if ($wildcard) {
 497           $value = "%$value%";
 498           $op = 'LIKE';
 499         }
 500         $wc = ($op != 'LIKE') ? "LOWER(civicrm_note.note)" : "civicrm_note.note";
 501         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($wc, $op, $value, "String");
 502         $query->_qill[$grouping][] = ts('Contribution Note %1 %2', array(1 => $op, 2 => $quoteValue));
 503         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = $query->_whereTables['contribution_note'] = 1;
 504         return;
 505
 506       case 'contribution_membership_id':
 507         $query->_where[$grouping][] = " civicrm_membership.id $op $value";
 508         $query->_tables['contribution_membership'] = $query->_whereTables['contribution_membership'] = 1;
 509
 510         return;
 511
 512       case 'contribution_participant_id':
 513         $query->_where[$grouping][] = " civicrm_participant.id $op $value";
 514         $query->_tables['contribution_participant'] = $query->_whereTables['contribution_participant'] = 1;
 515         return;
 516
 517       case 'contribution_pcp_display_in_roll':
 518         $query->_where[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
 519         if ($value) {
 520           $query->_qill[$grouping][] = ts("Personal Campaign Page Honor Roll");
 521         }
 522         else {
 523           $query->_qill[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
 524         }
 525         $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 526         return;
 527
 528       case 'contribution_campaign_id':
 529         $campParams = array(
 530           'op' => $op,
 531           'campaign' => $value,
 532           'grouping' => $grouping,
 533           'tableName' => 'civicrm_contribution',
 534         );
 535         CRM_Campaign_BAO_Query::componentSearchClause($campParams, $query);
 536         return;
 537
 538       case 'contribution_batch_id':
 539         $batches = CRM_Contribute_PseudoConstant::batch();
 540         $query->_where[$grouping][] = " civicrm_entity_batch.batch_id $op $value";
 541         $query->_qill[$grouping][] = ts('Batch Name %1 %2', array(1 => $op, 2 => $batches[$value]));
 542         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 543         $query->_tables['contribution_batch'] = $query->_whereTables['contribution_batch'] = 1;
 544         return;
 545
 546       default:
 547         //all other elements are handle in this case
 548         $fldName = substr($name, 13);
 549         if (!isset($fields[$fldName])) {
 550           // CRM-12597
 551           CRM_Core_Session::setStatus(ts(
 552               'We did not recognize the search field: %1. Please check and fix your contribution related smart groups.',
 553               array(1 => $fldName)
 554             )
 555           );
 556           return;
 557         }
 558         $whereTable = $fields[$fldName];
 559         $value = trim($value);
 560
 561         $dataType = "String";
 562         if (!empty($whereTable['type'])) {
 563           $dataType = CRM_Utils_Type::typeToString($whereTable['type']);
 564         }
 565
 566         $wc = ($op != 'LIKE' && $dataType != 'Date') ? "LOWER($whereTable[where])" : "$whereTable[where]";
 567         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($wc, $op, $value, $dataType);
 568         $query->_qill[$grouping][] = "$whereTable[title] $op $quoteValue";
 569         list($tableName, $fieldName) = explode('.', $whereTable['where'], 2);
 570         $query->_tables[$tableName] = $query->_whereTables[$tableName] = 1;
 571         if ($tableName == 'civicrm_contribution_product') {
 572           $query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1;
 573           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 574         }
 575         else {
 576           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 577         }
 578     }
 579   }
 580
 581   /**
 582    * @param string $name
 583    * @param $mode
 584    * @param $side
 585    *
 586    * @return NULL|string
 587    */
 588   public static function from($name, $mode, $side) {
 589     $from = NULL;
 590     switch ($name) {
 591       case 'civicrm_contribution':
 592         $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
 593         if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
 594           // switch the from table if its only soft credit search
 595           $from = " $side JOIN contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id ";
 596           $from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id ";
 597           $from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id";
 598         }
 599         break;
 600
 601       case 'civicrm_contribution_recur':
 602         if ($mode == 1) {
 603           // in contact mode join directly onto profile - in case no contributions exist yet
 604           $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
 605         }
 606         else {
 607           $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
 608         }
 609         break;
 610
 611       case 'civicrm_financial_type':
 612         if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 613           $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
 614         }
 615         else {
 616           $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
 617         }
 618         break;
 619
 620       case 'civicrm_financial_account':
 621         if ($mode & CRM_Contact_BAO_Query::MODE_CONTACTS) {
 622           $from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id ";
 623         }
 624         break;
 625
 626       case 'civicrm_accounting_code':
 627         if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 628           $from = " $side JOIN civicrm_entity_financial_account ON civicrm_entity_financial_account.entity_id = civicrm_contribution.financial_type_id AND civicrm_entity_financial_account.entity_table = 'civicrm_financial_type' ";
 629           $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
 630           $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
 631           $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
 632         }
 633         break;
 634
 635       case 'civicrm_contribution_page':
 636         $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id";
 637         break;
 638
 639       case 'civicrm_product':
 640         $from = " $side  JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
 641         $from .= " $side  JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
 642         break;
 643
 644       case 'contribution_payment_instrument':
 645         $from = " $side JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')";
 646         $from .= " $side JOIN civicrm_option_value contribution_payment_instrument ON (civicrm_contribution.payment_instrument_id = contribution_payment_instrument.value
 647                                AND option_group_payment_instrument.id = contribution_payment_instrument.option_group_id ) ";
 648         break;
 649
 650       case 'contribution_status':
 651         $from = " $side JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')";
 652         $from .= " $side JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
 653                                AND option_group_contribution_status.id = contribution_status.option_group_id ) ";
 654         break;
 655
 656       case 'contribution_softcredit_type':
 657         $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON
 658           (option_group_contribution_softcredit_type.name = 'soft_credit_type')";
 659         $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON
 660           ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value
 661           AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )";
 662         break;
 663
 664       case 'contribution_note':
 665         $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
 666                                                     civicrm_contribution.id = civicrm_note.entity_id )";
 667         break;
 668
 669       case 'contribution_membership':
 670         $from = " $side  JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
 671         $from .= " $side  JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
 672         break;
 673
 674       case 'contribution_participant':
 675         $from = " $side  JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
 676         $from .= " $side  JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
 677         break;
 678
 679       case 'civicrm_contribution_soft':
 680         if (!in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
 681           $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
 682         }
 683         break;
 684
 685       case 'civicrm_contribution_soft_contact':
 686         if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
 687           $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id )
 688             AND contribution_search_scredit_combined.scredit_id IS NOT NULL";
 689         }
 690         else {
 691           $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
 692         }
 693         break;
 694
 695       case 'civicrm_contribution_soft_email':
 696         $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
 697         break;
 698
 699       case 'civicrm_contribution_soft_phone':
 700         $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
 701         break;
 702
 703       case 'contribution_batch':
 704         $from .= " $side JOIN civicrm_entity_financial_trxn ON (
 705         civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
 706         AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
 707
 708         $from .= " $side JOIN civicrm_financial_trxn ON (
 709         civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
 710
 711         $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
 712         AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
 713
 714         $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
 715         break;
 716     }
 717     return $from;
 718   }
 719
 720   /**
 721    * @param $query
 722    */
 723   public static function initializeAnySoftCreditClause(&$query) {
 724     if (self::isSoftCreditOptionEnabled($query->_params)) {
 725       if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 726         unset($query->_distinctComponentClause);
 727         $query->_rowCountClause = " count(civicrm_contribution.id)";
 728         $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
 729       }
 730     }
 731   }
 732
 733   /**
 734    * @param array $queryParams
 735    *
 736    * @return bool
 737    */
 738   public static function isSoftCreditOptionEnabled($queryParams = array()) {
 739     static $tempTableFilled = FALSE;
 740     if (!empty($queryParams)) {
 741       foreach (array_keys($queryParams) as $id) {
 742         if (empty($queryParams[$id][0])) {
 743           continue;
 744         }
 745         if ($queryParams[$id][0] == 'contribution_or_softcredits') {
 746           self::$_contribOrSoftCredit = $queryParams[$id][2];
 747         }
 748       }
 749     }
 750     if (in_array(self::$_contribOrSoftCredit,
 751       array("only_scredits", "both_related", "both"))) {
 752       if (!$tempTableFilled) {
 753         // build a temp table which is union of contributions and soft credits
 754         // note: group-by in first part ensures uniqueness in counts
 755         $tempQuery = "
 756             CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS
 757                SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id
 758                  FROM civicrm_contribution con
 759             LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id
 760              GROUP BY id, contact_id, scredit_id
 761             UNION ALL
 762                SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id
 763                  FROM civicrm_contribution_soft as scredit";
 764         CRM_Core_DAO::executeQuery($tempQuery);
 765         $tempTableFilled = TRUE;
 766       }
 767       return TRUE;
 768     }
 769     return FALSE;
 770   }
 771
 772   /**
 773    * @param bool $isExportMode
 774    *
 775    * @return array
 776    */
 777   public static function softCreditReturnProperties($isExportMode = FALSE) {
 778     $properties = array(
 779       'contribution_soft_credit_name' => 1,
 780       'contribution_soft_credit_amount' => 1,
 781       'contribution_soft_credit_type' => 1,
 782     );
 783     if ($isExportMode) {
 784       $properties['contribution_soft_credit_contribution_id'] = 1;
 785     }
 786     return $properties;
 787   }
 788
 789   /**
 790    * @param $mode
 791    * @param bool $includeCustomFields
 792    *
 793    * @return array|NULL
 794    */
 795   public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
 796     $properties = NULL;
 797     if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 798       $properties = array(
 799         'contact_type' => 1,
 800         'contact_sub_type' => 1,
 801         'sort_name' => 1,
 802         'display_name' => 1,
 803         'financial_type' => 1,
 804         'contribution_source' => 1,
 805         'receive_date' => 1,
 806         'thankyou_date' => 1,
 807         'cancel_date' => 1,
 808         'total_amount' => 1,
 809         'accounting_code' => 1,
 810         'payment_instrument' => 1,
 811         'payment_instrument_id' => 1,
 812         'check_number' => 1,
 813         'non_deductible_amount' => 1,
 814         'fee_amount' => 1,
 815         'net_amount' => 1,
 816         'trxn_id' => 1,
 817         'invoice_id' => 1,
 818         'currency' => 1,
 819         'cancel_reason' => 1,
 820         'receipt_date' => 1,
 821         'product_name' => 1,
 822         'sku' => 1,
 823         'product_option' => 1,
 824         'fulfilled_date' => 1,
 825         'contribution_start_date' => 1,
 826         'contribution_end_date' => 1,
 827         'is_test' => 1,
 828         'is_pay_later' => 1,
 829         'contribution_status' => 1,
 830         'contribution_status_id' => 1,
 831         'contribution_recur_id' => 1,
 832         'amount_level' => 1,
 833         'contribution_note' => 1,
 834         'contribution_batch' => 1,
 835         'contribution_campaign_id' => 1,
 836       );
 837       if (self::isSoftCreditOptionEnabled()) {
 838         $properties = array_merge($properties, self::softCreditReturnProperties());
 839       }
 840       if ($includeCustomFields) {
 841         // also get all the custom contribution properties
 842         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Contribution');
 843         if (!empty($fields)) {
 844           foreach ($fields as $name => $dontCare) {
 845             $properties[$name] = 1;
 846           }
 847         }
 848       }
 849     }
 850     return $properties;
 851   }
 852
 853   /**
 854    * Add all the elements shared between contribute search and advnaced search.
 855    *
 856    *
 857    * @param CRM_Core_Form $form
 858    *
 859    * @return void
 860    */
 861   public static function buildSearchForm(&$form) {
 862
 863     // Added contribution source
 864     $form->addElement('text', 'contribution_source', ts('Contribution Source'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'source'));
 865
 866     CRM_Core_Form_Date::buildDateRange($form, 'contribution_date', 1, '_low', '_high', ts('From:'), FALSE);
 867
 868     $form->add('text', 'contribution_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
 869     $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('9.99', ' '))), 'money');
 870
 871     $form->add('text', 'contribution_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
 872     $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('99.99', ' '))), 'money');
 873
 874     // Adding select option for curreny type -- CRM-4711
 875     $form->add('select', 'contribution_currency_type',
 876       ts('Currency Type'),
 877       array(
 878         '' => ts('- any -'),
 879       ) +
 880       CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name')),
 881       FALSE, array('class' => 'crm-select2')
 882     );
 883
 884     // CRM-13848
 885     $form->addSelect('financial_type_id',
 886       array('entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search')
 887     );
 888
 889     $form->add('select', 'contribution_page_id',
 890       ts('Contribution Page'),
 891       array(
 892         '' => ts('- any -'),
 893       ) +
 894       CRM_Contribute_PseudoConstant::contributionPage(),
 895       FALSE, array('class' => 'crm-select2')
 896     );
 897
 898     $form->addSelect('payment_instrument_id',
 899       array('entity' => 'contribution', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
 900     );
 901
 902     $form->add('select', 'contribution_pcp_made_through_id',
 903       ts('Personal Campaign Page'),
 904       array(
 905         '' => ts('- any -'),
 906       ) +
 907       CRM_Contribute_PseudoConstant::pcPage(),
 908       FALSE, array('class' => 'crm-select2')
 909     );
 910
 911     $status = array();
 912
 913     $statusValues = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status');
 914     // Remove status values that are only used for recurring contributions or pledges (In Progress, Overdue).
 915     unset($statusValues['5'], $statusValues['6']);
 916
 917     $form->addSelect('contribution_status_id',
 918       array('entity' => 'contribution', 'multiple' => 'multiple', 'label' => ts('Contribution Status(s)'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
 919     );
 920
 921     // Add fields for thank you and receipt
 922     $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE);
 923     $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE);
 924
 925     $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE);
 926     $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE);
 927
 928     // Recurring contribution fields
 929     foreach (self::getRecurringFields() as $key => $label) {
 930       CRM_Core_Form_Date::buildDateRange($form, $key, 1, '_low', '_high');
 931       // If data has been entered for a recurring field, tell the tpl layer to open the pane
 932       if (!empty($form->_formValues[$key . '_relative']) || !empty($form->_formValues[$key . '_low']) || !empty($form->_formValues[$key . '_high'])) {
 933         $form->assign('contribution_recur_pane_open', TRUE);
 934       }
 935     }
 936
 937     $form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE);
 938
 939     // Add field for transaction ID search
 940     $form->addElement('text', 'contribution_trxn_id', ts("Transaction ID"));
 941
 942     $form->addElement('text', 'contribution_check_number', ts('Check Number'));
 943
 944     // Add field for pcp display in roll search
 945     $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE);
 946
 947     // Soft credit related fields
 948     $options = array(
 949       'only_contribs' => ts('Contributions Only'),
 950       'only_scredits' => ts('Soft Credits Only'),
 951       'both_related' => ts('Soft Credits with related Hard Credit'),
 952       'both' => ts('Both'),
 953     );
 954     $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, array('class' => "crm-select2"));
 955     $form->addSelect(
 956       'contribution_soft_credit_type_id',
 957       array(
 958         'entity' => 'contribution_soft',
 959         'field' => 'soft_credit_type_id',
 960         'multiple' => TRUE,
 961         'context' => 'search',
 962       )
 963     );
 964
 965     // Add all the custom searchable fields
 966     $contribution = array('Contribution');
 967     $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $contribution);
 968     if ($groupDetails) {
 969       $form->assign('contributeGroupTree', $groupDetails);
 970       foreach ($groupDetails as $group) {
 971         foreach ($group['fields'] as $field) {
 972           $fieldId = $field['id'];
 973           $elementName = 'custom_' . $fieldId;
 974           CRM_Core_BAO_CustomField::addQuickFormElement($form,
 975             $elementName,
 976             $fieldId,
 977             FALSE, FALSE, TRUE
 978           );
 979         }
 980       }
 981     }
 982
 983     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'contribution_campaign_id');
 984
 985     // Add batch select
 986     $batches = CRM_Contribute_PseudoConstant::batch();
 987
 988     if (!empty($batches)) {
 989       $form->add('select', 'contribution_batch_id',
 990         ts('Batch Name'),
 991         array('' => ts('- any -')) + $batches,
 992         FALSE, array('class' => 'crm-select2')
 993       );
 994     }
 995
 996     $form->assign('validCiviContribute', TRUE);
 997     $form->setDefaults(array('contribution_test' => 0));
 998   }
 999
1000   /**
1001    * @param $row
1002    * @param int $id
1003    */
1004   public static function searchAction(&$row, $id) {
1005   }
1006
1007   /**
1008    * @param $tables
1009    */
1010   public static function tableNames(&$tables) {
1011     // Add contribution table
1012     if (!empty($tables['civicrm_product'])) {
1013       $tables = array_merge(array('civicrm_contribution' => 1), $tables);
1014     }
1015
1016     if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) {
1017       $tables['civicrm_product'] = 1;
1018     }
1019   }
1020
1021   /**
1022    * Add the where for dates.
1023    *
1024    * @param array $values
1025    *   Array of query values.
1026    * @param object $query
1027    *   The query object.
1028    * @param string $name
1029    *   Query field that is set.
1030    * @param string $field
1031    *   Name of field to be set.
1032    * @param string $title
1033    *   Title of the field.
1034    *
1035    * @return bool
1036    */
1037   public static function buildDateWhere(&$values, $query, $name, $field, $title) {
1038     $fieldPart = strpos($name, $field);
1039     if ($fieldPart === FALSE) {
1040       return NULL;
1041     }
1042     // we only have recurring dates using this ATM so lets' short cut to find the table name
1043     $table = 'contribution_recur';
1044     $fieldName = explode($table . '_', $field);
1045     $query->dateQueryBuilder($values,
1046       'civicrm_' . $table, $field, $fieldName[1], $title
1047     );
1048     return TRUE;
1049   }
1050
1051   /**
1052    * @return array
1053    */
1054   public static function getRecurringFields() {
1055     return array(
1056       'contribution_recur_start_date' => ts('Recurring Contribution Start Date'),
1057       'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'),
1058       'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'),
1059       'contribution_recur_end_date' => ts('Recurring Contribution End Date'),
1060       'contribution_recur_create_date' => ('Recurring Contribution Create Date'),
1061       'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'),
1062       'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'),
1063     );
1064   }
1065
1066 }