CRM/Contribute/BAO/Query.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 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         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
 365         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
 366         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 367         $query->_tables['civicrm_financial_type'] = $query->_whereTables['civicrm_financial_type'] = 1;
 368         return;
 369
 370       case 'contribution_page':
 371         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($fields[$name]['where'], $op, $value, 'String');
 372         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
 373         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
 374         $query->_tables['civicrm_contribution_page'] = $query->_whereTables['civicrm_contribution_page'] = 1;
 375         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 376         return;
 377
 378       case 'contribution_payment_instrument':
 379       case 'contribution_payment_instrument_id':
 380         $name = str_replace('contribution_', '', $name);
 381       case 'payment_instrument':
 382       case 'payment_instrument_id':
 383         if ($name == 'payment_instrument') {
 384           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("contribution_payment_instrument.label", $op, $value);
 385         }
 386         else {
 387           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("contribution_payment_instrument.value", $op, $value, 'Int');
 388         }
 389         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', 'payment_instrument_id', $value, $op);
 390         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields['payment_instrument']['title'], 2 => $op, 3 => $value));
 391         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 392         $query->_tables['contribution_payment_instrument'] = $query->_whereTables['contribution_payment_instrument'] = 1;
 393         return;
 394
 395       case 'contribution_status':
 396         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$name.label", $op, $value, 'String');
 397         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op);
 398         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$name]['title'], 2 => $op, 3 => $value));
 399         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 400         $query->_tables[$name] = $query->_whereTables[$name] = 1;
 401         break;
 402
 403       case 'contribution_pcp_made_through_id':
 404       case 'contribution_soft_credit_type_id':
 405         $qillName = $name;
 406         if ($name == 'contribution_pcp_made_through_id') {
 407           $qillName = $name = 'pcp_id';
 408           $fields[$name] = array('title' => ts('Personal Campaign Page'), 'type' => 2);
 409         }
 410         if ($name == 'contribution_soft_credit_type_id') {
 411           $qillName = str_replace('_id', '', $qillName);
 412           $fields[$qillName]['type'] = $fields[$qillName]['data_type'];
 413           $name = str_replace('contribution_', '', $name);
 414         }
 415         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_soft.$name",
 416           $op, $value, CRM_Utils_Type::typeToString($fields[$qillName]['type'])
 417         );
 418         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op);
 419         $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
 420         $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 421         return;
 422
 423       case 'contribution_or_softcredits':
 424         if ($value == 'only_scredits') {
 425           $query->_where[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL";
 426           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only');
 427           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 428           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 429         }
 430         elseif ($value == 'both_related') {
 431           $query->_where[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL";
 432           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits with related Hard Credit');
 433           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 434           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 435         }
 436         elseif ($value == 'both') {
 437           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Both');
 438           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 439           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 440         }
 441         // default option: $value == 'only_contribs'
 442         return;
 443
 444       case 'contribution_is_test':
 445         // By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution
 446         // so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause
 447         $key = array_search('civicrm_contribution.is_test = 0', $query->_where[$grouping]);
 448         if (!empty($key)) {
 449           unset($query->_where[$grouping][$key]);
 450         }
 451       case 'contribution_test':
 452         // We dont want to include all tests for sql OR CRM-7827
 453         if (!$value || $query->getOperator() != 'OR') {
 454           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
 455           if ($value) {
 456             $query->_qill[$grouping][] = ts("Only Display Test Contributions");
 457           }
 458           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 459         }
 460         return;
 461
 462       case 'contribution_is_pay_later':
 463       case 'contribution_pay_later':
 464         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
 465         if ($value) {
 466           $query->_qill[$grouping][] = ts("Find Pay Later Contributions");
 467         }
 468         else {
 469           $query->_qill[$grouping][] = ts("Exclude Pay Later Contributions");
 470         }
 471         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 472         return;
 473
 474       case 'contribution_recurring':
 475         if ($value) {
 476           $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
 477           $query->_qill[$grouping][] = ts("Find Recurring Contributions");
 478           $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
 479         }
 480         else {
 481           $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
 482           $query->_qill[$grouping][] = ts("Exclude Recurring Contributions");
 483         }
 484         return;
 485
 486       case 'contribution_recur_id':
 487         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.contribution_recur_id",
 488           $op, $value, "Integer"
 489         );
 490         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 491         return;
 492
 493       case 'contribution_note':
 494         $value = $strtolower(CRM_Core_DAO::escapeString($value));
 495         if ($wildcard) {
 496           $value = "%$value%";
 497           $op = 'LIKE';
 498         }
 499         $wc = ($op != 'LIKE') ? "LOWER(civicrm_note.note)" : "civicrm_note.note";
 500         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($wc, $op, $value, "String");
 501         $query->_qill[$grouping][] = ts('Contribution Note %1 %2', array(1 => $op, 2 => $quoteValue));
 502         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = $query->_whereTables['contribution_note'] = 1;
 503         return;
 504
 505       case 'contribution_membership_id':
 506         $query->_where[$grouping][] = " civicrm_membership.id $op $value";
 507         $query->_tables['contribution_membership'] = $query->_whereTables['contribution_membership'] = 1;
 508
 509         return;
 510
 511       case 'contribution_participant_id':
 512         $query->_where[$grouping][] = " civicrm_participant.id $op $value";
 513         $query->_tables['contribution_participant'] = $query->_whereTables['contribution_participant'] = 1;
 514         return;
 515
 516       case 'contribution_pcp_display_in_roll':
 517         $query->_where[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
 518         if ($value) {
 519           $query->_qill[$grouping][] = ts("Personal Campaign Page Honor Roll");
 520         }
 521         else {
 522           $query->_qill[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
 523         }
 524         $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 525         return;
 526
 527       case 'contribution_campaign_id':
 528         $campParams = array(
 529           'op' => $op,
 530           'campaign' => $value,
 531           'grouping' => $grouping,
 532           'tableName' => 'civicrm_contribution',
 533         );
 534         CRM_Campaign_BAO_Query::componentSearchClause($campParams, $query);
 535         return;
 536
 537       case 'contribution_batch_id':
 538         $batches = CRM_Contribute_PseudoConstant::batch();
 539         $query->_where[$grouping][] = " civicrm_entity_batch.batch_id $op $value";
 540         $query->_qill[$grouping][] = ts('Batch Name %1 %2', array(1 => $op, 2 => $batches[$value]));
 541         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 542         $query->_tables['contribution_batch'] = $query->_whereTables['contribution_batch'] = 1;
 543         return;
 544
 545       default:
 546         //all other elements are handle in this case
 547         $fldName = substr($name, 13);
 548         if (!isset($fields[$fldName])) {
 549           // CRM-12597
 550           CRM_Core_Session::setStatus(ts(
 551               'We did not recognize the search field: %1. Please check and fix your contribution related smart groups.',
 552               array(1 => $fldName)
 553             )
 554           );
 555           return;
 556         }
 557         $whereTable = $fields[$fldName];
 558         $value = trim($value);
 559
 560         $dataType = "String";
 561         if (!empty($whereTable['type'])) {
 562           $dataType = CRM_Utils_Type::typeToString($whereTable['type']);
 563         }
 564
 565         $wc = ($op != 'LIKE' && $dataType != 'Date') ? "LOWER($whereTable[where])" : "$whereTable[where]";
 566         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($wc, $op, $value, $dataType);
 567         $query->_qill[$grouping][] = "$whereTable[title] $op $quoteValue";
 568         list($tableName, $fieldName) = explode('.', $whereTable['where'], 2);
 569         $query->_tables[$tableName] = $query->_whereTables[$tableName] = 1;
 570         if ($tableName == 'civicrm_contribution_product') {
 571           $query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1;
 572           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 573         }
 574         else {
 575           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 576         }
 577     }
 578   }
 579
 580   /**
 581    * @param string $name
 582    * @param $mode
 583    * @param $side
 584    *
 585    * @return NULL|string
 586    */
 587   public static function from($name, $mode, $side) {
 588     $from = NULL;
 589     switch ($name) {
 590       case 'civicrm_contribution':
 591         $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
 592         if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
 593           // switch the from table if its only soft credit search
 594           $from = " $side JOIN contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id ";
 595           $from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id ";
 596           $from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id";
 597         }
 598         break;
 599
 600       case 'civicrm_contribution_recur':
 601         if ($mode == 1) {
 602           // in contact mode join directly onto profile - in case no contributions exist yet
 603           $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
 604         }
 605         else {
 606           $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
 607         }
 608         break;
 609
 610       case 'civicrm_financial_type':
 611         if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 612           $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
 613         }
 614         else {
 615           $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
 616         }
 617         break;
 618
 619       case 'civicrm_financial_account':
 620         if ($mode & CRM_Contact_BAO_Query::MODE_CONTACTS) {
 621           $from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id ";
 622         }
 623         break;
 624
 625       case 'civicrm_accounting_code':
 626         if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 627           $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' ";
 628           $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
 629           $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
 630           $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
 631         }
 632         break;
 633
 634       case 'civicrm_contribution_page':
 635         $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id";
 636         break;
 637
 638       case 'civicrm_product':
 639         $from = " $side  JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
 640         $from .= " $side  JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
 641         break;
 642
 643       case 'contribution_payment_instrument':
 644         $from = " $side JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')";
 645         $from .= " $side JOIN civicrm_option_value contribution_payment_instrument ON (civicrm_contribution.payment_instrument_id = contribution_payment_instrument.value
 646                                AND option_group_payment_instrument.id = contribution_payment_instrument.option_group_id ) ";
 647         break;
 648
 649       case 'contribution_status':
 650         $from = " $side JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')";
 651         $from .= " $side JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
 652                                AND option_group_contribution_status.id = contribution_status.option_group_id ) ";
 653         break;
 654
 655       case 'contribution_softcredit_type':
 656         $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON
 657           (option_group_contribution_softcredit_type.name = 'soft_credit_type')";
 658         $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON
 659           ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value
 660           AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )";
 661         break;
 662
 663       case 'contribution_note':
 664         $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
 665                                                     civicrm_contribution.id = civicrm_note.entity_id )";
 666         break;
 667
 668       case 'contribution_membership':
 669         $from = " $side  JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
 670         $from .= " $side  JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
 671         break;
 672
 673       case 'contribution_participant':
 674         $from = " $side  JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
 675         $from .= " $side  JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
 676         break;
 677
 678       case 'civicrm_contribution_soft':
 679         if (!in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
 680           $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
 681         }
 682         break;
 683
 684       case 'civicrm_contribution_soft_contact':
 685         if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
 686           $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id )
 687             AND contribution_search_scredit_combined.scredit_id IS NOT NULL";
 688         }
 689         else {
 690           $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
 691         }
 692         break;
 693
 694       case 'civicrm_contribution_soft_email':
 695         $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
 696         break;
 697
 698       case 'civicrm_contribution_soft_phone':
 699         $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
 700         break;
 701
 702       case 'contribution_batch':
 703         $from .= " $side JOIN civicrm_entity_financial_trxn ON (
 704         civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
 705         AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
 706
 707         $from .= " $side JOIN civicrm_financial_trxn ON (
 708         civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
 709
 710         $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
 711         AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
 712
 713         $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
 714         break;
 715     }
 716     return $from;
 717   }
 718
 719   /**
 720    * @param $query
 721    */
 722   public static function initializeAnySoftCreditClause(&$query) {
 723     if (self::isSoftCreditOptionEnabled($query->_params)) {
 724       if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 725         unset($query->_distinctComponentClause);
 726         $query->_rowCountClause = " count(civicrm_contribution.id)";
 727         $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
 728       }
 729     }
 730   }
 731
 732   /**
 733    * @param array $queryParams
 734    *
 735    * @return bool
 736    */
 737   public static function isSoftCreditOptionEnabled($queryParams = array()) {
 738     static $tempTableFilled = FALSE;
 739     if (!empty($queryParams)) {
 740       foreach (array_keys($queryParams) as $id) {
 741         if (empty($queryParams[$id][0])) {
 742           continue;
 743         }
 744         if ($queryParams[$id][0] == 'contribution_or_softcredits') {
 745           self::$_contribOrSoftCredit = $queryParams[$id][2];
 746         }
 747       }
 748     }
 749     if (in_array(self::$_contribOrSoftCredit,
 750       array("only_scredits", "both_related", "both"))) {
 751       if (!$tempTableFilled) {
 752         // build a temp table which is union of contributions and soft credits
 753         // note: group-by in first part ensures uniqueness in counts
 754         $tempQuery = "
 755             CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS
 756                SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id
 757                  FROM civicrm_contribution con
 758             LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id
 759              GROUP BY id, contact_id, scredit_id
 760             UNION ALL
 761                SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id
 762                  FROM civicrm_contribution_soft as scredit";
 763         CRM_Core_DAO::executeQuery($tempQuery);
 764         $tempTableFilled = TRUE;
 765       }
 766       return TRUE;
 767     }
 768     return FALSE;
 769   }
 770
 771   /**
 772    * @param bool $isExportMode
 773    *
 774    * @return array
 775    */
 776   public static function softCreditReturnProperties($isExportMode = FALSE) {
 777     $properties = array(
 778       'contribution_soft_credit_name' => 1,
 779       'contribution_soft_credit_amount' => 1,
 780       'contribution_soft_credit_type' => 1,
 781     );
 782     if ($isExportMode) {
 783       $properties['contribution_soft_credit_contribution_id'] = 1;
 784     }
 785     return $properties;
 786   }
 787
 788   /**
 789    * @param $mode
 790    * @param bool $includeCustomFields
 791    *
 792    * @return array|NULL
 793    */
 794   public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
 795     $properties = NULL;
 796     if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 797       $properties = array(
 798         'contact_type' => 1,
 799         'contact_sub_type' => 1,
 800         'sort_name' => 1,
 801         'display_name' => 1,
 802         'financial_type' => 1,
 803         'contribution_source' => 1,
 804         'receive_date' => 1,
 805         'thankyou_date' => 1,
 806         'cancel_date' => 1,
 807         'total_amount' => 1,
 808         'accounting_code' => 1,
 809         'payment_instrument' => 1,
 810         'payment_instrument_id' => 1,
 811         'check_number' => 1,
 812         'non_deductible_amount' => 1,
 813         'fee_amount' => 1,
 814         'net_amount' => 1,
 815         'trxn_id' => 1,
 816         'invoice_id' => 1,
 817         'currency' => 1,
 818         'cancel_reason' => 1,
 819         'receipt_date' => 1,
 820         'product_name' => 1,
 821         'sku' => 1,
 822         'product_option' => 1,
 823         'fulfilled_date' => 1,
 824         'contribution_start_date' => 1,
 825         'contribution_end_date' => 1,
 826         'is_test' => 1,
 827         'is_pay_later' => 1,
 828         'contribution_status' => 1,
 829         'contribution_status_id' => 1,
 830         'contribution_recur_id' => 1,
 831         'amount_level' => 1,
 832         'contribution_note' => 1,
 833         'contribution_batch' => 1,
 834         'contribution_campaign_id' => 1,
 835       );
 836       if (self::isSoftCreditOptionEnabled()) {
 837         $properties = array_merge($properties, self::softCreditReturnProperties());
 838       }
 839       if ($includeCustomFields) {
 840         // also get all the custom contribution properties
 841         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Contribution');
 842         if (!empty($fields)) {
 843           foreach ($fields as $name => $dontCare) {
 844             $properties[$name] = 1;
 845           }
 846         }
 847       }
 848     }
 849     return $properties;
 850   }
 851
 852   /**
 853    * Add all the elements shared between contribute search and advnaced search.
 854    *
 855    *
 856    * @param CRM_Core_Form $form
 857    *
 858    * @return void
 859    */
 860   public static function buildSearchForm(&$form) {
 861
 862     // Added contribution source
 863     $form->addElement('text', 'contribution_source', ts('Contribution Source'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'source'));
 864
 865     CRM_Core_Form_Date::buildDateRange($form, 'contribution_date', 1, '_low', '_high', ts('From:'), FALSE);
 866
 867     $form->add('text', 'contribution_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
 868     $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('9.99', ' '))), 'money');
 869
 870     $form->add('text', 'contribution_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
 871     $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('99.99', ' '))), 'money');
 872
 873     // Adding select option for curreny type -- CRM-4711
 874     $form->add('select', 'contribution_currency_type',
 875       ts('Currency Type'),
 876       array(
 877         '' => ts('- any -'),
 878       ) +
 879       CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name')),
 880       FALSE, array('class' => 'crm-select2')
 881     );
 882
 883     // CRM-13848
 884     $form->addSelect('financial_type_id',
 885       array('entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search')
 886     );
 887
 888     $form->add('select', 'contribution_page_id',
 889       ts('Contribution Page'),
 890       array(
 891         '' => ts('- any -'),
 892       ) +
 893       CRM_Contribute_PseudoConstant::contributionPage(),
 894       FALSE, array('class' => 'crm-select2')
 895     );
 896
 897     $form->addSelect('payment_instrument_id',
 898       array('entity' => 'contribution', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
 899     );
 900
 901     $form->add('select', 'contribution_pcp_made_through_id',
 902       ts('Personal Campaign Page'),
 903       array(
 904         '' => ts('- any -'),
 905       ) +
 906       CRM_Contribute_PseudoConstant::pcPage(),
 907       FALSE, array('class' => 'crm-select2')
 908     );
 909
 910     $status = array();
 911
 912     $statusValues = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status');
 913     // Remove status values that are only used for recurring contributions or pledges (In Progress, Overdue).
 914     unset($statusValues['5'], $statusValues['6']);
 915
 916     $form->addSelect('contribution_status_id',
 917       array('entity' => 'contribution', 'multiple' => 'multiple', 'label' => ts('Contribution Status(s)'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
 918     );
 919
 920     // Add fields for thank you and receipt
 921     $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE);
 922     $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE);
 923
 924     $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE);
 925     $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE);
 926
 927     // Recurring contribution fields
 928     foreach (self::getRecurringFields() as $key => $label) {
 929       CRM_Core_Form_Date::buildDateRange($form, $key, 1, '_low', '_high');
 930       // If data has been entered for a recurring field, tell the tpl layer to open the pane
 931       if (!empty($form->_formValues[$key . '_relative']) || !empty($form->_formValues[$key . '_low']) || !empty($form->_formValues[$key . '_high'])) {
 932         $form->assign('contribution_recur_pane_open', TRUE);
 933       }
 934     }
 935
 936     $form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE);
 937
 938     // Add field for transaction ID search
 939     $form->addElement('text', 'contribution_trxn_id', ts("Transaction ID"));
 940
 941     $form->addElement('text', 'contribution_check_number', ts('Check Number'));
 942
 943     // Add field for pcp display in roll search
 944     $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE);
 945
 946     // Soft credit related fields
 947     $options = array(
 948       'only_contribs' => ts('Contributions Only'),
 949       'only_scredits' => ts('Soft Credits Only'),
 950       'both_related' => ts('Soft Credits with related Hard Credit'),
 951       'both' => ts('Both'),
 952     );
 953     $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, array('class' => "crm-select2"));
 954     $form->addSelect(
 955       'contribution_soft_credit_type_id',
 956       array(
 957         'entity' => 'contribution_soft',
 958         'field' => 'soft_credit_type_id',
 959         'multiple' => TRUE,
 960         'context' => 'search',
 961       )
 962     );
 963
 964     // Add all the custom searchable fields
 965     $contribution = array('Contribution');
 966     $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $contribution);
 967     if ($groupDetails) {
 968       $form->assign('contributeGroupTree', $groupDetails);
 969       foreach ($groupDetails as $group) {
 970         foreach ($group['fields'] as $field) {
 971           $fieldId = $field['id'];
 972           $elementName = 'custom_' . $fieldId;
 973           CRM_Core_BAO_CustomField::addQuickFormElement($form,
 974             $elementName,
 975             $fieldId,
 976             FALSE, FALSE, TRUE
 977           );
 978         }
 979       }
 980     }
 981
 982     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'contribution_campaign_id');
 983
 984     // Add batch select
 985     $batches = CRM_Contribute_PseudoConstant::batch();
 986
 987     if (!empty($batches)) {
 988       $form->add('select', 'contribution_batch_id',
 989         ts('Batch Name'),
 990         array('' => ts('- any -')) + $batches,
 991         FALSE, array('class' => 'crm-select2')
 992       );
 993     }
 994
 995     $form->assign('validCiviContribute', TRUE);
 996     $form->setDefaults(array('contribution_test' => 0));
 997   }
 998
 999   /**
1000    * @param $row
1001    * @param int $id
1002    */
1003   public static function searchAction(&$row, $id) {
1004   }
1005
1006   /**
1007    * @param $tables
1008    */
1009   public static function tableNames(&$tables) {
1010     // Add contribution table
1011     if (!empty($tables['civicrm_product'])) {
1012       $tables = array_merge(array('civicrm_contribution' => 1), $tables);
1013     }
1014
1015     if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) {
1016       $tables['civicrm_product'] = 1;
1017     }
1018   }
1019
1020   /**
1021    * Add the where for dates.
1022    *
1023    * @param array $values
1024    *   Array of query values.
1025    * @param object $query
1026    *   The query object.
1027    * @param string $name
1028    *   Query field that is set.
1029    * @param string $field
1030    *   Name of field to be set.
1031    * @param string $title
1032    *   Title of the field.
1033    *
1034    * @return bool
1035    */
1036   public static function buildDateWhere(&$values, $query, $name, $field, $title) {
1037     $fieldPart = strpos($name, $field);
1038     if ($fieldPart === FALSE) {
1039       return NULL;
1040     }
1041     // we only have recurring dates using this ATM so lets' short cut to find the table name
1042     $table = 'contribution_recur';
1043     $fieldName = explode($table . '_', $field);
1044     $query->dateQueryBuilder($values,
1045       'civicrm_' . $table, $field, $fieldName[1], $title
1046     );
1047     return TRUE;
1048   }
1049
1050   /**
1051    * @return array
1052    */
1053   public static function getRecurringFields() {
1054     return array(
1055       'contribution_recur_start_date' => ts('Recurring Contribution Start Date'),
1056       'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'),
1057       'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'),
1058       'contribution_recur_end_date' => ts('Recurring Contribution End Date'),
1059       'contribution_recur_create_date' => ('Recurring Contribution Create Date'),
1060       'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'),
1061       'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'),
1062     );
1063   }
1064
1065 }