CRM/Contribute/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Contribute_BAO_Query extends CRM_Core_BAO_Query {
  18
  19   public static $_contribOrSoftCredit = "only_contribs";
  20
  21   public static $_contribRecurPayment = NULL;
  22
  23   /**
  24    * Function get the searchable fields for contribution.
  25    *
  26    * This is basically the contribution fields plus some related entity fields.
  27    *
  28    * @param bool $checkPermission
  29    *
  30    * @return array
  31    *   Associative array of contribution fields
  32    */
  33   public static function getFields($checkPermission = TRUE) {
  34     if (!isset(\Civi::$statics[__CLASS__]) || !isset(\Civi::$statics[__CLASS__]['fields']) || !isset(\Civi::$statics[__CLASS__]['fields']['contribution'])) {
  35       $recurFields = CRM_Contribute_DAO_ContributionRecur::fields();
  36       foreach ($recurFields as $fieldKey => $field) {
  37         // We can only safely add in those with unique names as those without could clobber others.
  38         // The array is keyed by unique names so if it doesn't match the key there is no unique name & we unset
  39         // Refer to CRM_Contribute_Form_SearchTest for existing tests ... and to add more!
  40         if ($field['name'] === $fieldKey) {
  41           unset($recurFields[$fieldKey]);
  42         }
  43       }
  44       $fields = array_merge($recurFields, CRM_Contribute_BAO_Contribution::exportableFields($checkPermission));
  45       CRM_Contribute_BAO_Contribution::appendPseudoConstantsToFields($fields);
  46       unset($fields['contribution_contact_id']);
  47       \Civi::$statics[__CLASS__]['fields']['contribution'] = $fields;
  48     }
  49     return \Civi::$statics[__CLASS__]['fields']['contribution'];
  50   }
  51
  52   /**
  53    * If contributions are involved, add the specific contribute fields.
  54    *
  55    * @param CRM_Contact_BAO_Query $query
  56    */
  57   public static function select(&$query) {
  58     // if contribute mode add contribution id
  59     if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
  60       $query->_select['contribution_id'] = "civicrm_contribution.id as contribution_id";
  61       $query->_element['contribution_id'] = 1;
  62       $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
  63     }
  64
  65     // get accounting code
  66     if (!empty($query->_returnProperties['accounting_code'])) {
  67       $query->_select['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code";
  68       $query->_element['accounting_code'] = 1;
  69       $query->_tables['civicrm_accounting_code'] = 1;
  70       $query->_tables['civicrm_financial_account'] = 1;
  71     }
  72
  73     if (!empty($query->_returnProperties['contribution_note'])) {
  74       $query->_select['contribution_note'] = "civicrm_note.note as contribution_note";
  75       $query->_element['contribution_note'] = 1;
  76       $query->_tables['contribution_note'] = 1;
  77       $query->_tables['civicrm_contribution'] = 1;
  78     }
  79
  80     if (!empty($query->_returnProperties['contribution_batch'])) {
  81       $query->_select['contribution_batch'] = "civicrm_batch.title as contribution_batch";
  82       $query->_element['contribution_batch'] = 1;
  83       $query->_tables['civicrm_financial_trxn'] = 1;
  84       $query->_tables['contribution_batch'] = 1;
  85     }
  86
  87     if (!empty($query->_returnProperties['contribution_campaign_title'])) {
  88       $query->_select['contribution_campaign_title'] = "civicrm_campaign.title as contribution_campaign_title";
  89       $query->_element['contribution_campaign_title'] = $query->_tables['civicrm_campaign'] = 1;
  90     }
  91
  92     self::addSoftCreditFields($query);
  93   }
  94
  95   /**
  96    * Get where clause.
  97    *
  98    * @param CRM_Contact_BAO_Query $query
  99    *
 100    * @throws \CRM_Core_Exception
 101    * @throws \CiviCRM_API3_Exception
 102    */
 103   public static function where(&$query) {
 104     self::initializeAnySoftCreditClause($query);
 105     foreach (array_keys($query->_params) as $id) {
 106       if (empty($query->_params[$id][0])) {
 107         continue;
 108       }
 109       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_') {
 110         if ($query->_mode == CRM_Contact_BAO_Query::MODE_CONTACTS) {
 111           $query->_useDistinct = TRUE;
 112         }
 113
 114         self::whereClauseSingle($query->_params[$id], $query);
 115       }
 116     }
 117   }
 118
 119   /**
 120    * Get where clause for a single value.
 121    *
 122    * @param array $values
 123    * @param CRM_Contact_BAO_Query $query
 124    *
 125    * @throws \CiviCRM_API3_Exception
 126    * @throws \CRM_Core_Exception
 127    */
 128   public static function whereClauseSingle(&$values, &$query) {
 129     list($name, $op, $value, $grouping, $wildcard) = $values;
 130
 131     $quoteValue = NULL;
 132     $fields = self::getFields();
 133
 134     if (!empty($value) && !is_array($value)) {
 135       $quoteValue = "\"$value\"";
 136     }
 137
 138     $fieldAliases = self::getLegacySupportedFields();
 139
 140     $fieldName = $name = self::getFieldName($values);
 141     $qillName = $name;
 142     if (in_array($name, $fieldAliases)) {
 143       $qillName = array_search($name, $fieldAliases);
 144     }
 145     $pseudoExtraParam = [];
 146     $fieldSpec = CRM_Utils_Array::value($fieldName, $fields, []);
 147     $tableName = CRM_Utils_Array::value('table_name', $fieldSpec, 'civicrm_contribution');
 148     $dataType = CRM_Utils_Type::typeToString(CRM_Utils_Array::value('type', $fieldSpec));
 149     if ($dataType === 'Timestamp' || $dataType === 'Date') {
 150       $title = empty($fieldSpec['unique_title']) ? $fieldSpec['title'] : $fieldSpec['unique_title'];
 151       $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 152       $query->dateQueryBuilder($values,
 153         $tableName, $fieldName, $fieldSpec['name'], $title
 154       );
 155       return;
 156     }
 157
 158     switch ($name) {
 159       case 'contribution_date':
 160       case 'contribution_date_low':
 161       case 'contribution_date_low_time':
 162       case 'contribution_date_high':
 163       case 'contribution_date_high_time':
 164         CRM_Core_Error::deprecatedFunctionWarning('search by receive_date');
 165         // process to / from date
 166         $query->dateQueryBuilder($values,
 167           'civicrm_contribution', 'contribution_date', 'receive_date', ts('Contribution Date')
 168         );
 169         return;
 170
 171       case 'contribution_amount':
 172       case 'contribution_amount_low':
 173       case 'contribution_amount_high':
 174         // process min/max amount
 175         $query->numberRangeBuilder($values,
 176           'civicrm_contribution', 'contribution_amount',
 177           'total_amount', 'Contribution Amount',
 178           NULL
 179         );
 180         return;
 181
 182       case 'contribution_thankyou_date_is_not_null':
 183         if ($value) {
 184           $op = "IS NOT NULL";
 185           $query->_qill[$grouping][] = ts('Contribution Thank-you Sent');
 186         }
 187         else {
 188           $op = "IS NULL";
 189           $query->_qill[$grouping][] = ts('Contribution Thank-you Not Sent');
 190         }
 191         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.thankyou_date", $op);
 192         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 193         return;
 194
 195       case 'contribution_receipt_date_is_not_null':
 196         if ($value) {
 197           $op = "IS NOT NULL";
 198           $query->_qill[$grouping][] = ts('Contribution Receipt Sent');
 199         }
 200         else {
 201           $op = "IS NULL";
 202           $query->_qill[$grouping][] = ts('Contribution Receipt Not Sent');
 203         }
 204         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.receipt_date", $op);
 205         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 206         return;
 207
 208       case 'financial_type_id':
 209       case 'invoice_id':
 210       case 'invoice_number':
 211       case 'payment_instrument_id':
 212       case 'contribution_payment_instrument_id':
 213       case 'contribution_page_id':
 214       case 'contribution_status_id':
 215       case 'contribution_id':
 216       case 'contribution_currency_type':
 217       case 'contribution_currency':
 218       case 'contribution_source':
 219       case 'contribution_trxn_id':
 220       case 'contribution_check_number':
 221       case 'contribution_contact_id':
 222       case (strpos($name, '_amount') !== FALSE):
 223       case 'contribution_campaign_id':
 224
 225         $fieldNamesNotToStripContributionFrom = [
 226           'contribution_currency_type',
 227           'contribution_status_id',
 228           'contribution_page_id',
 229         ];
 230         // @todo these are mostly legacy params. Find a better way to deal with them.
 231         if (!in_array($name, $fieldNamesNotToStripContributionFrom)
 232         ) {
 233           if (!isset($fields[$name])) {
 234             $qillName = str_replace('contribution_', '', $qillName);
 235           }
 236           $name = str_replace('contribution_', '', $name);
 237         }
 238         if (in_array($name, ['contribution_currency', 'contribution_currency_type'])) {
 239           $qillName = $name = 'currency';
 240           $pseudoExtraParam = ['labelColumn' => 'name'];
 241         }
 242
 243         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 244
 245         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.$name", $op, $value, $dataType);
 246         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op, $pseudoExtraParam);
 247         if (!($name == 'id' && $value == 0)) {
 248           $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
 249         }
 250         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 251         return;
 252
 253       case 'contribution_pcp_made_through_id':
 254       case 'contribution_soft_credit_type_id':
 255         $qillName = $name;
 256         if ($name == 'contribution_pcp_made_through_id') {
 257           $qillName = $name = 'pcp_id';
 258           $fields[$name] = ['title' => ts('Personal Campaign Page'), 'type' => 2];
 259         }
 260         if ($name == 'contribution_soft_credit_type_id') {
 261           $qillName = str_replace('_id', '', $qillName);
 262           $fields[$qillName]['type'] = $fields[$qillName]['data_type'];
 263           $name = str_replace('contribution_', '', $name);
 264         }
 265         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_soft.$name",
 266           $op, $value, CRM_Utils_Type::typeToString($fields[$qillName]['type'])
 267         );
 268         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op);
 269         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
 270         $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 271         return;
 272
 273       case 'contribution_or_softcredits':
 274         if ($value == 'only_scredits') {
 275           $query->_where[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL";
 276           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only');
 277           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 278           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 279         }
 280         elseif ($value == 'both_related') {
 281           $query->_where[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL";
 282           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Contributions and their related soft credit');
 283           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 284           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 285         }
 286         elseif ($value == 'both') {
 287           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - All');
 288           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 289           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 290         }
 291         elseif ($value == 'only_contribs_unsoftcredited') {
 292           $query->_where[$grouping][] = "contribution_search_scredit_combined.filter_id IS NULL";
 293           $query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Contributions without a soft credit');
 294           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 295           $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 296         }
 297         // default option: $value == 'only_contribs'
 298         return;
 299
 300       case 'contribution_is_test':
 301         // By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution
 302         // so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause
 303         $key = array_search('civicrm_contribution.is_test = 0', $query->_where[$grouping]);
 304         if (!empty($key)) {
 305           unset($query->_where[$grouping][$key]);
 306         }
 307       case 'contribution_test':
 308         // We dont want to include all tests for sql OR CRM-7827
 309         if (!$value || $query->getOperator() != 'OR') {
 310           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
 311           if ($value) {
 312             $query->_qill[$grouping][] = ts("Only Display Test Contributions");
 313           }
 314           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 315         }
 316         return;
 317
 318       case 'contribution_is_pay_later':
 319       case 'contribution_pay_later':
 320         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
 321         if ($value) {
 322           $query->_qill[$grouping][] = ts("Find Pay Later Contributions");
 323         }
 324         else {
 325           $query->_qill[$grouping][] = ts("Exclude Pay Later Contributions");
 326         }
 327         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 328         return;
 329
 330       case 'contribution_recurring':
 331         if ($value) {
 332           $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
 333           $query->_qill[$grouping][] = ts("Find Recurring Contributions");
 334           $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
 335         }
 336         else {
 337           $query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
 338           $query->_qill[$grouping][] = ts("Exclude Recurring Contributions");
 339         }
 340         return;
 341
 342       case 'contribution_recur_id':
 343         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.contribution_recur_id",
 344           $op, $value, "Integer"
 345         );
 346         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 347         return;
 348
 349       case 'contribution_recur_payment_processor_id':
 350         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.payment_processor_id", $op, $value, "String");
 351         $paymentProcessors = civicrm_api3('PaymentProcessor', 'get', []);
 352         $paymentProcessorNames = [];
 353         foreach ($value as $paymentProcessorId) {
 354           $paymentProcessorNames[] = $paymentProcessors['values'][$paymentProcessorId]['name'];
 355         }
 356         $query->_qill[$grouping][] = ts("Recurring Contribution Payment Processor %1 %2", [1 => $op, 2 => implode(', ', $paymentProcessorNames)]);
 357         $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
 358         return;
 359
 360       case 'contribution_recur_processor_id':
 361       case 'contribution_recur_trxn_id':
 362         $spec = $fields[$name];
 363         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($spec['where'],
 364           $op, $value, "String"
 365         );
 366         $query->_qill[$grouping][] = ts("Recurring Contribution %1 %2 '%3'", [1 => $fields[$name]['title'], 2 => $op, 3 => $value]);
 367         $query->_tables[$spec['table_name']] = $query->_whereTables[$spec['table_name']] = 1;
 368         return;
 369
 370       case 'contribution_recur_payment_made':
 371         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.id", 'IS NOT EMPTY');
 372         if ($value == 2) {
 373           $query->_qill[$grouping][] = ts("Recurring contributions with at least one payment");
 374           self::$_contribRecurPayment = TRUE;
 375         }
 376         else {
 377           $query->_qill[$grouping][] = ts("All recurring contributions regardless of payments");
 378           self::$_contribRecurPayment = FALSE;
 379         }
 380         $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
 381         return;
 382
 383       case 'contribution_recur_contribution_status_id':
 384         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.contribution_status_id", $op, $value, 'String');
 385         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionRecur', 'contribution_status_id', $value, $op, $pseudoExtraParam);
 386         $query->_qill[$grouping][] = ts("Recurring Contribution Status %1 '%2'", [1 => $op, 2 => $value]);
 387         $query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
 388         return;
 389
 390       case 'contribution_note':
 391         $value = CRM_Core_DAO::escapeString($value);
 392         if ($wildcard) {
 393           $value = "%$value%";
 394           $op = 'LIKE';
 395         }
 396         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_note.note', $op, $value, "String");
 397         $query->_qill[$grouping][] = ts('Contribution Note %1 %2', [1 => $op, 2 => $quoteValue]);
 398         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = $query->_whereTables['contribution_note'] = 1;
 399         return;
 400
 401       case 'contribution_membership_id':
 402         $query->_where[$grouping][] = " civicrm_membership.id $op $value";
 403         $query->_tables['contribution_membership'] = $query->_whereTables['contribution_membership'] = 1;
 404
 405         return;
 406
 407       case 'contribution_participant_id':
 408         $query->_where[$grouping][] = " civicrm_participant.id $op $value";
 409         $query->_tables['contribution_participant'] = $query->_whereTables['contribution_participant'] = 1;
 410         return;
 411
 412       case 'contribution_pcp_display_in_roll':
 413         $query->_where[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
 414         if ($value) {
 415           $query->_qill[$grouping][] = ts("Personal Campaign Page Honor Roll");
 416         }
 417         else {
 418           $query->_qill[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
 419         }
 420         $query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
 421         return;
 422
 423       case 'contribution_batch_id':
 424         list($qillOp, $qillValue) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Batch_BAO_EntityBatch', 'batch_id', $value, $op);
 425         $query->_qill[$grouping][] = ts('Batch Name %1 %2', [1 => $qillOp, 2 => $qillValue]);
 426         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_entity_batch.batch_id', $op, $value);
 427         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 428         $query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1;
 429         $query->_tables['contribution_batch'] = $query->_whereTables['contribution_batch'] = 1;
 430         return;
 431
 432       case 'contribution_product_id':
 433         // CRM-16713 - contribution search by premiums on 'Find Contribution' form.
 434         $qillName = $name;
 435         list($operator, $productValue) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Product', $name, $value, $op);
 436         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $operator, 3 => $productValue]);
 437         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_product.id", $op, $value);
 438         $query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1;
 439         return;
 440
 441       case 'contribution_is_payment':
 442         $query->_where[$grouping][] = " civicrm_financial_trxn.is_payment $op $value";
 443         $query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1;
 444         return;
 445
 446       case 'financial_trxn_card_type_id':
 447         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_financial_trxn.card_type_id', $op, $value);
 448         $query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1;
 449         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 450         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Financial_DAO_FinancialTrxn', 'card_type_id', $value, $op);
 451         $query->_qill[$grouping][] = ts('Card Type %1 %2', [1 => $op, 2 => $value]);
 452         return;
 453
 454       case 'financial_trxn_pan_truncation':
 455         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_financial_trxn.pan_truncation', $op, $value);
 456         $query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1;
 457         $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 458         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Financial_DAO_FinancialTrxn', 'pan_truncation', $value, $op);
 459         $query->_qill[$grouping][] = ts('Card Number %1 %2', [1 => $op, 2 => $value]);
 460         return;
 461
 462       default:
 463         //all other elements are handle in this case
 464         $fldName = substr($name, 13);
 465         if (!isset($fields[$fldName])) {
 466           return;
 467         }
 468         $whereTable = $fields[$fldName];
 469         if (!is_array($value)) {
 470           $value = trim($value);
 471         }
 472
 473         $dataType = 'String';
 474         if (!empty($whereTable['type'])) {
 475           $dataType = CRM_Utils_Type::typeToString($whereTable['type']);
 476         }
 477
 478         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($whereTable['where'], $op, $value, $dataType);
 479         $query->_qill[$grouping][] = "$whereTable[title] $op $quoteValue";
 480         list($tableName) = explode('.', $whereTable['where'], 2);
 481         $query->_tables[$tableName] = $query->_whereTables[$tableName] = 1;
 482         if ($tableName === 'civicrm_contribution_product') {
 483           $query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1;
 484           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 485         }
 486         else {
 487           $query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
 488         }
 489     }
 490   }
 491
 492   /**
 493    * Get from clause.
 494    *
 495    * @param string $name
 496    * @param string $mode
 497    * @param string $side
 498    *
 499    * @return NULL|string
 500    */
 501   public static function from($name, $mode, $side) {
 502     $from = NULL;
 503     switch ($name) {
 504       case 'civicrm_contribution':
 505         $from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
 506         if (in_array(self::$_contribOrSoftCredit, ["only_scredits", "both_related", "both", "only_contribs_unsoftcredited"])) {
 507           // switch the from table if its only soft credit search
 508           $from = " $side JOIN " . \Civi::$statics[__CLASS__]['soft_credit_temp_table_name'] . " as contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id ";
 509           $from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id ";
 510           $from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id";
 511         }
 512         break;
 513
 514       case 'civicrm_contribution_recur':
 515         if ($mode == 1) {
 516           // 'Made payment for the recurring contributions?' is ticked yes
 517           $from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
 518           if (self::$_contribRecurPayment == TRUE) {
 519             $from .= " INNER JOIN civicrm_contribution cr ON cr.contribution_recur_id = civicrm_contribution_recur.id ";
 520           }
 521         }
 522         else {
 523           $from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
 524         }
 525         break;
 526
 527       case 'civicrm_financial_type':
 528         if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 529           $from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
 530         }
 531         else {
 532           $from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
 533         }
 534         break;
 535
 536       case 'civicrm_financial_account':
 537         if ($mode & CRM_Contact_BAO_Query::MODE_CONTACTS) {
 538           $from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id ";
 539         }
 540         break;
 541
 542       case 'civicrm_accounting_code':
 543         if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 544           $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' ";
 545           $from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
 546           $from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
 547           $from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
 548         }
 549         break;
 550
 551       case 'civicrm_contribution_page':
 552         $from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id";
 553         break;
 554
 555       case 'civicrm_product':
 556         $from = " $side  JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
 557         $from .= " $side  JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
 558         break;
 559
 560       case 'contribution_softcredit_type':
 561         $from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON
 562           (option_group_contribution_softcredit_type.name = 'soft_credit_type')";
 563         $from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON
 564           ( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value
 565           AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )";
 566         break;
 567
 568       case 'contribution_note':
 569         $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
 570                                                     civicrm_contribution.id = civicrm_note.entity_id )";
 571         break;
 572
 573       case 'contribution_membership':
 574         $from = " $side  JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
 575         $from .= " $side  JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
 576         break;
 577
 578       case 'civicrm_campaign':
 579         //CRM-16764 - get survey clause from campaign bao
 580         if (!CRM_Campaign_BAO_Query::$_applySurveyClause) {
 581           $from = " $side  JOIN civicrm_campaign ON civicrm_campaign.id = civicrm_contribution.campaign_id";
 582         }
 583         break;
 584
 585       case 'contribution_participant':
 586         $from = " $side  JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
 587         $from .= " $side  JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
 588         break;
 589
 590       case 'civicrm_contribution_soft':
 591         if (!in_array(self::$_contribOrSoftCredit, ["only_scredits", "both_related", "both", "only_contribs_unsoftcredited"])) {
 592           $from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
 593         }
 594         break;
 595
 596       case 'civicrm_contribution_soft_contact':
 597         if (in_array(self::$_contribOrSoftCredit, ["only_scredits", "both_related", "both", "only_contribs_unsoftcredited"])) {
 598           $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id )
 599             AND contribution_search_scredit_combined.scredit_id IS NOT NULL";
 600         }
 601         else {
 602           $from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
 603         }
 604         break;
 605
 606       case 'civicrm_contribution_soft_email':
 607         $from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
 608         break;
 609
 610       case 'civicrm_contribution_soft_phone':
 611         $from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
 612         break;
 613
 614       case 'contribution_batch':
 615         $from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
 616         AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
 617
 618         $from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
 619         break;
 620
 621       case 'civicrm_financial_trxn':
 622         $from .= " $side JOIN civicrm_entity_financial_trxn ON (
 623           civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
 624           AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
 625
 626         $from .= " $side JOIN civicrm_financial_trxn ON (
 627           civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
 628         break;
 629     }
 630     return $from;
 631   }
 632
 633   /**
 634    * Initialise the soft credit clause.
 635    *
 636    * @param CRM_Contact_BAO_Query $query
 637    */
 638   public static function initializeAnySoftCreditClause(&$query) {
 639     // @todo have a generic initialize on all components that gets called every query
 640     // & rename this to match that fn name.
 641     if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 642       if (self::isSoftCreditOptionEnabled($query->_params)) {
 643         unset($query->_distinctComponentClause);
 644         $query->_rowCountClause = " count(civicrm_contribution.id)";
 645         $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
 646       }
 647       else {
 648         $query->_distinctComponentClause = ' civicrm_contribution.id';
 649       }
 650     }
 651   }
 652
 653   /**
 654    * Check if soft credits are enables.
 655    *
 656    * @param array $queryParams
 657    *
 658    * @return bool
 659    */
 660   public static function isSoftCreditOptionEnabled($queryParams = []) {
 661     if (!empty($queryParams)) {
 662       foreach (array_keys($queryParams) as $id) {
 663         if (empty($queryParams[$id][0])) {
 664           continue;
 665         }
 666         if ($queryParams[$id][0] == 'contribution_or_softcredits') {
 667           self::$_contribOrSoftCredit = $queryParams[$id][2];
 668         }
 669       }
 670     }
 671     if (in_array(self::$_contribOrSoftCredit,
 672       ["only_scredits", "both_related", "both", "only_contribs_unsoftcredited"])) {
 673       if (!isset(\Civi::$statics[__CLASS__]['soft_credit_temp_table_name'])) {
 674         // build a temp table which is union of contributions and soft credits
 675         // note: group-by in first part ensures uniqueness in counts
 676         $tempQuery = '
 677                SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id
 678                  FROM civicrm_contribution con
 679             LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id
 680              GROUP BY id, contact_id, scredit_id, cso.id
 681             UNION ALL
 682                SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id
 683                  FROM civicrm_contribution_soft as scredit';
 684         \Civi::$statics[__CLASS__]['soft_credit_temp_table_name'] = CRM_Utils_SQL_TempTable::build()->createWithQuery(
 685           $tempQuery
 686         )->getName();
 687       }
 688       return TRUE;
 689     }
 690     return FALSE;
 691   }
 692
 693   /**
 694    * Get return properties for soft credits.
 695    *
 696    * @param bool $isExportMode
 697    *
 698    * @return array
 699    */
 700   public static function softCreditReturnProperties($isExportMode = FALSE) {
 701     $properties = [
 702       'contribution_soft_credit_name' => 1,
 703       'contribution_soft_credit_amount' => 1,
 704       'contribution_soft_credit_type' => 1,
 705     ];
 706     if ($isExportMode) {
 707       $properties['contribution_soft_credit_contact_id'] = 1;
 708       $properties['contribution_soft_credit_contribution_id'] = 1;
 709     }
 710     return $properties;
 711   }
 712
 713   /**
 714    * Get the list of fields required to populate the selector.
 715    *
 716    * The default return properties array returns far too many fields for 'everyday use. Every field you add to this array
 717    * kills a small kitten so add carefully.
 718    *
 719    * @param array $queryParams
 720    * @return array
 721    */
 722   public static function selectorReturnProperties($queryParams) {
 723     $properties = [
 724       'contact_type' => 1,
 725       'contact_sub_type' => 1,
 726       'sort_name' => 1,
 727       'financial_type' => 1,
 728       'contribution_source' => 1,
 729       'is_test' => 1,
 730       'receive_date' => 1,
 731       'is_pay_later' => 1,
 732       'thankyou_date' => 1,
 733       'total_amount' => 1,
 734       // Without this value here we get an e-notice BUT the value does not appear to be rendered anywhere.
 735       'contribution_campaign_id' => 1,
 736       'contribution_status_id' => 1,
 737       // @todo return this & fix query to do pseudoconstant thing.
 738       'contribution_status' => 1,
 739       'currency' => 1,
 740       'contribution_cancel_date' => 1,
 741       'contribution_recur_id' => 1,
 742     ];
 743     if (self::isSiteHasProducts()) {
 744       $properties['product_name'] = 1;
 745       $properties['contribution_product_id'] = 1;
 746     }
 747     if (self::isSoftCreditOptionEnabled($queryParams)) {
 748       $properties = array_merge($properties, self::softCreditReturnProperties());
 749     }
 750
 751     return $properties;
 752   }
 753
 754   /**
 755    * Do any products exist in this site's database.
 756    *
 757    * @return bool
 758    */
 759   public static function isSiteHasProducts() {
 760     if (!isset(\Civi::$statics[__CLASS__]['has_products'])) {
 761       \Civi::$statics[__CLASS__]['has_products'] = (bool) CRM_Core_DAO::singleValueQuery('SELECT id FROM civicrm_contribution_product LIMIT 1');
 762     }
 763     return \Civi::$statics[__CLASS__]['has_products'];
 764   }
 765
 766   /**
 767    * Function you should avoid.
 768    *
 769    * This function returns default properties for contribution queries. However, they are
 770    * far more than are required in 'most' cases and you should always try to return the return properties
 771    * you actually require.
 772    *
 773    * It would be nice to throw an e-notice when this is called but it would trash the tests :-(.
 774    *
 775    * @param int $mode
 776    * @param bool $includeCustomFields
 777    *
 778    * @return array|NULL
 779    */
 780   public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
 781     $properties = NULL;
 782     if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
 783       $properties = [
 784         // add
 785         'contact_type' => 1,
 786         // fields
 787         'contact_sub_type' => 1,
 788         // to
 789         'sort_name' => 1,
 790         //this
 791         'display_name' => 1,
 792         // array
 793         'financial_type' => 1,
 794         // to
 795         'contribution_source' => 1,
 796         // strangle
 797         'receive_date' => 1,
 798         // site
 799         'thankyou_date' => 1,
 800         // performance
 801         'contribution_cancel_date' => 1,
 802         // and
 803         'total_amount' => 1,
 804         // torture
 805         'accounting_code' => 1,
 806         // small
 807         'payment_instrument' => 1,
 808         // kittens
 809         'payment_instrument_id' => 1,
 810         // argh
 811         'contribution_check_number' => 1,
 812         // no
 813         'non_deductible_amount' => 1,
 814         // not
 815         'fee_amount' => 1,
 816         // another
 817         'net_amount' => 1,
 818         // expensive
 819         'trxn_id' => 1,
 820         // join
 821         'invoice_id' => 1,
 822         'invoice_number' => 1,
 823         // added
 824         'currency' => 1,
 825         // to
 826         'cancel_reason' => 1,
 827         //every
 828         'receipt_date' => 1,
 829         // query
 830         //whether
 831         // or
 832         // not
 833         // the
 834         // field
 835         // is
 836         'is_test' => 1,
 837         // actually
 838         'is_pay_later' => 1,
 839         // required
 840         'contribution_status' => 1,
 841         // instead
 842         'contribution_status_id' => 1,
 843         // of
 844         'contribution_recur_id' => 1,
 845         // adding
 846         'amount_level' => 1,
 847         // here
 848         'contribution_note' => 1,
 849         // set
 850         'contribution_batch' => 1,
 851         // return properties
 852         'contribution_campaign_title' => 1,
 853         // on
 854         'contribution_campaign_id' => 1,
 855         // calling
 856         //function
 857       ];
 858       if (self::isSiteHasProducts()) {
 859         $properties['fulfilled_date'] = 1;
 860         $properties['product_name'] = 1;
 861         $properties['contribution_product_id'] = 1;
 862         $properties['product_option'] = 1;
 863         $properties['sku'] = 1;
 864         $properties['contribution_start_date'] = 1;
 865         $properties['contribution_end_date'] = 1;
 866       }
 867       if (self::isSoftCreditOptionEnabled()) {
 868         $properties = array_merge($properties, self::softCreditReturnProperties());
 869       }
 870       if ($includeCustomFields) {
 871         // also get all the custom contribution properties
 872         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Contribution');
 873         if (!empty($fields)) {
 874           foreach ($fields as $name => $dontCare) {
 875             $properties[$name] = 1;
 876           }
 877         }
 878       }
 879     }
 880     return $properties;
 881   }
 882
 883   /**
 884    * Get the metadata for fields to be included on the search form.
 885    *
 886    * @throws \CiviCRM_API3_Exception
 887    */
 888   public static function getSearchFieldMetadata() {
 889     $fields = [
 890       'contribution_source',
 891       'cancel_reason',
 892       'invoice_number',
 893       'receive_date',
 894       'contribution_cancel_date',
 895       'contribution_page_id',
 896       'contribution_id',
 897     ];
 898     $metadata = civicrm_api3('Contribution', 'getfields', [])['values'];
 899     $metadata['contribution_id'] = $metadata['id'];
 900     return array_intersect_key($metadata, array_flip($fields));
 901   }
 902
 903   /**
 904    * Add all the elements shared between contribute search and advanced search.
 905    *
 906    * @param \CRM_Contribute_Form_Search $form
 907    *
 908    * @throws \CRM_Core_Exception
 909    * @throws \CiviCRM_API3_Exception
 910    */
 911   public static function buildSearchForm(&$form) {
 912
 913     $form->addSearchFieldMetadata(['Contribution' => self::getSearchFieldMetadata()]);
 914     $form->addSearchFieldMetadata(['ContributionRecur' => CRM_Contribute_BAO_ContributionRecur::getContributionRecurSearchFieldMetadata()]);
 915     $form->addFormFieldsFromMetadata();
 916
 917     $form->add('text', 'contribution_amount_low', ts('From'), ['size' => 8, 'maxlength' => 8]);
 918     $form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', [1 => CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency('9.99')]), 'money');
 919
 920     $form->add('text', 'contribution_amount_high', ts('To'), ['size' => 8, 'maxlength' => 8]);
 921     $form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', [1 => CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency('99.99')]), 'money');
 922
 923     // Adding select option for curreny type -- CRM-4711
 924     $form->add('select', 'contribution_currency_type',
 925       ts('Currency Type'),
 926       [
 927         '' => ts('- any -'),
 928       ] +
 929       CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', ['labelColumn' => 'name']),
 930       FALSE, ['class' => 'crm-select2']
 931     );
 932
 933     // CRM-13848
 934     $form->addSelect('financial_type_id',
 935       ['entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search', 'options' => CRM_Contribute_BAO_Contribution::buildOptions('financial_type_id', 'search')]
 936     );
 937
 938     // use contribution_payment_instrument_id instead of payment_instrument_id
 939     // Contribution Edit form (pop-up on contribution/Contact(display Result as Contribution) open on search form),
 940     // then payment method change action not working properly because of same html ID present two time on one page
 941     $form->addSelect('contribution_payment_instrument_id',
 942       ['entity' => 'contribution', 'field' => 'payment_instrument_id', 'multiple' => 'multiple', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -')]
 943     );
 944
 945     $form->add('select',
 946       'contribution_pcp_made_through_id',
 947       ts('Personal Campaign Page'),
 948       CRM_Contribute_PseudoConstant::pcPage(), FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')]);
 949
 950     $statusValues = CRM_Contribute_BAO_Contribution::buildOptions('contribution_status_id', 'search');
 951     $form->add('select', 'contribution_status_id',
 952       ts('Contribution Status'), $statusValues,
 953       FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple']
 954     );
 955
 956     // Add fields for thank you and receipt
 957     $form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE);
 958     $form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE);
 959
 960     $form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE);
 961     $form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE);
 962
 963     $form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE);
 964     $form->addYesNo('is_template', ts('Contribution is Template?'), TRUE);
 965     // Add field for transaction ID search
 966     $form->addElement('text', 'contribution_trxn_id', ts("Transaction ID"));
 967     $form->addElement('text', 'contribution_check_number', ts('Check Number'));
 968
 969     // Add field for pcp display in roll search
 970     $form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE);
 971
 972     // Soft credit related fields
 973     $options = [
 974       'only_contribs' => ts('Contributions Only'),
 975       'only_scredits' => ts('Soft Credits Only'),
 976       'both_related' => ts('Contributions and their related soft credit'),
 977       'both' => ts('All'),
 978       'only_contribs_unsoftcredited' => ts('Contributions without a soft credit'),
 979     ];
 980     $form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, ['class' => "crm-select2"]);
 981     $form->addSelect(
 982       'contribution_soft_credit_type_id',
 983       [
 984         'entity' => 'contribution_soft',
 985         'field' => 'soft_credit_type_id',
 986         'multiple' => TRUE,
 987         'context' => 'search',
 988       ]
 989     );
 990
 991     $form->addField('financial_trxn_card_type_id', ['entity' => 'FinancialTrxn', 'name' => 'card_type_id', 'action' => 'get']);
 992
 993     $form->add('text', 'financial_trxn_pan_truncation', ts('Card Number'), [
 994       'size' => 5,
 995       'maxlength' => 4,
 996       'autocomplete' => 'off',
 997     ]);
 998
 999     if (CRM_Contribute_BAO_Query::isSiteHasProducts()) {
1000       // CRM-16713 - contribution search by premiums on 'Find Contribution' form.
1001       $form->add('select', 'contribution_product_id',
1002         ts('Premium'),
1003         CRM_Contribute_PseudoConstant::products(),
1004         FALSE, [
1005           'class' => 'crm-select2',
1006           'multiple' => 'multiple',
1007           'placeholder' => ts('- any -'),
1008         ]
1009       );
1010     }
1011     else {
1012       $form->addOptionalQuickFormElement('contribution_product_id');
1013     }
1014
1015     self::addCustomFormFields($form, ['Contribution']);
1016
1017     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'contribution_campaign_id');
1018
1019     // Add batch select
1020     $batches = CRM_Contribute_PseudoConstant::batch();
1021
1022     if (!empty($batches)) {
1023       $form->add('select', 'contribution_batch_id',
1024         ts('Batch Name'),
1025         [
1026           '' => ts('- any -'),
1027           // CRM-19325
1028           'IS NULL' => ts('None'),
1029         ] + $batches,
1030         FALSE, ['class' => 'crm-select2']
1031       );
1032     }
1033     else {
1034       $form->addOptionalQuickFormElement('contribution_batch_id');
1035     }
1036
1037     $form->assign('validCiviContribute', TRUE);
1038     $form->setDefaults(['contribution_test' => 0]);
1039     $form->setDefaults(['is_template' => 0]);
1040
1041     CRM_Contribute_BAO_ContributionRecur::recurringContribution($form);
1042   }
1043
1044   /**
1045    * Get table names.
1046    *
1047    * @todo better function comment needed - what IS the point of this?
1048    *
1049    * @param array $tables
1050    */
1051   public static function tableNames(&$tables) {
1052     // Add contribution table
1053     if (!empty($tables['civicrm_product'])) {
1054       $tables = array_merge(['civicrm_contribution' => 1], $tables);
1055     }
1056
1057     if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) {
1058       $tables['civicrm_product'] = 1;
1059     }
1060   }
1061
1062   /**
1063    * Add the where for dates.
1064    *
1065    * @param array $values
1066    *   Array of query values.
1067    * @param object $query
1068    *   The query object.
1069    * @param string $name
1070    *   Query field that is set.
1071    * @param string $field
1072    *   Name of field to be set.
1073    * @param string $title
1074    *   Title of the field.
1075    *
1076    * @return bool
1077    */
1078   public static function buildDateWhere(&$values, $query, $name, $field, $title) {
1079     $fieldPart = strpos($name, $field);
1080     if ($fieldPart === FALSE) {
1081       return NULL;
1082     }
1083     // we only have recurring dates using this ATM so lets' short cut to find the table name
1084     $table = 'contribution_recur';
1085     $fieldName = explode($table . '_', $field);
1086     $query->dateQueryBuilder($values,
1087       'civicrm_' . $table, $field, $fieldName[1], $title
1088     );
1089     return TRUE;
1090   }
1091
1092   /**
1093    * Add the soft credit fields to the select fields.
1094    *
1095    * Extracted into separate function to improve readability of main select function.
1096    *
1097    * @param CRM_Contact_BAO_Query $query
1098    */
1099   private static function addSoftCreditFields(&$query) {
1100     $includeSoftCredits = self::isSoftCreditOptionEnabled($query->_params);
1101     if (!empty($query->_returnProperties['contribution_soft_credit_name'])) {
1102       if ($includeSoftCredits) {
1103         $query->_select['contribution_soft_credit_name'] = "civicrm_contact_d.sort_name as contribution_soft_credit_name";
1104         // also include contact id. Will help build hyperlinks
1105         $query->_select['contribution_soft_credit_contact_id'] = "civicrm_contact_d.id as contribution_soft_credit_contact_id";
1106       }
1107       $query->_element['contribution_soft_credit_name'] = 1;
1108       $query->_element['contribution_soft_credit_contact_id'] = 1;
1109
1110       $query->_tables['civicrm_contribution'] = 1;
1111       $query->_tables['civicrm_contribution_soft'] = 1;
1112       $query->_tables['civicrm_contribution_soft_contact'] = 1;
1113     }
1114
1115     if (!empty($query->_returnProperties['contribution_soft_credit_contact_id'])) {
1116       $query->_tables['civicrm_contribution'] = 1;
1117       $query->_tables['civicrm_contribution_soft'] = 1;
1118       $query->_tables['civicrm_contribution_soft_contact'] = 1;
1119     }
1120
1121     if (!empty($query->_returnProperties['contribution_soft_credit_amount'])) {
1122       if ($includeSoftCredits) {
1123         $query->_select['contribution_soft_credit_amount'] = "civicrm_contribution_soft.amount as contribution_soft_credit_amount";
1124       }
1125       $query->_element['contribution_soft_credit_amount'] = 1;
1126       $query->_tables['civicrm_contribution'] = 1;
1127       $query->_tables['civicrm_contribution_soft'] = 1;
1128     }
1129
1130     if (!empty($query->_returnProperties['contribution_soft_credit_type'])) {
1131       if ($includeSoftCredits) {
1132         $query->_select['contribution_soft_credit_type'] = "contribution_softcredit_type.label as contribution_soft_credit_type";
1133       }
1134       $query->_element['contribution_soft_credit_type'] = 1;
1135       $query->_tables['civicrm_contribution'] = 1;
1136       $query->_tables['contribution_softcredit_type'] = 1;
1137     }
1138
1139     if (!empty($query->_returnProperties['contribution_soft_credit_contribution_id'])) {
1140       if ($includeSoftCredits) {
1141         $query->_select['contribution_soft_credit_contribution_id'] = "civicrm_contribution_soft.contribution_id as contribution_soft_credit_contribution_id";
1142       }
1143       $query->_element['contribution_soft_credit_contribution_id'] = 1;
1144       $query->_tables['civicrm_contribution'] = 1;
1145       $query->_tables['civicrm_contribution_soft'] = 1;
1146     }
1147
1148     if (!empty($query->_returnProperties['contribution_soft_credit_email'])) {
1149       $query->_select['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email";
1150       $query->_element['contribution_soft_credit_email'] = 1;
1151       $query->_tables['civicrm_contribution'] = 1;
1152       $query->_tables['civicrm_contribution_soft'] = 1;
1153       $query->_tables['civicrm_contribution_soft_contact'] = 1;
1154       $query->_tables['civicrm_contribution_soft_email'] = 1;
1155     }
1156
1157     if (!empty($query->_returnProperties['contribution_soft_credit_phone'])) {
1158       $query->_select['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone";
1159       $query->_element['contribution_soft_credit_phone'] = 1;
1160       $query->_tables['civicrm_contribution'] = 1;
1161       $query->_tables['civicrm_contribution_soft'] = 1;
1162       $query->_tables['civicrm_contribution_soft_contact'] = 1;
1163       $query->_tables['civicrm_contribution_soft_phone'] = 1;
1164     }
1165
1166     if (!empty($query->_returnProperties['contribution_soft_credit_pcp_id'])) {
1167       $query->_select['contribution_soft_credit_pcp_id'] = "civicrm_contribution_soft.pcp_id as contribution_soft_credit_pcp_id";
1168       $query->_element['contribution_soft_credit_pcp_id'] = 1;
1169       $query->_tables['civicrm_contribution'] = 1;
1170       $query->_tables['civicrm_contribution_soft'] = 1;
1171     }
1172   }
1173
1174 }